@dcl/playground-assets 7.23.4-26723618219.commit-ea97433 → 7.23.4-26770223094.commit-52b9415

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.23.4-26723618219.commit-ea97433",
+  "version": "7.23.4-26770223094.commit-52b9415",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "ea974331caffe948877a5bfadb0dc458ae60e15a"
+  "commit": "52b9415ebab8c77313e9fbc0725fd2e5f916d3c3"
 }

package/dist/playground-assets.d.ts

@@ -6570,6 +6570,14 @@ export declare interface PBUiCanvasInformation {
      * on the contrary, if the chat UI is shown, the rect would be smaller.
      */
     interactableArea: BorderRect | undefined;
+    /**
+     * informs the sdk about the screen inset area (safe margins). these are the
+     * insets from each edge of the screen that are reserved by the device or
+     * platform UI (for example: the notch, status bar, home indicator, or rounded
+     * corners on mobile). scenes should avoid placing critical UI within these
+     * insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).
+     */
+    screenInsetArea?: BorderRect | undefined;
 }
 
 /**
@@ -8560,6 +8568,27 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ *
+ * @public
+ * ScreenInsetArea component
+ *
+ * Constrains its children to the area inside the renderer-reported screen
+ * inset (safe margins). On mobile this is the area excluding the notch,
+ * status bar, home indicator and rounded corners. On desktop the insets are
+ * typically zero, so the container fills the canvas.
+ *
+ * The container is absolutely positioned with top/left/right/bottom matching
+ * the current `UiCanvasInformation.screenInsetArea`, so a child sized
+ * 100%x100% fills the safe area exactly.
+ *
+ * @example
+ * <ScreenInsetArea><MyHud /></ScreenInsetArea>
+ *
+ * @category Component
+ */
+export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public
@@ -9415,6 +9444,28 @@ export declare type UiRendererOptions = {
     virtualHeight: number;
 };
 
+/**
+ * ScreenInsetArea component props
+ *
+ * The container reads the current `screenInsetArea` reported by the renderer
+ * via `UiCanvasInformation` (the device safe margins — notch, status bar,
+ * home indicator, rounded corners) and constrains its children to the area
+ * inside those insets using absolute positioning. Layout props that control
+ * the container's own position (`positionType`, `position`) are owned by the
+ * component and are not configurable from props — every other layout,
+ * background and event prop is forwarded as usual.
+ *
+ * @public
+ */
+export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    /**
+     * Layout overrides forwarded to the underlying entity. The
+     * `positionType` and `position` fields are reserved by the container and
+     * any value provided here is ignored.
+     */
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/etc/playground-assets.api.json

@@ -62363,6 +62363,38 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#screenInsetArea:member",
+              "docComment": "/**\n * informs the sdk about the screen inset area (safe margins). these are the insets from each edge of the screen that are reserved by the device or platform UI (for example: the notch, status bar, home indicator, or rounded corners on mobile). scenes should avoid placing critical UI within these insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "screenInsetArea?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BorderRect",
+                  "canonicalReference": "@dcl/playground-assets!BorderRect"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "screenInsetArea",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#width:member",
@@ -82018,6 +82050,53 @@
             }
           ]
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!ScreenInsetArea:function(1)",
+          "docComment": "/**\n * ScreenInsetArea component\n *\n * Constrains its children to the area inside the renderer-reported screen inset (safe margins). On mobile this is the area excluding the notch, status bar, home indicator and rounded corners. On desktop the insets are typically zero, so the container fills the canvas.\n *\n * The container is absolutely positioned with top/left/right/bottom matching the current `UiCanvasInformation.screenInsetArea`, so a child sized 100%x100% fills the safe area exactly.\n *\n * @example\n *\n * <ScreenInsetArea><MyHud /></ScreenInsetArea>\n *\n * @category Component\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function ScreenInsetArea(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiScreenInsetAreaProps",
+              "canonicalReference": "@dcl/playground-assets!UiScreenInsetAreaProps:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ReactEcs.JSX.Element",
+              "canonicalReference": "@dcl/playground-assets!ReactEcs.JSX.Element:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../react-ecs/dist/components/ScreenInsetArea/index.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "ScreenInsetArea"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@dcl/playground-assets!setGlobalPolyfill:function(1)",
@@ -89181,6 +89260,73 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@dcl/playground-assets!UiScreenInsetAreaProps:type",
+          "docComment": "/**\n * ScreenInsetArea component props\n *\n * The container reads the current `screenInsetArea` reported by the renderer via `UiCanvasInformation` (the device safe margins — notch, status bar, home indicator, rounded corners) and constrains its children to the area inside those insets using absolute positioning. Layout props that control the container's own position (`positionType`, `position`) are owned by the component and are not configurable from props — every other layout, background and event prop is forwarded as usual.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiScreenInsetAreaProps = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "EntityPropTypes",
+              "canonicalReference": "@dcl/playground-assets!EntityPropTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", 'uiTransform'> & {\n    uiTransform?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "NonNullable",
+              "canonicalReference": "!NonNullable:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "EntityPropTypes",
+              "canonicalReference": "@dcl/playground-assets!EntityPropTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "['uiTransform']>, 'positionType' | 'position'>;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../react-ecs/dist/components/ScreenInsetArea/types.d.ts",
+          "releaseTag": "Public",
+          "name": "UiScreenInsetAreaProps",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 11
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!UiText:var",

package/etc/playground-assets.api.md

@@ -3727,6 +3727,7 @@ export interface PBUiCanvasInformation {
     devicePixelRatio: number;
     height: number;
     interactableArea: BorderRect | undefined;
+    screenInsetArea?: BorderRect | undefined;
     width: number;
 }
 
@@ -4756,6 +4757,11 @@ export namespace Schemas {
     }) => void;
 }
 
+// Warning: (tsdoc-undefined-tag) The TSDoc tag "@category" is not defined in this configuration
+//
+// @public
+export function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
 // @public
 export function setGlobalPolyfill<T>(key: string, value: T): void;
 
@@ -5300,6 +5306,11 @@ export type UiRendererOptions = {
     virtualHeight: number;
 };
 
+// @public
+export type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 // @public (undocumented)
 export const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.23.4-26723618219.commit-ea97433",
+  "version": "7.23.4-26770223094.commit-52b9415",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.23.4-26723618219.commit-ea97433",
-    "@dcl/sdk": "7.23.4-26723618219.commit-ea97433"
+    "@dcl/js-runtime": "7.23.4-26770223094.commit-52b9415",
+    "@dcl/sdk": "7.23.4-26770223094.commit-52b9415"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "ea974331caffe948877a5bfadb0dc458ae60e15a"
+  "commit": "52b9415ebab8c77313e9fbc0725fd2e5f916d3c3"
 }