Allez directement au contenu principal
@capgo/capacitor-orientation-écran APIs de dispositifs Open source

Orientation de l'écran plugin Capacitor

Plugin d'orientation d'écran avec prise en charge de la contournement du verrouillage d'orientation

Installer

bun add @capgo/capacitor-screen-orientation bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-screen-orientation
  • pnpm add @capgo/capacitor-screen-orientation
  • yarn add @capgo/capacitor-screen-orientation

Guide

Comment utiliser l'orientation de l'écran dans Capacitor

Testez sur appareil

Téléchargez l'application Capgo, puis scannez le QR code.

Prévisualisation du plugin d'orientation d'écran QR code

Utilisation de @capgo/capacitor-screen-orientation

L'interface du plugin d'orientation d'écran 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. Exécutez-l’à nouveau après chaque mise à jour du plugin.

Importer

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

API en un coup d'œil

Méthode Description
orientation Obtenir l'orientation actuelle de l'écran.
lock Fixer l'orientation de l'écran sur un type spécifique.
unlock Déverrouillez l'orientation de l'écran.
startOrientationTracking Suivez l'orientation de votre appareil à l'aide de capteurs de mouvement.
stopOrientationTracking Arrêtez de suivre l'orientation du dispositif à l'aide de capteurs de mouvement.
isOrientationLocked Check if device orientation lock is currently enabled.
isDeviceFoldable Écoutez les changements d'orientation de l'écran.
getFoldState Lit la position actuelle de l'écran.
getHingeAngle Lit l'angle de la charnière en degrés.
getReservedRegions Lit la position de l'écran et tout ce qui le recouvre.
getBarPlacement Lisez où iPhone Duo place les barres de tabs et les outils natifs.
setVerticalBarBehavior Choisissez si iPhone Duo peut déplacer les barres de ce programme vers le côté.
getSizeClass Lit les classes de taille de la fenêtre.

Exemples

orientation()

Obtenez la position actuelle de l'écran.

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

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

lock()

Fixez la position de l'écran à 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ésactivez la position de l'écran.

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

await ScreenOrientation.unlock();

startOrientationTracking()

Suivez l'orientation du dispositif à l'aide de 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 du dispositif à l'aide de capteurs de mouvement.

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

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked()

Check if device orientation lock is currently enabled.

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 table ci-dessus liste les 13 méthodes de base. Les écouteurs et les assistants de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le GitHub dépôt.

Écoutez les événements

addListener retourne un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou ScreenOrientation.removeAllListeners() pour supprimer tous les écouteurs.

Référence complète

Continuez de l'étape précédente : Utilisation de @capgo/capacitor-orientation-écran

Si vous utilisez En utilisant @capgo/capacitor-orientation-écran pour planifier le comportement des médias et de l'interface native, connectez-l’avec @capgo/capacitor-orientation-écran pour les détails d'implémentation dans @capgo/capacitor-orientation-écran, Getting Started pour les détails d'implémentation dans Démarrage, En utilisant @capgo/capacitor-activités-en-vivre pour la capacité native dans En utilisant @capgo/capacitor-activités-en-vivre, @capgo/capacitor-activités-en-vivre pour les détails d'implémentation dans @capgo/capacitor-activités-en-vivre, et En utilisant @capgo/capacitor-joueur-de-videos pour la capacité native dans l'utilisation de @capgo/capacitor-video-player.

FAQ

FAQ du plugin d'orientation de l'écran

Comment installez-vous le plugin d'orientation de l'écran dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-screen-orientation » (ou « npm install @capgo/capacitor-screen-orientation »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en compte les natives code. Importez-l’à partir de « @capgo/capacitor-screen-orientation » dans votre application code.

Le @capgo/capacitor-screen-orientation fonctionne-t-il avec React, Vue et Angular?

Oui. L'orientation de l'écran est un paquet Capacitor, il fonctionne donc avec tout framework web qui s'exécute à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript simple.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-screen-orientation?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README du GitHub liste les versions maintenues.

Le @capgo/capacitor-screen-orientation est-il gratuit et open source?

Oui. Le code source code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-screen-orientation/ et le paquet est gratuit à installer à partir de npm. Les rapports de bogues et les demandes de modification sont les bienvenus.

Peut-on mettre à jour code qui utilise l'orientation de l'écran sans passer par une revue de l'App Store?

L'installation ou la mise à niveau du plugin modifie les natives code, il faut donc une nouvelle mise à jour de l'application. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être envoyées instantanément avec les mises à jour Capgo.

Expédiez les changements d'orientation d'écran sans attendre la revue de l'application

Une fois le plugin est dans votre magasin de build, Capgo les mises à jour en direct poussent vos modifications JavaScript, HTML et CSS vers les utilisateurs en quelques minutes.

Démarrez avec Capgo