@dcl/react-ecs 7.27.1-33756439818.commit-3a236ab → 7.27.1-34101585995.commit-6eb5b5d

package/dist/components/Button/index.js

@@ -29,7 +29,7 @@ function getButtonProps(props) {
  */
 /* @__PURE__ */
 export function Button(props) {
-    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, ...otherProps } = props;
+    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, onMouseDrag, onMouseDragLocked, onMouseDragEnd, ...otherProps } = props;
     const buttonProps = getButtonProps(props);
     const uiBackgroundProps = parseUiBackground({
         ...buttonProps.uiBackground,
@@ -58,5 +58,5 @@ export function Button(props) {
             uiBackgroundProps.color = { ...uiBackgroundProps.color, a: uiBackgroundProps.color.a / 2 };
         }
     }
-    return (ReactEcs.createElement("entity", { onMouseDown: !!props.disabled ? undefined : onMouseDown, onMouseUp: !!props.disabled ? undefined : onMouseUp, onMouseEnter: onMouseEnter, onMouseLeave: onMouseLeave, uiTransform: uiTransformProps, uiText: textProps, uiBackground: uiBackgroundProps }));
+    return (ReactEcs.createElement("entity", { onMouseDown: !!props.disabled ? undefined : onMouseDown, onMouseUp: !!props.disabled ? undefined : onMouseUp, onMouseEnter: onMouseEnter, onMouseLeave: onMouseLeave, onMouseDrag: onMouseDrag, onMouseDragLocked: onMouseDragLocked, onMouseDragEnd: onMouseDragEnd, uiTransform: uiTransformProps, uiText: textProps, uiBackground: uiBackgroundProps }));
 }

package/dist/components/Dropdown/index.js

@@ -34,7 +34,7 @@ function parseUiDropdown(props) {
  */
 /* @__PURE__ */
 export function Dropdown(props) {
-    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, ...otherProps } = props;
+    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, onMouseDrag, onMouseDragLocked, onMouseDragEnd, ...otherProps } = props;
     const dropdownProps = parseUiDropdown(otherProps);
     const commonProps = parseProps({
         uiTransform,
@@ -42,7 +42,10 @@ export function Dropdown(props) {
         onMouseDown,
         onMouseUp,
         onMouseEnter,
-        onMouseLeave
+        onMouseLeave,
+        onMouseDrag,
+        onMouseDragLocked,
+        onMouseDragEnd
     });
     return ReactEcs.createElement("entity", { ...commonProps, uiDropdown: dropdownProps });
 }

package/dist/components/Input/index.js

@@ -35,7 +35,7 @@ function parseUiInput(props) {
  * @category Component
  */ /* @__PURE__ */
 export function Input(props) {
-    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, ...otherProps } = props;
+    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, onMouseDrag, onMouseDragLocked, onMouseDragEnd, ...otherProps } = props;
     const inputProps = parseUiInput(otherProps);
     const commonProps = parseProps({
         uiTransform,
@@ -43,7 +43,10 @@ export function Input(props) {
         onMouseDown,
         onMouseUp,
         onMouseEnter,
-        onMouseLeave
+        onMouseLeave,
+        onMouseDrag,
+        onMouseDragLocked,
+        onMouseDragEnd
     });
     return ReactEcs.createElement("entity", { ...commonProps, uiInput: inputProps });
 }

package/dist/components/Label/index.js

