react-hook-device-orientation

    1.0.1 • Public • Published

    react-hook-device-orientation 💫

    A React hook for detecting device orientation.

    Installation

    Using npm:

    npm install --save react-hook-device-orientation

    Using yarn:

    yarn add react-hook-device-orientation

    Usage

    import React from 'react'
    import useDeviceOrientation from 'react-hook-device-orientation'
     
    const ComponentWithDeviceOrientation = () => {
      const deviceOrientation = useDeviceOrientation()
     
      return (
        <ul>
          <li>Alpha:    {orientation.alpha}</li>
          <li>Beta:     {orientation.beta}</li>
          <li>Gamma:    {orientation.gamma}</li>
          <li>Absolute: {orientation.absolute ? 'yes' : 'no'}</li>
        </ul>
      )
    }

    Caveats

    There are slightly different implementations of the web API responsible for accessing device orientation, and therefore the values you get from this hook might not be consistent across different browsers. Read more about this.

    Contributions

    Contributions are welcome. File bug reports, create pull requests, feel free to reach out at tothab@gmail.com.

    Licence

    LGPL-3.0

    Install

    npm i react-hook-device-orientation

    DownloadsWeekly Downloads

    2

    Version

    1.0.1

    License

    LGPL

    Unpacked Size

    11 kB

    Total Files

    5

    Last publish

    Collaborators

    • bence.a.toth