SSE Hooks

useScreen

Custom hook that tracks the screen dimensions and properties.

Installation

npx sse-hooks add use-screen

Usage

example.ts
import { useScreen } from "./{hooks file}";

const currentScreen = useScreen();
// Access properties of the current screen, such as width and height.

API

Parameters

Prop Default Type
options-

UseScreenOptions<false>

Returns

Return Value Default Type
return-

Screen

Hook return value

Types Aliases

No specific type aliases defined for this component.

Changelog

c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation

30da4 — feat: add new hooks and their metadata

cf13e — feat: add custom hooks for step navigation, ternary dark mode, timeout, toggle, unmount, and window size

Built with Love • © 2026