# orient-device > orientation device force plugin, in order to inform your mobile users that its not a preffered orientation Latest version **0.1.2** (published 2017-06-29) · MIT license · 0 weekly downloads ## Install ```sh npm install orient-device pnpm add orient-device yarn add orient-device bun add orient-device ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.2 | | Published | 2017-06-29 | | First published | 2017-06-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Caliber Interactive | | Maintainers | caliberi | | Keywords | orientation, device, javascript, detection | ## Links - npm: https://www.npmjs.com/package/orient-device - Repository: https://github.com/caliberi/orient-device - Homepage: https://github.com/caliberi/orient-device#readme - Issues: https://github.com/caliberi/orient-device/issues - npm.io page: https://npm.io/package/orient-device ## Recent versions - 0.1.2 (latest) — 2017-06-29 - 0.1.1 — 2017-06-29 ## README # Orient Device **Installation** ```bash npm install --save-dev orient-device ``` **Usage** **1.** Add `orient.js` file to your project code and initialise it. ```html ... ``` **Or** using webpack ```javascript let OrientDevice = require('orient-device'); OrientDevice.init(); ``` --- Here is a list of options:
Option Default Value Comments
prefferedOrient portrait (String) Can take 2 values either landscape or portrait
background Value will depend on browser (String) Plugin does browser detection and there is an official documentation of browsers primary colors. If you want you can specify background yourself, rgba, hex ...
error <p><strong>Whoops</strong> can you please rotate your device back to <span id="preferred"></span> <em> :) </em></p>
Yes, HTML. 		If you want to dynamically pull value of your prefered orientation please include an element with an id="preferred" or it will throw a Javascript error
color rgba(255, 255, 255, 1) (String) You can include hex, rgb, rgba, or just words (like green, blue etc...)
--- **Custom Callbacks** `onRotate` - fires when devices is rotated (also fires initially) `onError` - fires when devices is in the wrong orientation (fires initially if its in wrong orientation) --- _Source: https://npm.io/package/orient-device · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._