Skip to main content

@rtorcato/browser-common / motion

motion

Functions​

isDeviceMotionAvailable()​

isDeviceMotionAvailable(): boolean

Defined in: motion/index.ts:10

Checks if the DeviceMotion API is available in the browser.

Example​

import { isDeviceMotionAvailable } from '@rtorcato/browser-common/motion'
if (isDeviceMotionAvailable()) listen()

Returns​

boolean

True if DeviceMotionEvent is supported, false otherwise.

onDeviceMotion()​

onDeviceMotion(callback): () => void

Defined in: motion/index.ts:25

Adds a listener for device motion events.

Example​

import { onDeviceMotion } from '@rtorcato/browser-common/motion'
const off = onDeviceMotion((e) => console.log(e.acceleration))
off()

Parameters​

callback​

(event) => void

The callback to run on device motion.

Returns​

A function to remove the event listener.

() => void

isGenericSensorApiAvailable()​

isGenericSensorApiAvailable(): boolean

Defined in: motion/index.ts:40

Checks if the browser supports the Generic Sensor API for motion sensors.

Example​

import { isGenericSensorApiAvailable } from '@rtorcato/browser-common/motion'
if (isGenericSensorApiAvailable()) startSensor()

Returns​

boolean

True if supported, false otherwise.

requestMotionPermission()​

requestMotionPermission(): Promise<"granted" | "denied" | "default">

Defined in: motion/index.ts:57

Requests permission for motion and orientation events (iOS 13+).

Example​

import { requestMotionPermission } from '@rtorcato/browser-common/motion'
button.addEventListener('click', async () => {
  if ((await requestMotionPermission()) === 'granted') listen()
})

Returns​

Promise<"granted" | "denied" | "default">

The permission state.

Remarks​

Required on iOS Safari; must be called from a user gesture.