Back to Mantine

Use Viewport Size

apps/mantine.dev/src/pages/hooks/use-viewport-size.mdx

9.2.2520 B
Original Source

import { UseViewportSizeDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.useViewportSize);

Usage

The use-viewport-size hook returns the current viewport's width and height. It subscribes to resize and orientationchange events. During SSR, the hook will return { width: 0, height: 0 }:

<Demo data={UseViewportSizeDemos.usage} />

Definition

tsx
function useViewportSize(): {
  height: number;
  width: number;
};