@playcanvas/web-components 0.6.0 → 0.7.1

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

@@ -0,0 +1,134 @@
+import { LayoutGroupComponent, Vec2, Vec4 } from 'playcanvas';
+import { ComponentElement } from './component';
+/**
+ * The LayoutGroupComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-layoutgroup/ | `<pc-layoutgroup>`} elements.
+ * The LayoutGroupComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class LayoutGroupComponentElement extends ComponentElement {
+    private _orientation;
+    private _reverseX;
+    private _reverseY;
+    private _alignment;
+    private _padding;
+    private _spacing;
+    private _widthFitting;
+    private _heightFitting;
+    private _wrap;
+    /** @ignore */
+    constructor();
+    getInitialComponentData(): {
+        orientation: number;
+        reverseX: boolean;
+        reverseY: boolean;
+        alignment: Vec2;
+        padding: Vec4;
+        spacing: Vec2;
+        widthFitting: number;
+        heightFitting: number;
+        wrap: boolean;
+    };
+    /**
+     * Gets the underlying PlayCanvas layout group component.
+     * @returns The layout group component.
+     */
+    get component(): LayoutGroupComponent | null;
+    /**
+     * Sets the orientation of the layout group. Can be `horizontal` (0) or `vertical` (1).
+     * @param value - The orientation.
+     */
+    set orientation(value: number);
+    /**
+     * Gets the orientation of the layout group.
+     * @returns The orientation.
+     */
+    get orientation(): number;
+    /**
+     * Sets whether the order of children is reversed along the horizontal axis.
+     * @param value - Whether to reverse the horizontal order.
+     */
+    set reverseX(value: boolean);
+    /**
+     * Gets whether the order of children is reversed along the horizontal axis.
+     * @returns Whether the horizontal order is reversed.
+     */
+    get reverseX(): boolean;
+    /**
+     * Sets whether the order of children is reversed along the vertical axis.
+     * @param value - Whether to reverse the vertical order.
+     */
+    set reverseY(value: boolean);
+    /**
+     * Gets whether the order of children is reversed along the vertical axis.
+     * @returns Whether the vertical order is reversed.
+     */
+    get reverseY(): boolean;
+    /**
+     * Sets the horizontal and vertical alignment of the child elements (each component 0 to 1).
+     * @param value - The alignment.
+     */
+    set alignment(value: Vec2);
+    /**
+     * Gets the alignment of the child elements.
+     * @returns The alignment.
+     */
+    get alignment(): Vec2;
+    /**
+     * Sets the padding around the layout group, as a Vec4 (left, bottom, right, top).
+     * @param value - The padding.
+     */
+    set padding(value: Vec4);
+    /**
+     * Gets the padding around the layout group.
+     * @returns The padding.
+     */
+    get padding(): Vec4;
+    /**
+     * Sets the spacing between child elements, as a Vec2 (x, y).
+     * @param value - The spacing.
+     */
+    set spacing(value: Vec2);
+    /**
+     * Gets the spacing between child elements.
+     * @returns The spacing.
+     */
+    get spacing(): Vec2;
+    /**
+     * Sets the fitting mode along the horizontal axis. Can be `none` (0), `stretch` (1), `shrink`
+     * (2) or `both` (3).
+     * @param value - The width fitting mode.
+     */
+    set widthFitting(value: number);
+    /**
+     * Gets the fitting mode along the horizontal axis.
+     * @returns The width fitting mode.
+     */
+    get widthFitting(): number;
+    /**
+     * Sets the fitting mode along the vertical axis. Can be `none` (0), `stretch` (1), `shrink` (2)
+     * or `both` (3).
+     * @param value - The height fitting mode.
+     */
+    set heightFitting(value: number);
+    /**
+     * Gets the fitting mode along the vertical axis.
+     * @returns The height fitting mode.
+     */
+    get heightFitting(): number;
+    /**
+     * Sets whether children wrap onto a new line/column when they overflow the group.
+     * @param value - Whether to wrap children.
+     */
+    set wrap(value: boolean);
+    /**
+     * Gets whether children wrap onto a new line/column when they overflow the group.
+     * @returns Whether children wrap.
+     */
+    get wrap(): boolean;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
+}
+export { LayoutGroupComponentElement };

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

