Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-flash
Tutorial
by github.com/Cap-go

Flash

Control device flashlight and torch with simple on/off toggle functionality

Downloads/week

55.6k

GitHub Stars

22

Guide

Tutorial on Flash

Using @capgo/capacitor-flash

Capacitor Flash Plugin for controlling device flashlight/torch.

Install

bun add @capgo/capacitor-flash
bunx cap sync

What This Plugin Exposes

  • isAvailable - Checks if flashlight is available on the device.
  • switchOn - Turns the flashlight on.
  • switchOff - Turns the flashlight off.
  • isSwitchedOn - Checks if the flashlight is currently turned on or off.

Example Usage

isAvailable

Checks if flashlight is available on the device.

import { CapacitorFlash } from '@capgo/capacitor-flash';

const { value } = await CapacitorFlash.isAvailable();
if (value) {
  console.log('Flashlight is available');
}

switchOn

Turns the flashlight on.

import { CapacitorFlash } from '@capgo/capacitor-flash';

// Turn on at full brightness
await CapacitorFlash.switchOn({ intensity: 1.0 });

// Turn on at half brightness
await CapacitorFlash.switchOn({ intensity: 0.5 });

switchOff

Turns the flashlight off.

import { CapacitorFlash } from '@capgo/capacitor-flash';

await CapacitorFlash.switchOff();

isSwitchedOn

Checks if the flashlight is currently turned on or off.

import { CapacitorFlash } from '@capgo/capacitor-flash';

const { value } = await CapacitorFlash.isSwitchedOn();
console.log('Flashlight is on:', value);

Full Reference

Keep going from Using @capgo/capacitor-flash

If you are using Using @capgo/capacitor-flash to plan dashboard and API operations, connect it with @capgo/capacitor-flash for the implementation detail in @capgo/capacitor-flash, Getting Started for the implementation detail in Getting Started, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, and API Keys for the implementation detail in API Keys.