Orientación de pantalla plugin Capacitor

Uso de @capgo/capacitor-screen-orientation

Interfaz del plugin Capacitor Screen Orientation.

Instalar

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

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

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

API de un vistazo

Método	Descripción
orientation	Obtén la orientación actual de la pantalla.
lock	Bloquea la orientación de la pantalla a un tipo específico.
unlock	Desbloquea la orientación de la pantalla.
startOrientationTracking	Empieza a rastrear la orientación del dispositivo con los sensores de movimiento.
stopOrientationTracking	Deja de rastrear la orientación del dispositivo mediante sensores de movimiento.
isOrientationLocked	Comprueba si el bloqueo de orientación del dispositivo está activado actualmente.
isDeviceFoldable	Escucha los cambios de orientación de la pantalla.
getFoldState	Consulta el pliegue actual.
getHingeAngle	Consulta el ángulo de la bisagra en grados.
getReservedRegions	Consulta el pliegue y cualquier cosa que cubra la pantalla.
getBarPlacement	Consulta dónde coloca iPhone Duo las tab bars y toolbars nativas.
setVerticalBarBehavior	Elige si iPhone Duo puede mover las barras de esta app al lateral.
getSizeClass	Lee las clases de tamaño de ventana.

Ejemplos

orientation()

Obtén la orientación actual de la pantalla.

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

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

lock()

Bloquea la orientación de la pantalla a un tipo específico.

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()

Desbloquea la orientación de la pantalla.

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

await ScreenOrientation.unlock();

startOrientationTracking()

Empieza a rastrear la orientación del dispositivo con los sensores de movimiento.

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()

Deja de rastrear la orientación del dispositivo mediante sensores de movimiento.

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

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked()

Comprueba si el bloqueo de orientación del dispositivo está activado actualmente.

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);
}

La tabla anterior enumera los 13 métodos principales. Los helpers de versión y listener, así como el contrato completo de cada método, están documentados en la repositorio GitHub.

Escuchar eventos

addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonte, o ScreenOrientation.removeAllListeners() para limpiar todos los listeners.

Referencia completa

• repositorio GitHub
• Documentación
• Referencia de API

Continuar desde el uso de @capgo/capacitor-screen-orientation

Si estás usando Uso de @capgo/capacitor-screen-orientation para planificar el comportamiento de los medios nativos y la interfaz, conéctalo con @capgo/capacitor-screen-orientation para el detalle de implementación en @capgo/capacitor-screen-orientation, Primeros pasos para los detalles de implementación en Primeros pasos, Uso de @capgo/capacitor-live-activities para la capacidad nativa en Uso de @capgo/capacitor-live-activities, @capgo/capacitor-live-activities para el detalle de implementación en @capgo/capacitor-live-activities, y Uso de @capgo/capacitor-video-player para la capacidad nativa en Uso de @capgo/capacitor-video-player.