1.1.4 • Published 2 years ago

lesca-sensor-orientation v1.1.4

Weekly downloads
3
License
MIT
Repository
-
Last release
2 years ago

NPM React React React React React NPM

Why use it?

full steps for get mobile 3 axis value of mobile orientation.

See https://developer.mozilla.org/en-US/docs/Web/Events/Detecting_device_orientation for a demonstration!

Live Demo

Installation

npm install lesca-sensor-orientation --save

Usage

As a Node module:

import { useState, useEffect, useMemo } from 'react';
import Orientation from 'lesca-sensor-orientation';

// (1) waiting for permission => Must be user-triggered event and SSL required
// (2) add addEventListener
const Components = () => {
  const [state, setState] = useState(false);
  const orientation = useMemo(() => new Orientation(), []);

  const require_permission = () => {
    orientation
      .permission()
      .then(() => {
        // permission granted
        setState(true);
      })
      .catch(() => {
        // permission deined
      });
  };

  useEffect(() => {
    if (state) {
      orientation.addEventListener((e) => {
        alert(e);
      });
    }
    return () => {
      orientation.destory();
    };
  }, [state]);

  return <button onClick={require_permission}></button>;
};

Development

Methods

Methods

methoddescriptionreturn
.permission()ask user permissionvoid
addEventListener(callback:function)get 3 axis value each timevoid
.destory()destory eventvoid

Properties

Propertiesdescriptiondefault
disable:booleanstop / continue event listentrue
isSuppord:booleanpermission granted or deined(read only)

Features

  • TypeScript
  • maintain if necessary
1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago