Primeros pasos
Copia un prompt de configuración con los pasos de instalación y la guía completa en markdown para este plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-brightness`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/brightness/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Instalar
Sección titulada “Instalación”Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsLuego usa el siguiente prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-brightness` plugin in my project.Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:
bun add @capgo/capacitor-brightnessnpx cap syncImportar
Sección titulada “Importar”import { CapgoBrightness } from '@capgo/capacitor-brightness';Inicio rápido
Sección titulada “Inicio rápido”import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();console.log(result);Ejemplo: setBrightness
Sección titulada “Ejemplo: setBrightness”import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });Ejemplo: getSystemBrightness
Sección titulada “Ejemplo: getSystemBrightness”import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();console.log(result);Errores comunes
Sección titulada “Errores comunes”- Permisos: llama a
checkPermissions()luegorequestPermissions()cuando sea necesario. - Sync nativo: ejecuta
npx cap synctras actualizar los plugins. - Fuente de verdad: confianza
src/definitions.tsen el repo de GitHub.
Resumen de API
Sección titulada “Resumen de API”getBrightness
Sección titulada “getBrightness”Obtén 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
Sección titulada “setBrightness”Establece el nivel de brillo de la pantalla principal del dispositivo.
En iOS, el brillo se mantendrá hasta que se bloquee el dispositivo. En Android, el brillo solo se aplica a la actividad actual.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });getSystemBrightness
Sección titulada “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
Sección titulada “setSystemBrightness”Establece el brillo de la pantalla a nivel de sistema. Requiere el permiso WRITE_SETTINGS en Android. También cambia el modo de brillo a MANUAL.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });getSystemBrightnessMode
Sección titulada “getSystemBrightnessMode”Obtiene el modo de brillo del sistema actual (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
Sección titulada “setSystemBrightnessMode”Configura 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 });isUsingSystemBrightness
Sección titulada “isUsingSystemBrightness”Comprueba si la actividad actual usa el valor de brillo del sistema.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isUsingSystemBrightness();console.log(result);restoreSystemBrightness
Sección titulada “restoreSystemBrightness”Restablece el ajuste de brillo de la actividad actual al valor del sistema.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.restoreSystemBrightness();isAvailable
Sección titulada “isAvailable”Comprueba si el API de Brightness está disponible en el dispositivo actual.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isAvailable();console.log(result);checkPermissions
Sección titulada “checkPermissions”Comprueba los permisos del usuario para acceder al brillo del sistema.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.checkPermissions();console.log(result);requestPermissions
Sección titulada “requestPermissions”Solicita permisos para acceder al brillo del sistema. En Android, esto abre la configuración del sistema para otorgar el permiso WRITE_SETTINGS.
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.requestPermissions();console.log(result);Referencia de tipos
Sección titulada “Referencia de tipos”GetBrightnessResult
Sección titulada “GetBrightnessResult”Resultado de 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
Sección titulada “SetBrightnessOptions”Opciones para 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
Sección titulada “GetBrightnessModeResult”Resultado de getSystemBrightnessMode.
export interface GetBrightnessModeResult { /** * The current brightness mode. * * @since 8.0.0 */ mode: BrightnessMode;}SetBrightnessModeOptions
Sección titulada “SetBrightnessModeOptions”Opciones para setSystemBrightnessMode.
export interface SetBrightnessModeOptions { /** * The brightness mode to set. * Cannot be set to UNKNOWN. * * @since 8.0.0 */ mode: BrightnessMode;}IsUsingSystemBrightnessResult
Sección titulada “IsUsingSystemBrightnessResult”Resultado de isUsingSystemBrightness.
export interface IsUsingSystemBrightnessResult { /** * Whether the current activity is using the system-wide brightness value. * * @since 8.0.0 */ isUsing: boolean;}IsAvailableResult
Sección titulada “IsAvailableResult”Resultado de isAvailable.
export interface IsAvailableResult { /** * Whether the Brightness API is available on the current device. * * @since 8.0.0 */ available: boolean;}PermissionStatus
Sección titulada “PermissionStatus”Resultado del estado del permiso.
export interface PermissionStatus { /** * Whether the permission to modify system brightness is granted. * * @since 8.0.0 */ brightness: PermissionState;}GetPluginVersionResult
Sección titulada “GetPluginVersionResult”Resultado de getPluginVersion.
export interface GetPluginVersionResult { /** * The native plugin version. * * @since 8.0.0 */ version: string;}BrightnessMode
Sección titulada “BrightnessMode”El modo de brillo.
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
Sección titulada “PermissionState”Estado del permiso.
export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';Fuente de verdad
Sección titulada “Fuente de verdad”Esta página se genera a partir del plugin src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en upstream.
Continúa desde Getting Started
Sección titulada “Continúa desde Primeros pasos”Si estás usando Primeros pasos para planificar las operaciones del dashboard y de API, conéctalo con Uso de @capgo/capacitor-brightness para la capacidad nativa en Uso de @capgo/capacitor-brightness, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en la Introducción, Claves de API para los detalles de implementación en las claves de API, y Dispositivos para el detalle de implementación en Devices.