@@ -16,14 +16,17 @@ export { scaleFontSize } from './utils';
  */
 /* @__PURE__ */
 export function Label(props) {
-    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, ...uiTextProps } = props;
+    const { uiTransform, uiBackground, onMouseDown, onMouseUp, onMouseEnter, onMouseLeave, onMouseDrag, onMouseDragLocked, onMouseDragEnd, ...uiTextProps } = props;
     const commonProps = parseProps({
         uiTransform,
         uiBackground,
         onMouseDown,
         onMouseUp,
         onMouseEnter,
-        onMouseLeave
+        onMouseLeave,
+        onMouseDrag,
+        onMouseDragLocked,
+        onMouseDragEnd
     });
     const { font, textAlign, fontSize, textWrap, ...textProps } = uiTextProps;
     const uiText = {

package/dist/components/listeners/types.d.ts

@@ -1,8 +1,10 @@
+import { PBPointerEventsResult } from '@dcl/ecs';
 /**
- * Callback function to be triggered on a specified event
+ * Callback function to be triggered on a specified event. Receives the pointer event that
+ * fired it (button, hit, and for drags the pointer delta), which handlers may ignore.
  * @public
  */
-export type Callback = () => void;
+export type Callback = (event: PBPointerEventsResult) => void;
 /**
  * User key event Listeners
  * @public
@@ -16,4 +18,10 @@ export type Listeners = {
     onMouseEnter?: Callback;
     /** triggered on mouse leave event */
     onMouseLeave?: Callback;
+    /** triggered while the pointer is dragged after pressing on the element */
+    onMouseDrag?: Callback;
+    /** triggered while the pointer is dragged with the cursor locked in place */
+    onMouseDragLocked?: Callback;
+    /** triggered when a drag that started on the element ends */
+    onMouseDragEnd?: Callback;
 };

package/dist/components/listeners/types.js

@@ -2,7 +2,10 @@ const listeners = {
     onMouseDown: undefined,
     onMouseUp: undefined,
     onMouseEnter: undefined,
-    onMouseLeave: undefined
+    onMouseLeave: undefined,
+    onMouseDrag: undefined,
+    onMouseDragLocked: undefined,
+    onMouseDragEnd: undefined
 };
 const listenersKey = Object.keys(listeners);
 /**

package/dist/components/uiBackground/types.d.ts

@@ -1,4 +1,4 @@
-import { BorderRect } from '@dcl/ecs';
+import { BorderRect, Entity } from '@dcl/ecs';
 import { Color4 } from '@dcl/ecs/dist/components/generated/pb/decentraland/common/colors.gen';
 /**
  * @public
@@ -15,6 +15,8 @@ export interface UiBackgroundProps {
     uvs?: number[];
     /** AvatarTexture for the background */
     avatarTexture?: UiAvatarTexture;
+    /** VideoTexture for the background: the frames of a VideoPlayer on another entity */
+    videoTexture?: UiVideoTexture;
     /** Texture for the background */
     texture?: UiTexture;
 }
@@ -27,6 +29,15 @@ export interface UiAvatarTexture {
     wrapMode?: TextureWrapType;
     filterMode?: TextureFilterType;
 }
+/**
+ * Video Texture
+ * @public
+ */
+export interface UiVideoTexture {
+    videoPlayerEntity: Entity;
+    wrapMode?: TextureWrapType;
+    filterMode?: TextureFilterType;
+}
 /**
  * Texture
  * @public

package/dist/components/uiBackground/utils.js

@@ -30,6 +30,14 @@ export function getTexture(props) {
             }
         };
     }
+    if (props.videoTexture) {
+        return {
+            tex: {
+                $case: 'videoTexture',
+                videoTexture: parseTexture(props.videoTexture)
+            }
+        };
+    }
     return undefined;
 }
 function parseTexture(texture) {

package/dist/components/uiTransform/index.js

@@ -1,4 +1,4 @@
-import { getAlign, getDisplay, getFlexDirection, getFlexWrap, getJustify, getOverflow, getPointerFilter, getPositionType, parseBorderColor, parseBorderRadius, parseBorderWidth, parsePosition, parseSize } from './utils';
+import { getAlign, getDisplay, getFlexDirection, getFlexWrap, getJustify, getOverflow, getPointerFilter, getPositionType, getScrollPosition, getScrollVisible, parseBorderColor, parseBorderRadius, parseBorderWidth, parsePosition, parseSize } from './utils';
 /**
  * @internal
  */
