capacitor-screen-orientation

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #machine-learning #rust #linux #docker #windows #awesome #kubernetes #awesome-list #ios #openai

capacitor-screen-orientation

(★ 27)

⚡️ Capacitor plugin to lock/unlock the screen orientation.

capacitor-screen-orientation Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## ⚠️ Deprecated repository

**This project has been moved to the following monorepo: [capawesome-team/capacitor-plugins](https://github.com/capawesome-team/capacitor-plugins).**

-----

<img src="https://avatars.githubusercontent.com/u/105555861" width="128" height="128" />
<h3 align="center">Screen Orientation</h3>
<code>@capawesome/capacitor-screen-orientation</code>

 Capacitor plugin to lock/unlock the screen orientation.

## Maintainers

| Maintainer | GitHub                                    | Social                                        |
| ---------- | ----------------------------------------- | --------------------------------------------- |
| Robin Genz | [robingenz](https://github.com/robingenz) | [@robin_genz](https://twitter.com/robin_genz) |

## Sponsors

This is an MIT-licensed open source project. 
It can grow thanks to the support by these awesome people. 
If you'd like to join them, please read more [here](https://github.com/sponsors/capawesome-team).

## Installation

```bash
npm install @capawesome/capacitor-screen-orientation
npx cap sync
```

### iOS

On iOS you must add the following to your app's `AppDelegate.swift`:

```diff
+ import CapawesomeCapacitorScreenOrientation

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

+ func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
+   return ScreenOrientation.getSupportedInterfaceOrientations()
+ }
```

## Configuration

No configuration required for this plugin.

## Demo

A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)

## Usage

```typescript
import { ScreenOrientation, OrientationType } from '@capawesome/capacitor-screen-orientation';

const lock = async () => {
  await ScreenOrientation.lock({ type: OrientationType.LANDSCAPE });
};

const unlock = async () => {
  await ScreenOrientation.unlock();
};

const getCurrentOrientation = async () => {
  const result = await ScreenOrientation.getCurrentOrientation();
  return result.type;
};
```

## API

<docgen-index>

* [`lock(...)`](#lock)
* [`unlock()`](#unlock)
* [`getCurrentOrientation()`](#getcurrentorientation)
* [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
* [Enums](#enums)

</docgen-index>

<docgen-api>

### lock(...)

```typescript
lock(options: LockOptions) => Promise<void>
```

Locks the device orientation.

| Param | Type |
| ------------- | --------------------------------------------------- |
| **`options`** | <code><a href="#lockoptions">LockOptions</a></code> |

--------------------

### unlock()

```typescript
unlock() => Promise<void>
```

Unlocks the device orientation.

--------------------

### getCurrentOrientation()

```typescript
getCurrentOrientation() => Promise<GetCurrentOrientationResult>
```

Gets the current device orientation type.

**Returns:** <code>Promise&lt;<a href="#getcurrentorientationresult">GetCurrentOrientationResult</a>&gt;</code>

--------------------

### addListener('screenOrientationChange', ...)

```typescript
addListener(eventName: 'screenOrientationChange', listenerFunc: ScreenOrientationChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for screen orientation changes.

| Param | Type |
| ------------------ | ------------------------------------------------------------------------------------------- |
| **`eventName`** | <code>'screenOrientationChange'</code> |
| **`listenerFunc`** | <code><a href="#screenorientationchangelistener">ScreenOrientationChangeListener</a></code> |

**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

--------------------

### removeAllListeners()

```typescript
removeAllListeners() => Promise<void>
```

Remove all listeners for this plugin.

--------------------

### Interfaces

#### LockOptions

| Prop | Type | Description |
| ---------- | ----------------------------------------------------------- | -------------------------- |
| **`type`** | <code><a href="#orientationtype">OrientationType</a></code> | The orientation lock type. |

#### GetCurrentOrientationResult

| Prop | Type | Description |
| ---------- | ----------------------------------------------------------- | ----------------------------- |
| **`type`** | <code><a href="#orientationtype">OrientationType</a></code> | The current orientation type. |

#### PluginListenerHandle

| Prop | Type |
| ------------ | ----------------------------------------- |
| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |

#### ScreenOrientationChange

### Type Aliases

#### ScreenOrientationChangeListener

Callback to receive the screen orientation change notifications.

<code>(change: <a href="#screenorientationchange">ScreenOrientationChange</a>): void</code>

### Enums

#### OrientationType

| Members | Value | Description |
| ------------------------- | ---------------------------------- | ------------------------------------------------------------------- |
| **`LANDSCAPE`** | <code>'landscape'</code> | The orientation is either landscape-primary or landscape-secondary. |
| **`LANDSCAPE_PRIMARY`** | <code>'landscape-primary'</code> | The orientation is in the primary landscape mode. |
| **`LANDSCAPE_SECONDARY`** | <code>'landscape-secondary'</code> | The orientation is in the secondary landscape mode. |
| **`PORTRAIT`** | <code>'portrait'</code> | The orientation is either portrait-primary or portrait-secondary. |
| **`PORTRAIT_PRIMARY`** | <code>'portrait-primary'</code> | The orientation is in the primary portrait mode. |
| **`PORTRAIT_SECONDARY`** | <code>'portrait-secondary'</code> | The orientation is in the secondary portrait mode. |

</docgen-api>

## Changelog

See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-screen-orientation/blob/master/CHANGELOG.md).

## License

See [LICENSE](https://github.com/capawesome-team/capacitor-screen-orientation/blob/master/LICENSE).

capacitor-screen-orientation

capacitor-screen-orientation Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

capacitor-screen-orientation

capacitor-screen-orientation Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README