Aller directement au contenu principal
@capgo/capacitor-éclairage APIs de dispositifs Source ouvert

Éclairage plugin Capacitor

Control device screen brightness programmatically with support for app-specific and system-wide control

Installer

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

Guide

Comment utiliser la luminosité dans Capacitor

Tester sur appareil

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

Prévisualisation du plugin de luminosité QR code

Utilisez @capgo/capacitor-éclairage

Contrôlez l'éclairage de l'écran sur iOS et Android.

Installer

bun add @capgo/capacitor-brightness
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 { CapgoBrightness } from '@capgo/capacitor-brightness';

API en un coup d'œil

Méthode Description
getBrightness Obtenez le niveau de luminosité actuel de l'écran principal du dispositif.
setBrightness Définissez le niveau de luminosité de l'écran principal du dispositif.
getSystemBrightness Obtenez la luminosité d'écran système.
setSystemBrightness Fixer l'éclairement d'écran système. Exige la permission WRITE_SETTINGS sur Android. Cela change également le mode d'éclairement en MANUEL.
getSystemBrightnessMode Obtenez le mode de luminosité système actuel (automatique ou manuel). Exige la permission d'écriture des paramètres sur Android.
setSystemBrightnessMode Définissez le mode de luminosité système (automatique ou manuel). Exige la permission d'écriture des paramètres sur Android.
isUsingSystemBrightness Vérifiez si l'activité actuelle utilise la valeur de luminosité de l'ensemble du système.
restoreSystemBrightness Réinitialisez la valeur de luminosité de l'activité actuelle pour qu'elle utilise la valeur système.
isAvailable Vérifiez si la fonctionnalité de luminosité API est disponible sur le dispositif actuel.
checkPermissions Vérifiez les permissions de l'utilisateur pour accéder à la luminosité de l'écran.
requestPermissions Demandez les autorisations pour accéder à la luminosité système. Sur Android, cela ouvre les paramètres système pour accorder la permission WRITE_SETTINGS.

Exemples

getBrightness()

Obtenez le niveau de luminosité actuel de l'écran principal du dispositif.

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

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

setBrightness()

Fixez le niveau de luminosité de l'écran principal du dispositif.

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

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

getSystemBrightness()

Obtenez la luminosité d'écran système.

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

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

setSystemBrightness()

Fixer l'éclairement de l'écran système. Exige la permission WRITE_SETTINGS sur Android. Cela change également le mode d'éclairement en MANUEL.

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

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

getSystemBrightnessMode()

Obtenez le mode de luminosité actuel du système (automatique ou manuel). Exigez la permission WRITE_SETTINGS sur Android.

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

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

setSystemBrightnessMode()

Fixez le mode de luminosité du système (automatique ou manuel). Exigez la permission WRITE_SETTINGS sur Android.

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

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

La table ci-dessus liste les 11 méthodes de base. Les helpers de listener et de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le répertoire GitHub.

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-brightness

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

FAQ

FAQ du plugin Brightness

Comment installer le plugin Brightness dans une application Capacitor ?

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

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

Oui. Le plugin Brightness est un package 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 pur.

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

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 fichier README du GitHub liste les versions maintenues.

Le plugin @capgo/capacitor-brightness est-il gratuit et open source ?

Oui. Le code source code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-brightness/ et le package 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 Brightness sans passer par une revue de l'App Store ?

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

Envoyez les modifications de luminosité sans attendre la revue des applications

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

Démarrer avec Capgo