@dcl/react-ecs
Version:
Decentraland ECS
23 lines (22 loc) • 995 B
TypeScript
import { EntityPropTypes } from '../types';
/**
* 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 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'>;
};