Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Poi usa il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-brightness` plugin in my project.

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-brightness
npx cap sync

Importa

import { CapgoBrightness } from '@capgo/capacitor-brightness';

Avvio rapido

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getBrightness();
console.log(result);

Esempio: setBrightness

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setBrightness({ brightness: 0.5 });

Esempio: getSystemBrightness

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

Errori comuni

• Permessi: chiama checkPermissions() poi requestPermissions() quando necessario.
• Sync nativo: esegui npx cap sync dopo gli aggiornamenti dei plugin.
• Fonte di verità: fidati src/definitions.ts nel repo GitHub.

Panoramica API

getBrightness

Ottieni il livello di luminosità attuale dello schermo principale del dispositivo.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getBrightness();
console.log(result);

setBrightness

Imposta il livello di luminosità dello schermo principale del dispositivo.

Su iOS, la luminosità persisterà finché il dispositivo non viene bloccato. Su Android, la luminosità si applica solo all'attività corrente.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setBrightness({ brightness: 0.5 });

getSystemBrightness

Ottieni la luminosità dello schermo a livello di sistema.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

setSystemBrightness

Imposta la luminosità dello schermo a livello di sistema. Richiede il permesso WRITE_SETTINGS su Android. Questo imposta anche la modalità luminosità su MANUAL.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

getSystemBrightnessMode

Ottieni la modalità di luminosità di sistema attuale (automatico o manuale). Richiede il permesso WRITE_SETTINGS su Android.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);

setSystemBrightnessMode

Imposta la modalità di luminosità di sistema (automatica o manuale). Richiede il permesso WRITE_SETTINGS su Android.

import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';

await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

isUsingSystemBrightness

Verifica se l'activity corrente sta utilizzando il valore di luminosità di sistema.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.isUsingSystemBrightness();
console.log(result);

restoreSystemBrightness

Ripristina l'impostazione di luminosità dell'activity corrente usando il valore di sistema.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.restoreSystemBrightness();

isAvailable

Verifica se il API Brightness è disponibile sul dispositivo corrente.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.isAvailable();
console.log(result);

checkPermissions

Verifica i permessi dell'utente per accedere alla luminosità di sistema.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.checkPermissions();
console.log(result);

requestPermissions

Richiede i permessi per accedere alla luminosità di sistema. Su Android, questo apre le impostazioni di sistema per concedere il permesso WRITE_SETTINGS.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.requestPermissions();
console.log(result);

Riferimento ai tipi

GetBrightnessResult

Risultato di getBrightness o 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

Opzioni per setBrightness o 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

Risultato di getSystemBrightnessMode.

export interface GetBrightnessModeResult {
  /**
   * The current brightness mode.
   *
   * @since 8.0.0
   */
  mode: BrightnessMode;
}

SetBrightnessModeOptions

Opzioni per setSystemBrightnessMode.

export interface SetBrightnessModeOptions {
  /**
   * The brightness mode to set.
   * Cannot be set to UNKNOWN.
   *
   * @since 8.0.0
   */
  mode: BrightnessMode;
}

IsUsingSystemBrightnessResult

Risultato di isUsingSystemBrightness.

export interface IsUsingSystemBrightnessResult {
  /**
   * Whether the current activity is using the system-wide brightness value.
   *
   * @since 8.0.0
   */
  isUsing: boolean;
}

IsAvailableResult

Risultato di isAvailable.

export interface IsAvailableResult {
  /**
   * Whether the Brightness API is available on the current device.
   *
   * @since 8.0.0
   */
  available: boolean;
}

PermissionStatus

Risultato dello stato dei permessi.

export interface PermissionStatus {
  /**
   * Whether the permission to modify system brightness is granted.
   *
   * @since 8.0.0
   */
  brightness: PermissionState;
}

GetPluginVersionResult

Risultato di getPluginVersion.

export interface GetPluginVersionResult {
  /**
   * The native plugin version.
   *
   * @since 8.0.0
   */
  version: string;
}

BrightnessMode

La modalità di luminosità.

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

Stato dei permessi.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-brightness per la funzionalità nativa usando @capgo/capacitor-brightness, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.