@@ -60,7 +60,7 @@ const defaultUiTransform = {
  */
 /* @__PURE__ */
 export function parseUiTransform(props = {}) {
-    const { height, minHeight, maxHeight, width, minWidth, maxWidth, alignItems, alignContent, flexWrap, borderRadius, borderWidth, borderColor, ...otherProps } = props;
+    const { height, minHeight, maxHeight, width, minWidth, maxWidth, alignItems, alignContent, flexWrap, borderRadius, borderWidth, borderColor, scrollPosition, scrollVisible, ...otherProps } = props;
     return {
         ...defaultUiTransform,
         ...otherProps,
@@ -86,6 +86,8 @@ export function parseUiTransform(props = {}) {
         ...(flexWrap && getFlexWrap(flexWrap)),
         ...(borderRadius && parseBorderRadius(borderRadius)),
         ...(borderWidth && parseBorderWidth(borderWidth)),
-        ...(borderColor && parseBorderColor(borderColor))
+        ...(borderColor && parseBorderColor(borderColor)),
+        ...(scrollPosition && getScrollPosition(scrollPosition)),
+        ...(scrollVisible && getScrollVisible(scrollVisible))
     };
 }

package/dist/components/uiTransform/types.d.ts

@@ -1,4 +1,5 @@
 import { Color4 } from '@dcl/ecs/dist/components/generated/pb/decentraland/common/colors.gen';
+import { Vector2 } from '@dcl/ecs/dist/components/generated/pb/decentraland/common/vectors.gen';
 import { ScaleUnit } from '../types';
 /**
  * unit value specified. i.e. 1 || '100%' || '1px' || '10vw'
@@ -131,4 +132,15 @@ export interface UiTransformProps {
     opacity?: number;
     /** default 0 */
     zIndex?: number;
+    /** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
+    elementId?: string;
+    /** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
+    scrollPosition?: Vector2 | string;
+    /** Which scrollbars to show when overflow is 'scroll'. default 'both' */
+    scrollVisible?: ScrollVisibleType;
 }
+/**
+ * Which scrollbars are shown when the overflow is scrollable
+ * @public
+ */
+export type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';

package/dist/components/uiTransform/utils.js

@@ -244,3 +244,24 @@ const parsePointerFilter = {
     none: 0 /* PointerFilterMode.PFM_NONE */,
     block: 1 /* PointerFilterMode.PFM_BLOCK */
 };
+/**
+ * @internal
+ */
+export function getScrollPosition(scrollPosition) {
+    if (typeof scrollPosition === 'string') {
+        return { scrollPosition: { value: { $case: 'reference', reference: scrollPosition } } };
+    }
+    return { scrollPosition: { value: { $case: 'position', position: scrollPosition } } };
+}
+const parseScrollVisible = {
+    both: 0 /* ShowScrollBar.SSB_BOTH */,
+    hidden: 3 /* ShowScrollBar.SSB_HIDDEN */,
+    horizontal: 2 /* ShowScrollBar.SSB_ONLY_HORIZONTAL */,
+    vertical: 1 /* ShowScrollBar.SSB_ONLY_VERTICAL */
+};
+/**
+ * @internal
+ */
+export function getScrollVisible(scrollVisible) {
+    return { scrollVisible: parseScrollVisible[scrollVisible] };
+}

package/dist/react-ecs.d.ts

@@ -23,6 +23,9 @@ export type EntityComponents = {
     onMouseUp: Callback;
     onMouseEnter: Callback;
     onMouseLeave: Callback;
+    onMouseDrag: Callback;
+    onMouseDragLocked: Callback;
+    onMouseDragEnd: Callback;
 };
 /**
  * @hidden

package/dist/reconciler/index.d.ts

@@ -1,6 +1,6 @@
 import { Entity, IEngine, PointerEventsSystem } from '@dcl/ecs';
 import { ReactEcs } from '../react-ecs';
-export declare function createReconciler(engine: Pick<IEngine, 'getComponent' | 'addEntity' | 'removeEntity' | 'defineComponentFromSchema' | 'getEntitiesWith'>, pointerEvents: PointerEventsSystem): {
+export declare function createReconciler(engine: Pick<IEngine, 'getComponent' | 'addEntity' | 'removeEntity' | 'defineComponentFromSchema' | 'getEntitiesWith'>, pointerEvents: PointerEventsSystem, rootEntity?: Entity): {
     update: (component: ReactEcs.JSX.ReactNode) => number;
     getEntities: () => Entity[];
 };

package/dist/reconciler/index.js

@@ -8,11 +8,17 @@ function getPointerEnum(pointerKey) {
         onMouseDown: 1 /* PointerEventType.PET_DOWN */,
         onMouseUp: 0 /* PointerEventType.PET_UP */,
         onMouseEnter: 2 /* PointerEventType.PET_HOVER_ENTER */,
-        onMouseLeave: 3 /* PointerEventType.PET_HOVER_LEAVE */
+        onMouseLeave: 3 /* PointerEventType.PET_HOVER_LEAVE */,
+        onMouseDrag: 7 /* PointerEventType.PET_DRAG */,
+        onMouseDragLocked: 6 /* PointerEventType.PET_DRAG_LOCKED */,
+        onMouseDragEnd: 8 /* PointerEventType.PET_DRAG_END */
     };
     return pointers[pointerKey];
 }
