fn

useDevicePixelRatio

v0.0.14testeddemo

Reactively track window.devicePixelRatio, updated via a matchMedia(resolution) listener (fires on zoom and on monitor changes).

Example

ts
const { pixelRatio } = useDevicePixelRatio();

Demo

Loading demo…

Signature

ts
export function useDevicePixelRatio(options: UseDevicePixelRatioOptions ={ ... }

Parameters

ParameterTypeDescription
options?UseDevicePixelRatioOptionsOptions (custom window)

Returns

UseDevicePixelRatioReturn{ pixelRatio, stop }
PropertyTypeDescription
pixelRatioReadonly<ShallowRef<number>>Reactive, readonly window.devicePixelRatio. Defaults to 1 on the server / when no window is available.
stopWatchStopHandleStop tracking the device pixel ratio. Idempotent and a no-op on SSR.