@dcl/react-ecs
Version:
Decentraland ECS
24 lines (23 loc) • 909 B
TypeScript
import { ReactEcs } from '../../react-ecs';
import { UiInteractableAreaProps } from './types';
/**
*
* @public
* InteractableArea component
*
* Constrains its children to the area inside the renderer-reported interactable
* area. This is the portion of the screen not covered by client UI such as the
* minimap, chat window, or other platform overlays. On the Unity desktop client
* the left 25% of the screen is reserved for client UI, so this container
* positions its children within the remaining 75%.
*
* The container is absolutely positioned with top/left/right/bottom matching
* the current `UiCanvasInformation.interactableArea`, so a child sized
* 100%x100% fills the interactable area exactly.
*
* @example
* <InteractableArea><MyHud /></InteractableArea>
*
* @category Component
*/
export declare function InteractableArea(props: UiInteractableAreaProps): ReactEcs.JSX.Element;