Tilt Mark

useWindowSize

Track viewport width and height with options for SSR-safe initialization and debouncing.

Track viewport width and height with options for SSR-safe initialization and debouncing.

Usage

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

const { width, height } = useWindowSize();

API

Signature

declare function useWindowSize(options: UseWindowSizeOptions<false>): WindowSize;
declare function useWindowSize(options?: Partial<UseWindowSizeOptions<true>>): WindowSize<number>;

Parameters

This hook takes no arguments.

Return Value

ValueTypeDescription
return`WindowSizeWindowSize<number>`

useUnmount

Custom hook that runs a cleanup function when the component is unmounted.

Core Hooks

Cubitt-specific hooks used when building composable components.

On this page

UsageAPISignatureParametersReturn Value