Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TyMick/use-window-orientation

A React hook for using window orientation.
https://github.com/TyMick/use-window-orientation

hacktoberfest hook hooks javascript landscape media-queries npm orientation package portrait react responsive responsive-design screen-dimension screen-orientation typescript window-dimensions window-orientation

Last synced: about 1 month ago
JSON representation

A React hook for using window orientation.

Awesome Lists containing this project

README 

        
# useWindowOrientation



[![npm version](https://img.shields.io/npm/v/use-window-orientation)](https://www.npmjs.com/package/use-window-orientation "View this package on npm")

[![npm peer dependency version](https://img.shields.io/npm/dependency-version/use-window-orientation/peer/react)](https://www.npmjs.com/package/use-window-orientation "View this package on npm")

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/use-window-orientation)](https://bundlephobia.com/result?p=use-window-orientation "View this package on BundlePhobia")

[![License: Apache-2.0](https://img.shields.io/npm/l/use-window-orientation)](/LICENSE)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0-ff69b4.svg)](/CODE_OF_CONDUCT.md)



- **[Installation](#installation)**

- **[Usage](#usage)**

- **[Options](#options)**

- **[Caveats](#caveats)**

- **[Contributing](#contributing)**

- **[Related projects](#related-projects)**



Sometimes, just knowing [the window width](https://github.com/tywmick/use-window-width-breakpoints) isn't enough. Sometimes you want to know if the window's orientation is portrait or landscape. Good thing you found this React hook.



Installation



```sh

npm install use-window-orientation

# OR

yarn add use-window-orientation

```



Usage



After importing the hook...



```js

import useWindowOrientation from "use-window-orientation";

```



...call it from the top level of your React function.



```js

const { orientation, portrait, landscape } = useWindowOrientation();

```



This hook returns an object with three properties, each describing the current orientation of the window in a different way.



- `orientation` will be either `"portrait"` or `"landscape"`

- `portrait` will be either `true` or `false`

- `landscape` will be either `false` or `true`



The easiest way to access these properties is by using [object destructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment), as in the above example. One advantage of this method is that you only have to declare variables for the properties you actually want to use. Only plan on using the `portrait` boolean in your code? Then just call the hook like this:



```js

const { portrait } = useWindowOrientation();

```



What's this hook good for? Say you have two components, `Chart` and `Explanation`. You want `Explanation` to come first if the window is portrait, but you want `Chart` to come first if the window is landscape. Then arrange them in your JSX like this:



```jsx

{portrait && }

;

{landscape && }

```



Or say you want to creep out your users by divining the orientation of their window:



```jsx

Well, your window is {orientation} right now, so you leave me no choice.


```



The possibilities are endless.



Options



This hook has one optional parameter: an options object. There is currently only one option, `defaultOrientation`, the default orientation you'd like to return if no window exists (such as if a search engine is crawling your page). Valid `defaultOrientation`s are `"portrait"` or `"landscape"`, and if you omit the option, it will default to `"portrait"`.



```js

const { orientation, portrait, landscape } = useWindowOrientation({

  defaultOrientation: "portrait",

});

```



Caveats



This hook only deals with the _window_ orientation, not the _device_ orientation. It calculates this orientation using `window.innerWidth` and `window.innerHeight`. It does not consult [`window.orientation`](https://developer.mozilla.org/en-US/docs/Web/API/Window/orientation) at all because that feature has been deprecated.



Also, in the rare case that the window's width and height are equal, useWindowOrientation will just report the orientation as portrait.



Contributing



If you'd like to contribute to this project (which would be awesome), the easiest way to set it up would be to install the [GitHub CLI](https://cli.github.com/) and then run the following:



```sh

gh repo fork tywmick/use-window-orientation --clone=true

cd use-window-orientation

npm install

```



Now, you can build the package with `npm run build`, build _and_ watch for changes with `npm run dev` (automatically rebuilding on each change in the source), run the test suite with `npm run test`, and create pull requests with [`gh pr create`](https://cli.github.com/manual/gh_pr_create).



After building the package, you can test it in another project on your machine by [adding the local path](https://docs.npmjs.com/files/package.json#local-paths) as a dependency (e.g., by running `npm install /path/to/local/use-window-orientation` in that other project).



Related projects



- [useWindowWidthBreakpoints](https://github.com/tywmick/use-window-width-breakpoints)