Panduan Memulai
Salin prompt setup yang berisi langkah install dan panduan markdown lengkap untuk plugin ini.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-brightness`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/brightness/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsLalu gunakan prompt berikut:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-brightness` plugin in my project.Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:
bun add @capgo/capacitor-brightnessnpx cap syncimport { CapgoBrightness } from '@capgo/capacitor-brightness';Mulai cepat
Bagian berjudul “Mulai cepat”import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();console.log(result);Contoh: setBrightness
Bagian berjudul “Contoh: setBrightness”import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });Contoh: getSystemBrightness
Bagian berjudul “Contoh: getSystemBrightness”import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();console.log(result);Kesalahan umum
Bagian berjudul “Kesalahan umum”- Izin: panggil
checkPermissions()kemudianrequestPermissions()saat dibutuhkan. - Sinkronisasi Native: jalankan
npx cap syncsetelah upgrade plugin. - Sumber kebenaran tunggal: percayai
src/definitions.tsdi repo GitHub.
Ringkasan API
Bagian berjudul “Ikhtisar API”getBrightness
Bagian berjudul “getBrightness”Dapatkan level brightness layar utama perangkat saat ini.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();console.log(result);setBrightness
Bagian berjudul “setBrightness”Atur level brightness layar utama perangkat.
Di iOS, tingkat kecerahan akan tetap bertahan sampai perangkat terkunci. Di Android, tingkat kecerahan hanya berlaku untuk activity saat ini.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });getSystemBrightness
Bagian berjudul “getSystemBrightness”Dapatkan brightness layar tingkat sistem.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();console.log(result);setSystemBrightness
Bagian berjudul “setSystemBrightness”Atur kecerahan layar untuk seluruh sistem. Membutuhkan izin WRITE_SETTINGS di Android. Ini juga mengubah mode kecerahan ke MANUAL.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });getSystemBrightnessMode
Bagian berjudul “getSystemBrightnessMode”Dapatkan mode kecerahan sistem saat ini (otomatis atau manual). Membutuhkan izin WRITE_SETTINGS di Android.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightnessMode();console.log(result);setSystemBrightnessMode
Bagian berjudul “setSystemBrightnessMode”Atur mode kecerahan sistem (otomatis atau manual). Memerlukan izin WRITE_SETTINGS di Android.
import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });isUsingSystemBrightness
Bagian berjudul “isUsingSystemBrightness”Cek apakah activity saat ini memakai nilai brightness tingkat sistem.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isUsingSystemBrightness();console.log(result);restoreSystemBrightness
Bagian berjudul “restoreSystemBrightness”Reset pengaturan brightness pada activity saat ini agar memakai nilai tingkat sistem.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.restoreSystemBrightness();isAvailable
Bagian berjudul “isAvailable”Cek apakah Brightness API tersedia di perangkat saat ini.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isAvailable();console.log(result);checkPermissions
Bagian berjudul “checkPermissions”Cek izin pengguna untuk mengakses brightness sistem.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.checkPermissions();console.log(result);requestPermissions
Bagian berjudul “requestPermissions”Minta izin untuk mengakses kecerahan sistem. Di Android, ini membuka pengaturan sistem untuk memberikan izin WRITE_SETTINGS.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.requestPermissions();console.log(result);Referensi Tipe
Bagian berjudul “Referensi Tipe”GetBrightnessResult
Bagian berjudul “GetBrightnessResult”Hasil dari getBrightness atau getSystemBrightness.
export interface GetBrightnessResult { /** * The brightness value from 0 to 1. * 0 is the minimum brightness, 1 is the maximum brightness. * * @since 8.0.0 */ brightness: number;}SetBrightnessOptions
Bagian berjudul “SetBrightnessOptions”Opsi untuk setBrightness atau setSystemBrightness.
export interface SetBrightnessOptions { /** * The brightness value from 0 to 1. * 0 is the minimum brightness, 1 is the maximum brightness. * * @since 8.0.0 */ brightness: number;}GetBrightnessModeResult
Bagian berjudul “GetBrightnessModeResult”Hasil dari getSystemBrightnessMode.
export interface GetBrightnessModeResult { /** * The current brightness mode. * * @since 8.0.0 */ mode: BrightnessMode;}SetBrightnessModeOptions
Bagian berjudul “SetBrightnessModeOptions”Opsi untuk setSystemBrightnessMode.
export interface SetBrightnessModeOptions { /** * The brightness mode to set. * Cannot be set to UNKNOWN. * * @since 8.0.0 */ mode: BrightnessMode;}IsUsingSystemBrightnessResult
Bagian berjudul “IsUsingSystemBrightnessResult”Hasil dari isUsingSystemBrightness.
export interface IsUsingSystemBrightnessResult { /** * Whether the current activity is using the system-wide brightness value. * * @since 8.0.0 */ isUsing: boolean;}IsAvailableResult
Bagian berjudul “IsAvailableResult”Hasil dari isAvailable.
export interface IsAvailableResult { /** * Whether the Brightness API is available on the current device. * * @since 8.0.0 */ available: boolean;}PermissionStatus
Bagian berjudul “PermissionStatus”Hasil status izin.
export interface PermissionStatus { /** * Whether the permission to modify system brightness is granted. * * @since 8.0.0 */ brightness: PermissionState;}GetPluginVersionResult
Bagian berjudul “GetPluginVersionResult”Hasil getPluginVersion.
export interface GetPluginVersionResult { /** * The native plugin version. * * @since 8.0.0 */ version: string;}BrightnessMode
Bagian berjudul “BrightnessMode”Mode kecerahan.
export enum BrightnessMode { /** * The brightness mode is unknown. * * @since 8.0.0 */ UNKNOWN = 0, /** * The brightness is automatically adjusted by the system. * * @since 8.0.0 */ AUTOMATIC = 1, /** * The brightness is manually set by the user. * * @since 8.0.0 */ MANUAL = 2,}PermissionState
Bagian berjudul “PermissionState”Status izin.
export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';Sumber Kebenaran
Bagian berjudul “Sumber Kebenaran”Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.
Lanjutkan dari Getting Started
Bagian berjudul “Lanjutkan dari Getting Started”Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-brightness untuk kemampuan native di bagian Menggunakan @capgo/capacitor-brightness, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Devices.