Aller au contenu principal
@capgo/capacitor-brightness API de l'appareil Open source

Luminosité Plugin Capacitor

Pilotez la luminosité de l'écran par code, avec un contrôle propre à l'app ou au système entier

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 Brightness dans Capacitor

Tester sur l'appareil

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

QR de l'aperçu du plugin Brightness code

Utiliser @capgo/capacitor-brightness

Contrôlez la luminosité 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. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode Description
getBrightness Récupérer le niveau de luminosité actuel de l’écran principal de l’appareil.
setBrightness Définir le niveau de luminosité de l’écran principal de l’appareil.
getSystemBrightness Récupérer la luminosité système de l'écran.
setSystemBrightness Réglez la luminosité de l'écran à l'échelle du système. Nécessite la permission WRITE_SETTINGS sur Android. Cela passe aussi le mode de luminosité à MANUAL.
getSystemBrightnessMode Récupérez le mode de luminosité actuel du système (automatique ou manuel). Nécessite la permission WRITE_SETTINGS sur Android.
setSystemBrightnessMode Réglez le mode de luminosité du système (automatique ou manuel). Nécessite la permission WRITE_SETTINGS sur Android.
isUsingSystemBrightness Vérifiez si l'activité actuelle utilise la valeur de luminosité système.
restoreSystemBrightness Réinitialisez le réglage de luminosité de l'activité actuelle pour utiliser la valeur système.
isAvailable Vérifiez si Brightness API est disponible sur l'appareil actuel.
checkPermissions Vérifier les autorisations de l’utilisateur pour accéder à la luminosité système.
requestPermissions Demander les autorisations pour accéder à la luminosité système. Sur Android, cela ouvre les paramètres système pour accorder l’autorisation WRITE_SETTINGS.

Exemples

getBrightness()

Récupérer le niveau de luminosité actuel de l'écran principal de l'appareil.

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

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

setBrightness()

Définir le niveau de luminosité de l'écran principal de l'appareil.

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

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

getSystemBrightness()

Récupérer la luminosité système de l'écran.

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

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

setSystemBrightness()

Réglez la luminosité de l'écran à l'échelle du système. Nécessite la permission WRITE_SETTINGS sur Android. Cela passe aussi le mode de luminosité à MANUAL.

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

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

getSystemBrightnessMode()

Récupérez le mode de luminosité actuel du système (automatique ou manuel). Nécessite la permission WRITE_SETTINGS sur Android.

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

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

setSystemBrightnessMode()

Réglez le mode de luminosité du système (automatique ou manuel). Nécessite la permission WRITE_SETTINGS sur Android.

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

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

Le tableau ci-dessus liste les 11 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Référence complète

Continuer depuis « Utiliser @capgo/capacitor-brightness »

Si vous utilisez Utiliser @capgo/capacitor-brightness pour planifier le comportement des médias et de l'interface natifs, connectez-l’à @capgo/capacitor-brightness pour les détails d’implémentation dans @capgo/capacitor-brightness, Prise en main pour les détails d'implémentation dans Getting Started Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour les détails d'implémentation dans @capgo/capacitor-live-activities, et Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans Utilisation de @capgo/capacitor-video-player.

FAQ

FAQ du plugin Brightness

Comment installer le plugin Brightness dans une application Capacitor ?

Exécutez « bun add @capgo/capacitor-brightness » (ou « npm install @capgo/capacitor-brightness »), puis « bunx cap sync » pour que les projets iOS et Android récupèrent le code natif code. Importez-le depuis « @capgo/capacitor-brightness » dans le code de votre application code.

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

Oui. Brightness est un package Capacitor, il fonctionne donc avec n’importe quel framework web exécuté dans Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor prend en charge @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 le plugin v8 avec Capacitor 8). Le tableau de compatibilité du README de GitHub recense 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 depuis npm. Les signalements de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code qui utilise Brightness sans passer par une revue de l’App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez les modifications Brightness sans attendre la revue de l’app

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo