Saltar al contenido principal
@capgo/capacitor-brightness API de dispositivos Código abierto

Brillo plugin Capacitor

Controla el brillo de la pantalla del dispositivo por código, con control específico por app y a nivel de sistema

Instalar

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

Guía

Cómo usar Brightness en Capacitor

Probar en el dispositivo

Descarga la app Capgo y escanea el QR code.

QR de vista previa del plugin Brightness code

Uso de @capgo/capacitor-brightness

Controla el brillo de la pantalla en iOS y Android.

Instalar

bun add @capgo/capacitor-brightness
bunx cap sync

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

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

API de un vistazo

Método Descripción
getBrightness Obtiene el nivel de brillo actual de la pantalla principal del dispositivo.
setBrightness Establece el nivel de brillo de la pantalla principal del dispositivo.
getSystemBrightness Obtén el brillo de pantalla de todo el sistema.
setSystemBrightness Ajusta el brillo de la pantalla en todo el sistema. Requiere el permiso WRITE_SETTINGS en Android. Esto también cambia el modo de brillo a MANUAL.
getSystemBrightnessMode Obtén el modo de brillo actual del sistema (automático o manual). Requiere el permiso WRITE_SETTINGS en Android.
setSystemBrightnessMode Establece el modo de brillo del sistema (automático o manual). Requiere el permiso WRITE_SETTINGS en Android.
isUsingSystemBrightness Comprueba si la actividad actual usa el valor de brillo del sistema.
restoreSystemBrightness Restablece el ajuste de brillo de la actividad actual al valor del sistema.
isAvailable Comprueba si el API de Brightness está disponible en el dispositivo actual.
checkPermissions Comprueba los permisos del usuario para acceder al brillo del sistema.
requestPermissions Solicita permisos para acceder al brillo del sistema. En Android, se abre la configuración del sistema para otorgar el permiso WRITE_SETTINGS.

Ejemplos

getBrightness()

Obtiene el nivel de brillo actual de la pantalla principal del dispositivo.

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

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

setBrightness()

Establece el nivel de brillo de la pantalla principal del dispositivo.

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

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

getSystemBrightness()

Obtén el brillo de pantalla de todo el sistema.

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

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

setSystemBrightness()

Ajusta el brillo de la pantalla en todo el sistema. Requiere el permiso WRITE_SETTINGS en Android. Esto también cambia el modo de brillo a MANUAL.

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

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

getSystemBrightnessMode()

Obtén el modo de brillo actual del sistema (automático o manual). Requiere el permiso WRITE_SETTINGS en Android.

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

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

setSystemBrightnessMode()

Establece el modo de brillo del sistema (automático o manual). Requiere el permiso WRITE_SETTINGS en Android.

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

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

La tabla anterior enumera los 11 métodos principales. Los helpers de listener y versión, así como el contrato completo de cada método, están documentados en la repositorio GitHub.

Referencia completa

Continúa desde Uso de @capgo/capacitor-brightness

Si estás usando Uso de @capgo/capacitor-brightness para planificar el comportamiento de los medios nativos y la interfaz, conéctalo con @capgo/capacitor-brightness para los detalles de implementación en @capgo/capacitor-brightness, Primeros pasos para los detalles de implementación en Primeros pasos, Uso de @capgo/capacitor-live-activities para la capacidad nativa en Uso de @capgo/capacitor-live-activities, @capgo/capacitor-live-activities para el detalle de implementación en @capgo/capacitor-live-activities, y Uso de @capgo/capacitor-video-player para la capacidad nativa en Uso de @capgo/capacitor-video-player.

FAQ

Preguntas frecuentes del plugin Brightness

¿Cómo instalo el plugin Brightness en una app de Capacitor?

Ejecuta "bun add @capgo/capacitor-brightness" (o "npm install @capgo/capacitor-brightness") y luego ejecuta "bunx cap sync" para que los proyectos de iOS y Android incorporen el code nativo. Impórtalo desde "@capgo/capacitor-brightness" en el code de tu app.

¿Funciona @capgo/capacitor-brightness con React, Vue y Angular?

Sí. Brightness es un paquete de Capacitor, así que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluidos Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor soporta @capgo/capacitor-brightness?

Los plugins de Capgo siguen la versión mayor de Capacitor: usa la versión mayor del plugin que coincida con la versión mayor de tu Capacitor (por ejemplo, el plugin v8 con Capacitor 8). La tabla de compatibilidad del README de GitHub lista las versiones mantenidas.

¿Es @capgo/capacitor-brightness gratuito y de código abierto?

Sí. El code fuente está disponible públicamente en GitHub en https://github.com/Cap-go/capacitor-brightness/ y el paquete se puede instalar gratis desde npm. Se agradecen los informes de errores y pull requests.

¿Puedo actualizar code que usa Brightness sin una revisión de la App Store?

Instalar o actualizar el plugin cambia el code nativo, así que requiere un nuevo build para la tienda. Después, los cambios de JavaScript, HTML y CSS que llamen al plugin se pueden publicar al instante con las live updates de Capgo.

Publica cambios de Brightness sin esperar la revisión de la app

Una vez que el plugin esté en tu store build, Capgo live updates envía tus cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Empieza con Capgo