Expo ScreenOrientationA universal library for managing a device's screen orientation.
Screen Orientation is defined as the orientation in which graphics are painted on the device. For example, the figure below has a device in a vertical and horizontal physical orientation, but a portrait screen orientation. For physical device orientation, see the orientation section of Device Motion.
On both Android and iOS platforms, changes to the screen orientation will override any system settings or user preferences. On Android, it is possible to change the screen orientation while taking the user's preferred orientation into account. On iOS, user and system settings are not accessible by the application and any changes to the screen orientation will override existing settings.
Web has limited support.
Installation
- npx expo install expo-screen-orientationIf you are installing this in an existing React Native app, start by installing expo in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.
Warning
Apple added support for split view mode to iPads in iOS 9. This changed how the screen orientation is handled by the system. To put the matter shortly, for iOS, your iPad is always in landscape mode unless you open two applications side by side. To be able to lock screen orientation using this module you will need to disable support for this feature. For more information about the split view mode, check out the official Apple documentation.
Configuration in app.json/app.config.js
You can configure expo-screen-orientation using its built-in config plugin if you use config plugins in your project (EAS Build or npx expo run:[android|ios]). The plugin allows you to configure various properties that cannot be set at runtime and require building a new app binary to take effect.
Are you using this library in a bare React Native app?
- Open the ios directory in Xcode with
xed ios. If you don't have the directory, runnpx expo prebuild -p iosto generate one. - Tick the
Requires Full Screencheckbox in Xcode. It should be located under Project Target > General > Deployment Info.
Example app.json with config plugin
{
"expo": {
"ios": {
"requireFullScreen": true
},
"plugins": [
[
"expo-screen-orientation",
{
"initialOrientation": "DEFAULT"
}
]
]
}
}
Configurable properties
| Name | Default | Description |
|---|---|---|
initialOrientation | undefined | Only for: iOS Sets the iOS initial screen orientation. Possible values: |
API
import * as ScreenOrientation from 'expo-screen-orientation';
Methods
Gets the current screen orientation.
Promise<Orientation>Returns a promise that fulfils with an Orientation
value that reflects the current screen orientation.
Gets the current screen orientation lock type.
Promise<OrientationLock>Returns a promise which fulfils with an OrientationLock
value.
Gets the platform specific screen orientation lock type.
Promise<PlatformOrientationInfo>Returns a promise which fulfils with a PlatformOrientationInfo
value.
| Parameter | Type | Description |
|---|---|---|
| orientationLock | OrientationLock | The orientation lock to apply. See the |
Lock the screen orientation to a particular OrientationLock.
Promise<void>Returns a promise with void value, which fulfils when the orientation is set.
Example
async function changeScreenOrientation() {
await ScreenOrientation.lockAsync(ScreenOrientation.OrientationLock.LANDSCAPE_LEFT);
}
| Parameter | Type | Description |
|---|---|---|
| options | PlatformOrientationInfo | The platform specific lock to apply. See the |
Promise<void>Returns a promise with void value, resolving when the orientation is set and rejecting
if an invalid option or value is passed.
| Parameter | Type |
|---|---|
| orientationLock | OrientationLock |
Returns whether the OrientationLock policy is supported on
the device.
Promise<boolean>Returns a promise that resolves to a boolean value that reflects whether or not the
orientationLock is supported.
Sets the screen orientation back to the OrientationLock.DEFAULT policy.
Promise<void>Returns a promise with void value, which fulfils when the orientation is set.
Event Subscriptions
| Parameter | Type | Description |
|---|---|---|
| listener | OrientationChangeListener | Each orientation update will pass an object with the new |
Invokes the listener function when the screen orientation changes from portrait to landscape
or from landscape to portrait. For example, it won't be invoked when screen orientation
change from portrait up to portrait down, but it will be called when there was a change from
portrait up to landscape left.
EventSubscription| Parameter | Type | Description |
|---|---|---|
| subscription | EventSubscription | A subscription object that manages the updates passed to a listener function on an orientation change. |
Unsubscribes the listener associated with the Subscription object from all orientation change
updates.
voidRemoves all listeners subscribed to orientation change updates.
voidTypes
| Property | Type | Description |
|---|---|---|
| orientationInfo | ScreenOrientationInfo | The current |
| orientationLock | OrientationLock | The current |
| Property | Type | Description |
|---|---|---|
| screenOrientationArrayIOS(optional) | Orientation[] | Only for: iOS An array of orientations to allow on the iOS platform. |
| screenOrientationConstantAndroid(optional) | number | Only for: Android A constant to set using the Android native API.
For example, in order to set the lock policy to unspecified,
|
| screenOrientationLockWeb(optional) | WebOrientationLock | Only for: Web A web orientation lock to apply in the browser. |
| Property | Type | Description |
|---|---|---|
| horizontalSizeClass(optional) | SizeClassIOS | Only for: iOS The horizontal size class of the device. |
| orientation | Orientation | The current orientation of the device. |
| verticalSizeClass(optional) | SizeClassIOS | Only for: iOS The vertical size class of the device. |
A subscription object that allows to conveniently remove an event listener from the emitter.
| Property | Type | Description |
|---|---|---|
| remove | () => void | Removes an event listener for which the subscription has been created. After calling this function, the listener will no longer receive any events from the emitter. |
Enums
Orientation.UNKNOWN ＝ 0An unknown screen orientation. For example, the device is flat, perhaps on a table.
An enum whose values can be passed to the lockAsync
method.
Note:
OrientationLock.ALLandOrientationLock.PORTRAITare invalid on devices which don't supportOrientationLock.PORTRAIT_DOWN.
OrientationLock.DEFAULT ＝ 0The default orientation. On iOS, this will allow all orientations except Orientation.PORTRAIT_DOWN.
On Android, this lets the system decide the best orientation.
OrientationLock.OTHER ＝ 8A platform specific orientation. This is not a valid policy that can be applied in lockAsync.
OrientationLock.UNKNOWN ＝ 9An unknown screen orientation lock. This is not a valid policy that can be applied in lockAsync.
Each iOS device has a default set of size classes that you can use as a guide when designing your interface.
An enum representing the lock policies that can be applied on the web platform, modelled after
the W3C specification.
These values can be applied through the lockPlatformAsync
method.