@wuilmerj24/screen-orientation
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published
npm

@wuilmerj24/screen-orientation

npm install @wuilmerj24/screen-orientation

Use

API

Methods

Method Description
getOrientacion() Gets the current screen orientation.
setOrientacion(Orientacion) Change the screen orientation. Returns a Promise.

Supported orientation types

Orientation

Orientation Descriptions
ANY Orientation is unlocked: all orientations are supported.
PORTRAIT Change the screen rotation to PORTRAIT mode.
PORTRAIT_REVERSE Change the screen rotation to PORTRAIT_REVERSE mode.
LANDSCAPE Change the screen rotation to LANDSCAPE mode
LANDSCAPE_REVERSE Change the screen rotation to LANDSCAPE_REVERSE mode
UNSPECIFIED Does not change orientation.

Orientation types for Android only.

Orientation Description
PORTRAIT_SENSOR Change the screen rotation to PORTRAIT_SENSOR mode when the mobile is rotated in PORTRAIT or PORTRAIT by rotating the screen 180°.
LANDSCAPE_SENSOR Change the screen rotation to LANDSCAPE_SENSOR mode when the mobile is rotated in LANDSCAPE or LANDSCAPE by rotating the screen 270°.

Get the screen orientation

//Gets the current orientation in string format.
let orientacion = getOrientacion();

Change the screen orientation

//change the orientation;
setOrientacion(Orientacion.ANY).then((res:boolean)=>{
  console.log(res)
})

License

Apache License Version 2.0

Package Sidebar

Install

npm i @wuilmerj24/screen-orientation

Weekly Downloads

5

Version

1.0.2

License

Apache-2.0

Unpacked Size

27.7 kB

Total Files

15

Last publish

Collaborators

  • wuilmerj24