Tilt Mark

useScreen

Read `window.screen` values reactively, with optional initialization and debounce control.

Read window.screen values reactively, with optional initialization and debounce control.

Usage

import { useScreen } from "@tilt-legal/cubitt-components/utilities/hooks";

const screen = useScreen();
const width = screen?.width ?? 0;

API

Signature

declare function useScreen(options: UseScreenOptions<false>): Screen | undefined;
declare function useScreen(options?: Partial<UseScreenOptions<true>>): Screen;

Parameters

This hook takes no arguments.

Return Value

ValueTypeDescription
return`Screenundefined

useResizeObserver

Custom hook that observes the size of an element using the [`ResizeObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).

useScript

Custom hook that dynamically loads scripts and tracking their loading status.

On this page

UsageAPISignatureParametersReturn Value