@@ -46,7 +46,7 @@ declare class LightComponentElement extends ComponentElement {
         shadowIntensity: number;
         shadowResolution: number;
         shadowSamples: number;
-        shadowType: 0 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | undefined;
+        shadowType: 0 | 3 | 2 | 4 | 5 | 6 | 7 | 8 | 9 | undefined;
         type: string;
         vsmBias: number;
         vsmBlurSize: number;

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

@@ -0,0 +1,68 @@
+import { ScrollbarComponent } from 'playcanvas';
+import { ComponentElement } from './component';
+/**
+ * The ScrollbarComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollbar/ | `<pc-scrollbar>`} elements.
+ * The ScrollbarComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ScrollbarComponentElement extends ComponentElement {
+    private _orientation;
+    private _value;
+    private _handleSize;
+    private _handle;
+    /** @ignore */
+    constructor();
+    getInitialComponentData(): Record<string, any>;
+    /**
+     * Gets the underlying PlayCanvas scrollbar component.
+     * @returns The scrollbar component.
+     */
+    get component(): ScrollbarComponent | null;
+    /**
+     * Sets the orientation of the scrollbar. Can be `horizontal` (0) or `vertical` (1).
+     * @param value - The orientation.
+     */
+    set orientation(value: number);
+    /**
+     * Gets the orientation of the scrollbar.
+     * @returns The orientation.
+     */
+    get orientation(): number;
+    /**
+     * Sets the current position value of the scrollbar, in the range 0 to 1.
+     * @param value - The scrollbar value.
+     */
+    set value(value: number);
+    /**
+     * Gets the current position value of the scrollbar.
+     * @returns The scrollbar value.
+     */
+    get value(): number;
+    /**
+     * Sets the size of the handle relative to the size of the track, in the range 0 to 1.
+     * @param value - The handle size.
+     */
+    set handleSize(value: number);
+    /**
+     * Gets the size of the handle relative to the size of the track.
+     * @returns The handle size.
+     */
+    get handleSize(): number;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` used as the
+     * scrollbar handle.
+     * @param value - The handle entity reference.
+     */
+    set handle(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` used as the scrollbar handle.
+     * @returns The handle entity reference.
+     */
+    get handle(): string;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
+}
+export { ScrollbarComponentElement };

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

