react-hook-screen-orientation

    1.0.2 • Public • Published

    react-hook-screen-orientation 🔃

    A React hook for detecting screen orientation.

    Installation

    Using npm:

    npm install --save react-hook-screen-orientation

    Using yarn:

    yarn add react-hook-screen-orientation

    Usage

    import React from 'react'
    import useScreenOrientation from 'react-hook-screen-orientation'
    
    const ComponentWithScreenOrientation = () => {
      const screenOrientation = useScreenOrientation()
    
      return (
        <p>Screen orientation is: {screenOrientation}</p>
      )
    }

    Notes

    The screenOrientation value provided by the hook is the type propery of a ScreenOrientation interface is always one of the following strings:

    • portrait-primary
    • portrait-secondary (meaning upside down)
    • landscape-primary
    • landscape-secondary (meaning upside down)

    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-screen-orientation

    DownloadsWeekly Downloads

    49

    Version

    1.0.2

    License

    LGPL

    Unpacked Size

    10.7 kB

    Total Files

    5

    Last publish

    Collaborators

    • bence.a.toth