-export function createReconciler(engine, pointerEvents) {
+export function createReconciler(engine, pointerEvents, 
+// When set, every entity this reconciler creates is parented to it -- a UiCanvas on the root
+// entity then renders the tree to a texture instead of the screen.
+rootEntity) {
     // Store all the entities so when we destroy the UI we can also destroy them
     const entities = new Set();
     // Store the onChange callbacks to be runned every time a Result has changed
@@ -29,6 +35,7 @@ export function createReconciler(engine, pointerEvents) {
     const UiInputResult = components.UiInputResult(engine);
     const UiDropdown = components.UiDropdown(engine);
     const UiDropdownResult = components.UiDropdownResult(engine);
+    const Transform = components.Transform(engine);
     const UiInputBinding = components.UiInputBinding(engine);
     // Component ID Helper
     const getComponentId = {
@@ -39,10 +46,10 @@ export function createReconciler(engine, pointerEvents) {
         uiDropdown: UiDropdown.componentId,
         uiInputBinding: UiInputBinding.componentId
     };
-    function pointerEventCallback(entity, pointerEvent) {
+    function pointerEventCallback(entity, pointerEvent, event) {
         const callback = clickEvents.get(entity)?.get(pointerEvent);
         if (callback)
-            callback();
+            callback(event);
         return;
     }
     function updateTree(instance, props) {
@@ -63,6 +70,15 @@ export function createReconciler(engine, pointerEvents) {
             else if (update.component === 'onMouseLeave') {
                 pointerEvents.removeOnPointerHoverLeave(instance.entity);
             }
+            else if (update.component === 'onMouseDrag') {
+                pointerEvents.removeOnPointerDrag(instance.entity);
+            }
+            else if (update.component === 'onMouseDragLocked') {
+                pointerEvents.removeOnPointerDragLocked(instance.entity);
+            }
+            else if (update.component === 'onMouseDragEnd') {
+                pointerEvents.removeOnPointerDragEnd(instance.entity);
+            }
             return;
         }
         if (update.props) {
@@ -78,7 +94,13 @@ export function createReconciler(engine, pointerEvents) {
                     ? pointerEvents.onPointerUp
                     : update.component === 'onMouseEnter'
                         ? pointerEvents.onPointerHoverEnter
-                        : update.component === 'onMouseLeave' && pointerEvents.onPointerHoverLeave;
+                        : update.component === 'onMouseLeave'
+                            ? pointerEvents.onPointerHoverLeave
+                            : update.component === 'onMouseDrag'
+                                ? pointerEvents.onPointerDrag
+                                : update.component === 'onMouseDragLocked'
+                                    ? pointerEvents.onPointerDragLocked
+                                    : update.component === 'onMouseDragEnd' && pointerEvents.onPointerDragEnd;
             if (pointerEventSystem) {
                 pointerEventSystem({
                     entity: instance.entity,
@@ -88,7 +110,7 @@ export function createReconciler(engine, pointerEvents) {
                         // This is needed for the renderer to know which entities are clickeables
                         showFeedback: true
                     }
-                }, () => pointerEventCallback(instance.entity, pointerEvent));
+                }, (event) => pointerEventCallback(instance.entity, pointerEvent, event));
             }
         }
     }
@@ -217,6 +239,9 @@ export function createReconciler(engine, pointerEvents) {
         ...noopConfig,
         createInstance(type, props) {
             const entity = engine.addEntity();
+            if (rootEntity !== undefined) {
+                Transform.createOrReplace(entity, { parent: rootEntity });
+            }
             entities.add(entity);
             const instance = {
                 entity,

package/dist/reconciler/utils.js

@@ -49,6 +49,9 @@ const entityComponent = {
     onMouseUp: undefined,
     onMouseEnter: undefined,
     onMouseLeave: undefined,
+    onMouseDrag: undefined,
+    onMouseDragLocked: undefined,
+    onMouseDragEnd: undefined,
     uiInput: undefined,
     uiDropdown: undefined,
     uiInputBinding: undefined

package/dist/system.d.ts

@@ -74,6 +74,20 @@ export interface ReactBasedUiSystem {
      * @param entity - The entity whose UI renderer should be removed
      */
     removeUiRenderer(entity: Entity): void;
+    /**
+     * Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
+     * describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
+     * any texture renderer already set on the entity, and is torn down when the entity is removed.
+     *
+     * @param entity - The UiCanvas entity the UI tree hangs from
+     * @param ui - The UI component to render
+     */
+    setTextureRenderer(entity: Entity, ui: UiComponent): void;
+    /**
+     * Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
+     * @param entity - The UiCanvas entity the renderer was set on
+     */
+    removeTextureRenderer(entity: Entity): void;
 }
 /**
  * @public

package/dist/system.js

@@ -47,6 +47,18 @@ export function createReactBasedUiSystem(engine, pointerSystem) {
     let uiComponent = undefined;
     let mainOptions = undefined;
     const additionalRenderers = new Map();
+    // UI trees rendered to a texture, keyed by their UiCanvas entity. Each needs its own reconciler
+    // because the root parent is a per-reconciler property.
+    const textureRenderers = new Map();
+    function destroyTextureRenderer(entity) {
+        const entry = textureRenderers.get(entity);
+        if (!entry)
+            return;
+        textureRenderers.delete(entity);
+        for (const uiEntity of entry.renderer.getEntities()) {
+            engine.removeEntity(uiEntity);
+        }
+    }
     const UiCanvasInformation = ecsComponents.UiCanvasInformation(engine);
     // Unique owner to prevent other UI systems resetting this scale factor.
     const uiScaleFactorOwner = Symbol('react-ecs-ui-scale');
@@ -162,6 +174,14 @@ export function createReactBasedUiSystem(engine, pointerSystem) {
         else {
             renderer.update(null);
         }
+        for (const [entity, entry] of textureRenderers) {
+            if (engine.getEntityState(entity) === EntityState.Removed) {
+                destroyTextureRenderer(entity);
+            }
+            else {
+                entry.renderer.update(React.createElement(entry.ui));
+            }
+        }
     }
     function UiScaleSystem() {
         const canvasInfo = UiCanvasInformation.getOrNull(engine.RootEntity);
@@ -219,6 +239,9 @@ export function createReactBasedUiSystem(engine, pointerSystem) {
             for (const entity of renderer.getEntities()) {
                 engine.removeEntity(entity);
             }
+            for (const entity of textureRenderers.keys()) {
+                destroyTextureRenderer(entity);
+            }
         },
         setUiRenderer(ui, options) {
             uiComponent = ui;
@@ -229,6 +252,13 @@ export function createReactBasedUiSystem(engine, pointerSystem) {
         },
         removeUiRenderer(entity) {
             additionalRenderers.delete(entity);
+        },
+        setTextureRenderer(entity, ui) {
+            destroyTextureRenderer(entity);
+            textureRenderers.set(entity, { renderer: createReconciler(engine, pointerSystem, entity), ui });
+        },
+        removeTextureRenderer(entity) {
+            destroyTextureRenderer(entity);
         }
     };
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/react-ecs",
   "description": "Decentraland ECS",
-  "version": "7.27.1-33756439818.commit-3a236ab",
+  "version": "7.27.1-34101585995.commit-6eb5b5d",
   "author": "DCL",
   "bugs": "https://github.com/decentraland/js-sdk-toolchain/issues",
   "dependencies": {
-    "@dcl/ecs": "7.27.1-33756439818.commit-3a236ab",
+    "@dcl/ecs": "7.27.1-34101585995.commit-6eb5b5d",
     "react": "^18.2.0",
     "react-reconciler": "^0.29.0"
   },
@@ -40,5 +40,5 @@
     "tsconfig": "./tsconfig.json"
   },
   "types": "./dist/index.d.ts",
-  "commit": "3a236ab909c08dc265a66125c7f118402ab3f3c9"
+  "commit": "6eb5b5d604be23e8b88950e2cca42f787b44c700"
 }