@@ -0,0 +1,173 @@
+import { ScrollViewComponent, Vec2 } from 'playcanvas';
+import { ComponentElement } from './component';
+/**
+ * The ScrollViewComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollview/ | `<pc-scrollview>`} elements.
+ * The ScrollViewComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ScrollViewComponentElement extends ComponentElement {
+    private _horizontal;
+    private _vertical;
+    private _scrollMode;
+    private _bounceAmount;
+    private _friction;
+    private _useMouseWheel;
+    private _mouseWheelSensitivity;
+    private _horizontalScrollbarVisibility;
+    private _verticalScrollbarVisibility;
+    private _viewport;
+    private _content;
+    private _horizontalScrollbar;
+    private _verticalScrollbar;
+    /** @ignore */
+    constructor();
+    getInitialComponentData(): Record<string, any>;
+    /**
+     * Gets the underlying PlayCanvas scroll view component.
+     * @returns The scroll view component.
+     */
+    get component(): ScrollViewComponent | null;
+    /**
+     * Sets whether horizontal scrolling is enabled.
+     * @param value - Whether horizontal scrolling is enabled.
+     */
+    set horizontal(value: boolean);
+    /**
+     * Gets whether horizontal scrolling is enabled.
+     * @returns Whether horizontal scrolling is enabled.
+     */
+    get horizontal(): boolean;
+    /**
+     * Sets whether vertical scrolling is enabled.
+     * @param value - Whether vertical scrolling is enabled.
+     */
+    set vertical(value: boolean);
+    /**
+     * Gets whether vertical scrolling is enabled.
+     * @returns Whether vertical scrolling is enabled.
+     */
+    get vertical(): boolean;
+    /**
+     * Sets how the scroll view should behave when the content is scrolled beyond its bounds. Can be
+     * `clamp` (0), `bounce` (1) or `infinite` (2).
+     * @param value - The scroll mode.
+     */
+    set scrollMode(value: number);
+    /**
+     * Gets how the scroll view behaves when the content is scrolled beyond its bounds.
+     * @returns The scroll mode.
+     */
+    get scrollMode(): number;
+    /**
+     * Sets how far the content is allowed to bounce beyond its bounds when `scroll-mode` is
+     * `bounce`, in the range 0 to 1.
+     * @param value - The bounce amount.
+     */
+    set bounceAmount(value: number);
+    /**
+     * Gets the bounce amount.
+     * @returns The bounce amount.
+     */
+    get bounceAmount(): number;
+    /**
+     * Sets how freely the content moves once thrown, in the range 0 (no friction) to 1.
+     * @param value - The friction.
+     */
+    set friction(value: number);
+    /**
+     * Gets the friction.
+     * @returns The friction.
+     */
+    get friction(): number;
+    /**
+     * Sets whether the scroll view responds to mouse wheel events.
+     * @param value - Whether to use the mouse wheel.
+     */
+    set useMouseWheel(value: boolean);
+    /**
+     * Gets whether the scroll view responds to mouse wheel events.
+     * @returns Whether the mouse wheel is used.
+     */
+    get useMouseWheel(): boolean;
+    /**
+     * Sets the mouse wheel sensitivity as a Vec2 (horizontal, vertical). A value of 0 on an axis
+     * disables mouse wheel scrolling for that axis.
+     * @param value - The mouse wheel sensitivity.
+     */
+    set mouseWheelSensitivity(value: Vec2);
+    /**
+     * Gets the mouse wheel sensitivity.
+     * @returns The mouse wheel sensitivity.
+     */
+    get mouseWheelSensitivity(): Vec2;
+    /**
+     * Sets the visibility of the horizontal scrollbar. Can be `always` (0) or `when-required` (1).
+     * @param value - The horizontal scrollbar visibility.
+     */
+    set horizontalScrollbarVisibility(value: number);
+    /**
+     * Gets the visibility of the horizontal scrollbar.
+     * @returns The horizontal scrollbar visibility.
+     */
+    get horizontalScrollbarVisibility(): number;
+    /**
+     * Sets the visibility of the vertical scrollbar. Can be `always` (0) or `when-required` (1).
+     * @param value - The vertical scrollbar visibility.
+     */
+    set verticalScrollbarVisibility(value: number);
+    /**
+     * Gets the visibility of the vertical scrollbar.
+     * @returns The vertical scrollbar visibility.
+     */
+    get verticalScrollbarVisibility(): number;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` used as the
+     * viewport, which clips the content to the scroll view's bounds.
+     * @param value - The viewport entity reference.
+     */
+    set viewport(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` used as the viewport.
+     * @returns The viewport entity reference.
+     */
+    get viewport(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` used as the
+     * content, which is moved as the scroll view is scrolled.
+     * @param value - The content entity reference.
+     */
+    set content(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` used as the content.
+     * @returns The content entity reference.
+     */
+    get content(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` containing
+     * the horizontal `<pc-scrollbar>`.
+     * @param value - The horizontal scrollbar entity reference.
+     */
+    set horizontalScrollbar(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` containing the horizontal scrollbar.
+     * @returns The horizontal scrollbar entity reference.
+     */
+    get horizontalScrollbar(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` containing
+     * the vertical `<pc-scrollbar>`.
+     * @param value - The vertical scrollbar entity reference.
+     */
+    set verticalScrollbar(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` containing the vertical scrollbar.
+     * @returns The vertical scrollbar entity reference.
+     */
+    get verticalScrollbar(): string;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
+}
+export { ScrollViewComponentElement };

package/dist/entity.d.ts

@@ -35,6 +35,10 @@ declare class EntityElement extends AsyncElement {
      * The pointer event listeners for the entity.
      */
     private _listeners;
+    /**
+     * Whether the hierarchy has been built for this entity.
+     */
+    private _built;
     /**
      * The PlayCanvas entity instance.
      */

package/dist/index.d.ts

@@ -12,15 +12,20 @@ import { AppElement } from './app';
 import { EntityElement } from './entity';
 import { AssetElement } from './asset';
 import { ListenerComponentElement } from './components/listener-component';
+import { ButtonComponentElement } from './components/button-component';
 import { CameraComponentElement } from './components/camera-component';
 import { CollisionComponentElement } from './components/collision-component';
 import { ComponentElement } from './components/component';
 import { ElementComponentElement } from './components/element-component';
+import { LayoutChildComponentElement } from './components/layoutchild-component';
+import { LayoutGroupComponentElement } from './components/layoutgroup-component';
 import { LightComponentElement } from './components/light-component';
 import { ParticleSystemComponentElement } from './components/particlesystem-component';
 import { RenderComponentElement } from './components/render-component';
 import { RigidBodyComponentElement } from './components/rigidbody-component';
 import { ScreenComponentElement } from './components/screen-component';
+import { ScrollbarComponentElement } from './components/scrollbar-component';
+import { ScrollViewComponentElement } from './components/scrollview-component';
 import { ScriptComponentElement } from './components/script-component';
 import { ScriptElement } from './components/script';
 import { SoundComponentElement } from './components/sound-component';
@@ -30,4 +35,4 @@ import { MaterialElement } from './material';
 import { ModelElement } from './model';
 import { SceneElement } from './scene';
 import { SkyElement } from './sky';
-export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, MaterialElement, ModelElement, SceneElement, SkyElement };
+export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, ButtonComponentElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, LayoutChildComponentElement, LayoutGroupComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScrollbarComponentElement, ScrollViewComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, MaterialElement, ModelElement, SceneElement, SkyElement };