Pasar al contenido principal
@capgo/capacitor-brillo Dispositivos de API Fuente abierta

Brillo plugin de Capacitor

Controla la luminosidad de pantalla del dispositivo de manera programática con soporte para control de aplicaciones específicas y control 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 la Iluminación en Capacitor

Probar en dispositivo

Descargue la aplicación Capgo y escane el código QR code.

Vista previa del plugin de brillo QR code

Usando @capgo/capacitor-brillo

Controla la intensidad 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 después de cada actualización del plugin.

Importar

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

Vista general de API

Metodo Descripción
getBrightness Obtenga el nivel de brillo actual de la pantalla principal del dispositivo.
setBrightness Establezca el nivel de brillo de la pantalla principal del dispositivo.
getSystemBrightness Obtenga el brillo de pantalla del sistema.
setSystemBrightness Establecer la intensidad de pantalla del sistema. Requiere permiso WRITE_SETTINGS en Android. Esto también cambia el modo de intensidad a MANUAL.
getSystemBrightnessMode Obtenga el modo de brillo del sistema actual (automático o manual). Requiere permiso WRITE_SETTINGS en Android.
setSystemBrightnessMode Establecer el modo de brillo del sistema (automático o manual). Requiere permiso WRITE_SETTINGS en Android.
isUsingSystemBrightness Verifique si la actividad actual está utilizando el valor de brillo del sistema.
restoreSystemBrightness Restablezca la configuración de brillo de la actividad actual para utilizar el valor del sistema.
isAvailable Verifique si el API de brillo está disponible en el dispositivo actual.
checkPermissions Verifique las permisos del usuario para acceder al brillo del sistema.
requestPermissions Solicite permisos para acceder al brillo del sistema. En Android, esto abre la configuración del sistema para conceder permiso de escritura de configuración.

Ejemplos

getBrightness()

Obtenga 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()

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

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

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

getSystemBrightness()

Obtenga el brillo de pantalla del sistema.

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

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

setSystemBrightness()

Establecer la luminosidad de pantalla del sistema. Requiere permiso WRITE_SETTINGS en Android. También cambia el modo de luminosidad a MANUAL.

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

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

getSystemBrightnessMode()

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

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

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

setSystemBrightnessMode()

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

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

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

La tabla anterior muestra los 11 métodos básicos. Los ayudantes de escucha y versión, y la documentación completa de cada método, se encuentran en el repositorio GitHub.

Referencia completa

Continuar desde Using @capgo/capacitor-brightness

Si estás utilizando Usando @capgo/capacitor-brillo Para planificar el comportamiento de medios y interfaz nativa, conecta con @capgo/capacitor-brillo para el detalle de implementación en @capgo/capacitor-brightness Getting Started para el detalle de implementación en Getting Started Usando @capgo/capacitor-actividades-en-vivo para la capacidad nativa en Using @capgo/capacitor-live-activities @capgo/capacitor-actividades en vivo para el detalle de implementación en @capgo/capacitor-actividades-en-vivo, y Usando @capgo/capacitor-reproductor-de-videos para la capacidad nativa en Usando @capgo/capacitor-reproductor-de-videos.

FAQ

Preguntas Frecuentes del plugin de brillo

¿Cómo instalo el plugin de brillo en una aplicación Capacitor?

Ejecuta "bun add @capgo/capacitor-brillo" (o "npm install @capgo/capacitor-brillo"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el code nativo. Importa desde "@capgo/capacitor-brillo" en tu aplicación code.

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

Sí. El plugin de brillo es un paquete Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

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

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

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

Sí. El código code es público en GitHub en https://github.com/Cap-go/capacitor-brillo/ y el paquete es gratuito para instalar desde npm. Se aceptan informes de errores y solicitudes de cambios.

¿Puedo actualizar code que utiliza Brillo sin una revisión de la Tienda de Aplicaciones?

Instalar o actualizar el plugin cambia el code nativo, por lo que necesita una nueva construcción de la tienda. Después de eso, los cambios de JavaScript, HTML y CSS que llaman al plugin pueden enviar directamente con Capgo actualizaciones en vivo.

Envíe cambios de brillo sin esperar a la revisión de la aplicación

Una vez que el plugin esté en tu tienda de construcción, Capgo actualizaciones en vivo envían cambios en JavaScript, HTML y CSS a los usuarios en minutos.

Inicie con Capgo