useScreenOrientation

v0.0.15testeddemo

Reactive Screen Orientation API. Tracks the current orientation `type` and `angle`, and exposes helpers to lock/unlock the orientation. SSR-safe.

Source Tests

Examples

const { isSupported, orientation, angle, lockOrientation, unlockOrientation } = useScreenOrientation();

// Lock to landscape (must run from a user gesture / fullscreen context)
const { lockOrientation } = useScreenOrientation();
await lockOrientation('landscape');

Demo

Loading demo…

Signature

export function useScreenOrientation(options: UseScreenOrientationOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`options`?	`UseScreenOrientationOptions`	`{}`	Options (custom `window`)

Returns

UseScreenOrientationReturn`{ isSupported, orientation, angle, lockOrientation, unlockOrientation }`