Inizia

Installare

bun add @capgo/capacitor-screen-orientation
bunx cap sync

Importazione

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

API Panoramica

orientation

Ottieni l'orientamento attuale della schermata.

Restituisce l'orientamento attuale della schermata del dispositivo.

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

const result = await ScreenOrientation.orientation();
console.log('Current orientation:', result.type);

lock

Blocca l'orientamento della schermata a un tipo specifico.

Blocca la schermata all'orientamento specificato. Su iOS, se bypassOrientationLock è true, inizierà anche a tracciare l'orientamento fisico del dispositivo utilizzando i sensori di movimento.

Nota: l'interfaccia utente rispetterà comunque la impostazione di blocco dell'orientamento dell'utente. Il rilevamento del movimento consente di rilevare come il dispositivo è fisicamente tenuto e anche quando l'interfaccia utente non si gira.

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

// Standard lock
await ScreenOrientation.lock({ orientation: 'landscape' });

// Lock with motion tracking on iOS
await ScreenOrientation.lock({
  orientation: 'portrait',
  bypassOrientationLock: true
});

unlock

Sblocca l'orientamento dello schermo.

Consente allo schermo di ruotare liberamente in base alla posizione del dispositivo. Inoltre, ferma qualsiasi tracciamento di orientamento basato sul movimento se era abilitato.

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

await ScreenOrientation.unlock();

startOrientationTracking

Avvia il tracciamento dell'orientamento del dispositivo utilizzando i sensori di movimento.

Questo metodo è utile quando si desidera tracciare l'orientamento fisico del dispositivo indipendentemente dall'impostazione di blocco dell'orientamento dello schermo. Utilizza Core Motion su iOS per rilevare i cambiamenti di orientamento.

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

await ScreenOrientation.startOrientationTracking({
  bypassOrientationLock: true
});

// Listen for changes
ScreenOrientation.addListener('screenOrientationChange', (result) => {
  console.log('Orientation changed:', result.type);
});

stopOrientationTracking

Ferma il tracciamento dell'orientamento del dispositivo utilizzando i sensori di movimento.

Sospende il rilevamento dell'orientamento basato sulla movenza se era stato avviato.

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked

Controlla se il blocco dell'orientamento del dispositivo è attualmente abilitato.

Questa funzione confronta l'orientamento fisico del dispositivo (dai sensori di movenza) con l'orientamento dell'interfaccia utente. Se differiscono, il blocco dell'orientamento è abilitato.

Nota: Questo richiede il rilevamento della movenza attivo tramite startOrientationTracking() o lock() con bypassOrientationLock: true. Funziona su entrambi iOS (Core Motion) e Android (Accelerometro).

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

// Start motion tracking first
await ScreenOrientation.startOrientationTracking({
  bypassOrientationLock: true
});

// Check lock status
const status = await ScreenOrientation.isOrientationLocked();
if (status.locked) {
  console.log('Orientation lock is ON');
  console.log('Physical:', status.physicalOrientation);
  console.log('UI:', status.uiOrientation);
}

Riferimento di tipo

ScreenOrientationResult

Risultato restituito dalla funzione orientation().

export interface ScreenOrientationResult {
  /**
   * The current orientation type.
   *
   * @since 1.0.0
   */
  type: OrientationType;
}

OrientationLockOptions

Opzioni per bloccare l'orientamento dello schermo.

export interface OrientationLockOptions {
  /**
   * The orientation type to lock to.
   *
   * @since 1.0.0
   */
  orientation: OrientationLockType;

  /**
   * Whether to track physical device orientation using motion sensors.
   * When true, uses device motion sensors to detect the true physical
   * orientation of the device, even when the device orientation lock is enabled.
   *
   * **Important:** This does NOT bypass the UI orientation lock.
   * The screen will still respect the user's orientation lock setting.
   * This option only affects orientation detection/tracking - you'll receive
   * orientation change events based on how the device is physically held,
   * but the UI will not rotate if orientation lock is enabled.
   *
   * Supported on iOS (Core Motion) and Android (Accelerometer).
   *
   * @default false
   * @since 1.0.0
   */
  bypassOrientationLock?: boolean;
}

StartOrientationTrackingOptions

Opzioni per avviare la tracciatura dell'orientamento utilizzando i sensori di movimento.

export interface StartOrientationTrackingOptions {
  /**
   * Whether to track physical device orientation using motion sensors.
   * When true, uses device motion sensors to detect the true physical
   * orientation of the device, even when the device orientation lock is enabled.
   *
   * **Important:** This does NOT bypass the UI orientation lock.
   * This only enables detection of the physical orientation.
   *
   * Supported on iOS (Core Motion) and Android (Accelerometer).
   *
   * @default false
   * @since 1.0.0
   */
  bypassOrientationLock?: boolean;
}

OrientationLockStatusResult

Risultato restituito dal metodo isOrientationLocked().

export interface OrientationLockStatusResult {
  /**
   * Whether the device orientation lock is currently enabled.
   *
   * This is determined by comparing the physical device orientation
   * (from motion sensors) with the UI orientation. If they differ,
   * orientation lock is enabled.
   *
   * Available on iOS (Core Motion) and Android (Accelerometer) when motion tracking is active.
   *
   * @since 1.0.0
   */
  locked: boolean;

  /**
   * The physical orientation of the device from motion sensors.
   * Available when motion tracking is active (iOS and Android).
   *
   * @since 1.0.0
   */
  physicalOrientation?: OrientationType;

  /**
   * The current UI orientation reported by the system.
   *
   * @since 1.0.0
   */
  uiOrientation: OrientationType;
}

OrientationType

Tipo di orientamento che descrive lo stato di orientamento del dispositivo.

export type OrientationType = 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';

OrientationLockType

Tipo di blocco dell'orientamento che può essere utilizzato per bloccare l'orientamento del dispositivo.

export type OrientationLockType =
  | 'any'
  | 'natural'
  | 'landscape'
  | 'portrait'
  | 'portrait-primary'
  | 'portrait-secondary'
  | 'landscape-primary'
  | 'landscape-secondary';

Fonte di verità

Questa pagina è generata dal plugin's src/definitions.tsRiepiloga quando le informazioni pubbliche API cambiano in modo upstream.