capacitor-flash

Turn the device flashlight on and off from your Capacitor app, with brightness control where the hardware allows it.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-flash in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-flash to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• On and off: switchOn({}), switchOff() and toggle().
• Intensity: pass intensity to switchOn() on supported devices.
• State: isSwitchedOn() reports whether the torch is on.
• Availability: isAvailable() checks for a flashlight first.
• Platforms: iOS, Android and Web. iOS uses AVFoundation, Android uses Camera2. Web uses the camera torch where the browser allows it.

Why Capacitor Flash?

A simple, free, and lightweight flashlight control plugin:

• Intensity control - Adjust brightness levels (iOS and Android 13+)
• Status checking - Query flashlight availability and current state
• Toggle support - Simple on/off switching with toggle method
• Universal compatibility - Works across iOS, Android, and web (Chrome on mobile devices)
• Modern package management - Supports both Swift Package Manager (SPM) and CocoaPods (SPM-ready for Capacitor 8)
• Zero dependencies - Minimal footprint, no bloat

Perfect for QR scanner apps, emergency torch features, camera apps, and utility tools.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/flash/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-flash` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-flash
npx cap sync

iOS

Works out of the box

Android

Works out of the box. No permissions are required since the CameraManager.setTorchMode() API (introduced in Android 6.0) does not require camera permission.

Optionally, you can declare the flash hardware feature in your AndroidManifest.xml:

<uses-feature android:name="android.hardware.camera.flash" android:required="false" />

Web

Works in Chrome and Chromium-based browsers on mobile devices. Uses the MediaDevices API with torch constraint. Call isAvailable() first to check if torch control is supported on the current browser/device.

API

• isAvailable()
• switchOn(...)
• switchOff()
• isSwitchedOn()
• toggle()
• getPluginVersion()

Capacitor Flash Plugin for controlling device flashlight/torch.

isAvailable()

isAvailable() => Promise<{ value: boolean; }>

Checks if flashlight is available on the device.

Returns: Promise<{ value: boolean; }>

Since: 1.0.0

switchOn(...)

switchOn(options: { intensity?: number; }) => Promise<void>

Turns the flashlight on.

Since: 1.0.0

switchOff()

switchOff() => Promise<void>

Turns the flashlight off.

Since: 1.0.0

isSwitchedOn()

isSwitchedOn() => Promise<{ value: boolean; }>

Checks if the flashlight is currently turned on or off.

Returns: Promise<{ value: boolean; }>

Since: 1.0.0

toggle()

toggle() => Promise<{ value: boolean; }>

Toggle the flashlight on or off.

Returns: Promise<{ value: boolean; }>

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0