Langsung ke konten utama
@capgo/capacitor-screen-orientation API Perangkat Open source

Orientasi Layar plugin Capacitor

Plugin orientasi layar yang mendukung bypass orientation lock

Instal

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

Panduan

Cara menggunakan Screen Orientation di Capacitor

Tes di perangkat

Download aplikasi Capgo, lalu scan QR code.

QR code pratinjau plugin Screen Orientation

Menggunakan @capgo/capacitor-screen-orientation

Antarmuka Capacitor Screen Orientation Plugin.

Instal

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

bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.

Impor

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

Sekilas tentang API

Metode Deskripsi
orientation Dapatkan orientasi layar saat ini.
lock Kunci orientasi layar ke tipe tertentu.
unlock Buka kunci orientasi layar.
startOrientationTracking Mulai melacak orientasi perangkat menggunakan sensor gerak.
stopOrientationTracking Berhenti melacak orientasi perangkat menggunakan sensor gerak.
isOrientationLocked Cek apakah kunci orientasi perangkat sedang aktif.
isDeviceFoldable Pantau perubahan orientasi layar.
getFoldState Baca lipatan saat ini.
getHingeAngle Baca sudut engsel dalam derajat.
getReservedRegions Baca lipatan dan apa pun yang menutupi layar.
getBarPlacement Baca posisi tab bar dan toolbar native di iPhone Duo.
setVerticalBarBehavior Pilih apakah iPhone Duo boleh memindahkan bar aplikasi ini ke samping.
getSizeClass Baca window size classes.

Contoh

orientation()

Dapatkan orientasi layar saat ini.

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

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

lock()

Kunci orientasi layar ke tipe tertentu.

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

Buka kunci orientasi layar.

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

await ScreenOrientation.unlock();

startOrientationTracking()

Mulai melacak orientasi perangkat menggunakan sensor gerak.

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

Berhenti melacak orientasi perangkat menggunakan sensor gerak.

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

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked()

Cek apakah kunci orientasi perangkat sedang aktif.

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

Tabel di atas mencantumkan 13 metode inti. Helper listener, versi, dan kontrak lengkap dari setiap metode didokumentasikan di repositori GitHub.

Mendengarkan event

addListener mengembalikan sebuah handle. Panggil handle.remove() saat layar di-unmount, atau ScreenOrientation.removeAllListeners() untuk menghapus semua listener.

Referensi lengkap

Lanjutkan dari Menggunakan @capgo/capacitor-screen-orientation

Jika Anda menggunakan Menggunakan @capgo/capacitor-screen-orientation untuk merencanakan perilaku media dan antarmuka native, hubungkan dengan @capgo/capacitor-screen-orientation untuk detail implementasi di @capgo/capacitor-screen-orientation, Panduan Memulai untuk detail implementasi di Getting Started, Menggunakan @capgo/capacitor-live-activities untuk kemampuan native di Menggunakan @capgo/capacitor-live-activities, @capgo/capacitor-live-activities untuk detail implementasi di @capgo/capacitor-live-activities, dan Menggunakan @capgo/capacitor-video-player untuk kapabilitas native saat menggunakan @capgo/capacitor-video-player.

FAQ

FAQ plugin Screen Orientation

Bagaimana cara menginstal plugin Screen Orientation di aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-screen-orientation" (atau "npm install @capgo/capacitor-screen-orientation"), lalu jalankan "bunx cap sync" agar proyek iOS dan Android mendeteksi code native. Impor dari "@capgo/capacitor-screen-orientation" di dalam code aplikasi Anda.

Apakah @capgo/capacitor-screen-orientation mendukung React, Vue, dan Angular?

Ya. Screen Orientation adalah paket Capacitor, jadi bisa digunakan dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript murni.

Versi Capacitor mana yang didukung oleh @capgo/capacitor-screen-orientation?

Plugin Capgo mengikuti versi mayor Capacitor: gunakan versi mayor plugin yang sesuai dengan versi mayor Capacitor Anda (contoh: plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub mencantumkan versi yang masih di-maintain.

Apakah @capgo/capacitor-screen-orientation gratis dan open source?

Ya. Source code tersedia secara publik di GitHub pada https://github.com/Cap-go/capacitor-screen-orientation/ dan paketnya gratis untuk diinstal dari npm. Laporan bug dan pull request sangat kami terima.

Bisakah saya memperbarui code yang menggunakan Screen Orientation tanpa melalui review App Store?

Instalasi atau upgrade plugin akan mengubah native code, jadi butuh build store baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin bisa langsung dikirim lewat live updates Capgo.

Rilis perubahan Screen Orientation tanpa menunggu review aplikasi

Setelah plugin ada di build store Anda, live updates Capgo akan mengirim perubahan JavaScript, HTML, dan CSS ke pengguna dalam hitungan menit.

Mulai dengan Capgo