Orientation de l'écran Plugin Capacitor

Utiliser @capgo/capacitor-screen-orientation

Interface du plugin Screen Orientation de Capacitor.

Installer

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

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode	Description
orientation	Récupérer l'orientation actuelle de l'écran.
lock	Verrouiller l'orientation de l'écran sur un type spécifique.
unlock	Déverrouiller l'orientation de l'écran.
startOrientationTracking	Commencez à suivre l’orientation de l’appareil à l’aide des capteurs de mouvement.
stopOrientationTracking	Arrêtez de suivre l’orientation de l’appareil à l’aide des capteurs de mouvement.
isOrientationLocked	Vérifie si le verrouillage de l’orientation de l’appareil est activé.
isDeviceFoldable	Écouter les changements d’orientation de l’écran.
getFoldState	Lire le pli actuel.
getHingeAngle	Lire l’angle de la charnière en degrés.
getReservedRegions	Lire le pli et tout élément couvrant l’écran.
getBarPlacement	Découvrez où iPhone Duo place les barres d’onglets et les barres d’outils natives.
setVerticalBarBehavior	Choisir si iPhone Duo peut déplacer les barres de cette app sur le côté.
getSizeClass	Lire les classes de taille de fenêtre.

Exemples

orientation()

Récupérer l'orientation actuelle de l'écran.

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

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

lock()

Verrouiller l'orientation de l'écran sur un type spécifique.

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

Déverrouiller l'orientation de l'écran.

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

await ScreenOrientation.unlock();

startOrientationTracking()

Commencez à suivre l’orientation de l’appareil à l’aide des capteurs de mouvement.

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

Arrêtez de suivre l’orientation de l’appareil à l’aide des capteurs de mouvement.

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

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked()

Vérifie si le verrouillage de l’orientation de l’appareil est activé.

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

Le tableau ci-dessus liste les 13 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou ScreenOrientation.removeAllListeners() pour supprimer tous les listeners.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer depuis « Utiliser @capgo/capacitor-screen-orientation »

Si vous utilisez Utiliser @capgo/capacitor-screen-orientation pour planifier le comportement des médias et de l'interface natifs, connectez-l’à @capgo/capacitor-screen-orientation pour les détails d'implémentation dans @capgo/capacitor-screen-orientation, Prise en main pour les détails d'implémentation dans Getting Started Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour les détails d'implémentation dans @capgo/capacitor-live-activities, et Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans Utilisation de @capgo/capacitor-video-player.