快速入门
复制包含安装步骤和该插件完整 Markdown 指南的配置 prompt。
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.
安装
“安装”章节你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下 prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-brightness` plugin in my project.如果你更想手动设置,请运行以下命令安装插件,并按照下方各平台的说明操作:
bun add @capgo/capacitor-brightnessnpx cap sync导入
“导入”章节import { CapgoBrightness } from '@capgo/capacitor-brightness';快速入门
章节标题为“快速入门”import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();console.log(result);示例:setBrightness
标题为“示例:setBrightness”的章节import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });示例:getSystemBrightness
标题为“示例:getSystemBrightness”的章节import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();console.log(result);常见坑点
章节标题为“常见陷阱”- 权限: 调用
checkPermissions()然后requestPermissions()在需要时。 - 原生同步:运行
npx cap sync在插件升级后。 - 唯一可信来源:信任
src/definitions.ts在 GitHub 仓库中。
API 概览
章节标题:“API 概览”getBrightness
标题为“getBrightness”的章节获取设备主屏幕当前的亮度值。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();console.log(result);setBrightness
标题为“setBrightness”的章节设置设备主屏幕的亮度值。
在 iOS 上,亮度会一直保持,直到设备锁定。 在 Android 上,亮度只对当前 Activity 生效。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });getSystemBrightness
标题为 “getSystemBrightness” 的章节获取系统全局屏幕亮度。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();console.log(result);setSystemBrightness
标题为 “setSystemBrightness” 的章节设置系统全局屏幕亮度。 在 Android 上需要 WRITE_SETTINGS 权限。 这还会将亮度模式改为 MANUAL。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });getSystemBrightnessMode
标题为 “getSystemBrightnessMode” 的章节获取当前系统亮度模式(自动或手动)。 在 Android 上需要 WRITE_SETTINGS 权限。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightnessMode();console.log(result);setSystemBrightnessMode
标题为 “setSystemBrightnessMode” 的章节设置系统亮度模式(自动或手动)。 在 Android 上需要 WRITE_SETTINGS 权限。
import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });isUsingSystemBrightness
标题为 “isUsingSystemBrightness” 的章节检查当前 Activity 是否正在使用系统全局亮度值。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isUsingSystemBrightness();console.log(result);restoreSystemBrightness
标题为 “restoreSystemBrightness” 的章节将当前 Activity 的亮度设置重置为使用系统全局值。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.restoreSystemBrightness();isAvailable
标题为 “isAvailable” 的章节检查 Brightness API 是否在当前设备上可用。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isAvailable();console.log(result);checkPermissions
“checkPermissions” 章节检查用户访问系统亮度的权限。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.checkPermissions();console.log(result);requestPermissions
“requestPermissions” 章节请求访问系统亮度的权限。 在 Android 上,这会打开系统设置以授予 WRITE_SETTINGS 权限。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.requestPermissions();console.log(result);类型参考
“类型参考” 章节GetBrightnessResult
标题为“GetBrightnessResult”的章节getBrightness 或 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
标题为“SetBrightnessOptions”的章节setBrightness 或 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
标题为“GetBrightnessModeResult”的章节getSystemBrightnessMode 的结果。
export interface GetBrightnessModeResult { /** * The current brightness mode. * * @since 8.0.0 */ mode: BrightnessMode;}SetBrightnessModeOptions
标题为“SetBrightnessModeOptions”的章节setSystemBrightnessMode 的选项。
export interface SetBrightnessModeOptions { /** * The brightness mode to set. * Cannot be set to UNKNOWN. * * @since 8.0.0 */ mode: BrightnessMode;}IsUsingSystemBrightnessResult
标题为“IsUsingSystemBrightnessResult”的章节isUsingSystemBrightness 的结果。
export interface IsUsingSystemBrightnessResult { /** * Whether the current activity is using the system-wide brightness value. * * @since 8.0.0 */ isUsing: boolean;}IsAvailableResult
标题为“IsAvailableResult”的章节isAvailable 的结果。
export interface IsAvailableResult { /** * Whether the Brightness API is available on the current device. * * @since 8.0.0 */ available: boolean;}PermissionStatus
标题为“PermissionStatus”的章节权限状态结果。
export interface PermissionStatus { /** * Whether the permission to modify system brightness is granted. * * @since 8.0.0 */ brightness: PermissionState;}GetPluginVersionResult
“GetPluginVersionResult” 章节getPluginVersion 的结果。
export interface GetPluginVersionResult { /** * The native plugin version. * * @since 8.0.0 */ version: string;}BrightnessMode
标题为“BrightnessMode”的章节亮度模式。
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
“PermissionState” 章节权限状态。
export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';单一事实来源
标题为“单一事实来源”的部分本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时,请重新运行 sync。
从入门指南继续
“从入门指南继续”章节如果你正在使用 快速入门 要规划 dashboard 和 API 操作,请将其连接到 使用 @capgo/capacitor-brightness 在“使用 @capgo/capacitor-brightness”中的原生功能 API 概览 关于 API Overview 中的实现细节, 简介 关于 Introduction 中的实现细节, API 密钥 有关 API Keys 的实现细节,以及 设备 有关 Devices 的实现细节。