capacitor-plugins

Original🇺🇸 English
Translated

Guides the agent through installing, configuring, and using Capacitor plugins from four sources — official Capacitor plugins, Capawesome plugins, Capacitor Firebase plugins, and Capacitor MLKit plugins. Covers installation, platform-specific configuration (Android and iOS), and basic usage examples. Do not use for migrating Capacitor apps or plugins to a newer version, setting up Capacitor Live Updates, or non-Capacitor mobile frameworks.

2installs
Added on

NPX Install

npx skill4agent add capawesome-team/skills capacitor-plugins

Capacitor Plugins

Install, configure, and use Capacitor plugins from official and community sources.

Prerequisites

  1. Capacitor 6, 7, or 8 app.
  2. Node.js and npm installed.
  3. For iOS plugins: Xcode installed. CocoaPods or Swift Package Manager (SPM) for dependency management.
  4. For Android plugins: Android Studio installed.

Agent Behavior

  • Guide step-by-step. Walk the user through the process one step at a time. Never present multiple unrelated questions at once.
  • Auto-detect before asking. Check the project for platforms (
    android/
    ,
    ios/
    ), build tools (
    vite.config.ts
    ,
    angular.json
    ,
    webpack.config.js
    ), framework, existing npm registry config, and
    package.json
    dependencies. Only ask the user when something cannot be detected.
  • One decision at a time. When a step requires user input (e.g., encryption yes/no), ask that single question, wait for the answer, then continue to the next step.
  • Present clear options. When asking a question, provide concrete choices (e.g., "Do you need SQLite encryption? (yes/no)") instead of open-ended questions.

Procedures

Step 1: Identify the Plugin

Match the user's request to a plugin from the index below. If the match is ambiguous, ask the user to clarify.

Step 2: Read the Reference File

Read the corresponding reference file from
references/
for the matched plugin.

Step 3: Analyze the Project

Auto-detect the following by reading project files — do not ask the user for information that can be inferred:
  1. Platforms: Check which directories exist (
    android/
    ,
    ios/
    ). These are the platforms to configure.
  2. Build tool / framework: Check for
    vite.config.ts
    ,
    angular.json
    ,
    webpack.config.js
    ,
    next.config.js
    , etc.
  3. iOS dependency manager: Check if
    ios/App/Podfile
    exists (CocoaPods) or if SPM is used.
  4. Capacitor version: Read
    @capacitor/core
    version from
    package.json
    .

Step 4: Set Up Prerequisites

If the plugin requires Capawesome Insiders (the reference file states
Capawesome Insiders: Yes
):
  1. Check if the
    @capawesome-team
    npm registry is already configured by running:
    npm config get @capawesome-team:registry
  2. If the registry is not configured, tell the user this plugin requires a Capawesome Insiders license and guide them through the setup:
    bash
    npm config set @capawesome-team:registry https://npm.registry.capawesome.io
    npm config set //npm.registry.capawesome.io/:_authToken <YOUR_LICENSE_KEY>
    Ask the user for their license key if needed. Wait for confirmation before continuing.
  3. If the registry is already configured, skip this and move on.

Step 5: Install the Plugin

Run the installation command from the reference file:
bash
npm install <package-name>
npx cap sync
If the reference file lists additional packages (e.g.,
@sqlite.org/sqlite-wasm
), include them.

Step 6: Apply Platform-Specific Configuration

For each platform detected in Step 3, apply the configuration from the reference file.
When the reference file offers variants or optional features for a platform (e.g., encryption vs. plain, bundled SQLite vs. default), handle them one at a time:
  1. Present the choice to the user with a clear question and options.
  2. Wait for the user's answer.
  3. Apply only the chosen configuration.
  4. Move on to the next platform or decision point.
Typical configuration includes:
  • Android: Gradle variables in
    variables.gradle
    , permissions in
    AndroidManifest.xml
    , meta-data entries, ProGuard rules
  • iOS:
    Info.plist
    entries, Podfile or SPM changes,
    AppDelegate.swift
    modifications
Skip platforms that don't exist in the project.

Step 7: Apply Web Configuration (if applicable)

If the reference file includes a Web configuration section and the project targets the web:
  1. Apply the configuration matching the detected build tool (Vite, Webpack, Angular CLI, etc.).
  2. If the build tool is not covered by the reference file, adapt the configuration to the detected build tool and inform the user.

Step 8: Add Usage Code

Ask the user if they want usage code added to the project. If yes:
  1. Add the usage code from the reference file.
  2. Adapt imports, method calls, and options to match the user's project structure and requirements.

Step 9: Sync the Project

bash
npx cap sync

Plugin Index

Official Capacitor Plugins

PluginPackageReference
Action Sheet
@capacitor/action-sheet
references/capacitor-action-sheet.md
App
@capacitor/app
references/capacitor-app.md
App Launcher
@capacitor/app-launcher
references/capacitor-app-launcher.md
Background Runner
@capacitor/background-runner
references/capacitor-background-runner.md
Barcode Scanner
@capacitor/barcode-scanner
references/capacitor-barcode-scanner.md
Browser
@capacitor/browser
references/capacitor-browser.md
Camera
@capacitor/camera
references/capacitor-camera.md
Clipboard
@capacitor/clipboard
references/capacitor-clipboard.md
Cookies
@capacitor/core
(bundled)
references/capacitor-cookies.md
Device
@capacitor/device
references/capacitor-device.md
Dialog
@capacitor/dialog
references/capacitor-dialog.md
File Transfer
@capacitor/file-transfer
references/capacitor-file-transfer.md
File Viewer
@capacitor/file-viewer
references/capacitor-file-viewer.md
Filesystem
@capacitor/filesystem
references/capacitor-filesystem.md
Geolocation
@capacitor/geolocation
references/capacitor-geolocation.md
Google Maps
@capacitor/google-maps
references/capacitor-google-maps.md
Haptics
@capacitor/haptics
references/capacitor-haptics.md
Http
@capacitor/core
(bundled)
references/capacitor-http.md
InAppBrowser
@capacitor/inappbrowser
references/capacitor-inappbrowser.md
Keyboard
@capacitor/keyboard
references/capacitor-keyboard.md
Local Notifications
@capacitor/local-notifications
references/capacitor-local-notifications.md
Motion
@capacitor/motion
references/capacitor-motion.md
Network
@capacitor/network
references/capacitor-network.md
Preferences
@capacitor/preferences
references/capacitor-preferences.md
Privacy Screen
@capacitor/privacy-screen
references/capacitor-privacy-screen.md
Push Notifications
@capacitor/push-notifications
references/capacitor-push-notifications.md
Screen Orientation
@capacitor/screen-orientation
references/capacitor-screen-orientation.md
Screen Reader
@capacitor/screen-reader
references/capacitor-screen-reader.md
Share
@capacitor/share
references/capacitor-share.md
Splash Screen
@capacitor/splash-screen
references/capacitor-splash-screen.md
Status Bar
@capacitor/status-bar
references/capacitor-status-bar.md
System Bars
@capacitor/core
(bundled)
references/capacitor-system-bars.md
Text Zoom
@capacitor/text-zoom
references/capacitor-text-zoom.md
Toast
@capacitor/toast
references/capacitor-toast.md
Watch
@capacitor/watch
references/capacitor-watch.md

Capawesome Plugins

PluginPackageReference
Accelerometer
@capawesome-team/capacitor-accelerometer
references/capawesome-accelerometer.md
Age Signals
@capawesome/capacitor-age-signals
references/capawesome-age-signals.md
Android Battery Optimization
@capawesome-team/capacitor-android-battery-optimization
references/capawesome-android-battery-optimization.md
Android Dark Mode Support
@capawesome/capacitor-android-dark-mode-support
references/capawesome-android-dark-mode-support.md
Android Edge-to-Edge Support
@capawesome/capacitor-android-edge-to-edge-support
references/capawesome-android-edge-to-edge-support.md
Android Foreground Service
@capawesome-team/capacitor-android-foreground-service
references/capawesome-android-foreground-service.md
App Review
@capawesome/capacitor-app-review
references/capawesome-app-review.md
App Shortcuts
@capawesome/capacitor-app-shortcuts
references/capawesome-app-shortcuts.md
App Update
@capawesome/capacitor-app-update
references/capawesome-app-update.md
Apple Sign In
@capawesome/capacitor-apple-sign-in
references/capawesome-apple-sign-in.md
Asset Manager
@capawesome/capacitor-asset-manager
references/capawesome-asset-manager.md
Audio Player
@capawesome-team/capacitor-audio-player
references/capawesome-audio-player.md
Audio Recorder
@capawesome-team/capacitor-audio-recorder
references/capawesome-audio-recorder.md
Background Task
@capawesome/capacitor-background-task
references/capawesome-background-task.md
Badge
@capawesome/capacitor-badge
references/capawesome-badge.md
Barometer
@capawesome-team/capacitor-barometer
references/capawesome-barometer.md
Biometrics
@capawesome-team/capacitor-biometrics
references/capawesome-biometrics.md
Bluetooth Low Energy
@capawesome-team/capacitor-bluetooth-low-energy
references/capawesome-bluetooth-low-energy.md
Cloudinary
@capawesome/capacitor-cloudinary
references/capawesome-cloudinary.md
Contacts
@capawesome-team/capacitor-contacts
references/capawesome-contacts.md
Datetime Picker
@capawesome-team/capacitor-datetime-picker
references/capawesome-datetime-picker.md
File Compressor
@capawesome-team/capacitor-file-compressor
references/capawesome-file-compressor.md
File Opener
@capawesome-team/capacitor-file-opener
references/capawesome-file-opener.md
File Picker
@capawesome/capacitor-file-picker
references/capawesome-file-picker.md
Geocoder
@capawesome-team/capacitor-geocoder
references/capawesome-geocoder.md
Google Sign In
@capawesome/capacitor-google-sign-in
references/capawesome-google-sign-in.md
libSQL
@capawesome/capacitor-libsql
references/capawesome-libsql.md
Live Update
@capawesome/capacitor-live-update
references/capawesome-live-update.md
Managed Configurations
@capawesome/capacitor-managed-configurations
references/capawesome-managed-configurations.md
Media Session
@capawesome-team/capacitor-media-session
references/capawesome-media-session.md
NFC
@capawesome-team/capacitor-nfc
references/capawesome-nfc.md
OAuth
@capawesome-team/capacitor-oauth
references/capawesome-oauth.md
Pedometer
@capawesome-team/capacitor-pedometer
references/capawesome-pedometer.md
Photo Editor
@capawesome/capacitor-photo-editor
references/capawesome-photo-editor.md
PostHog
@capawesome/capacitor-posthog
references/capawesome-posthog.md
Printer
@capawesome-team/capacitor-printer
references/capawesome-printer.md
Purchases
@capawesome-team/capacitor-purchases
references/capawesome-purchases.md
RealtimeKit
@capawesome/capacitor-realtimekit
references/capawesome-realtimekit.md
Screen Orientation
@capawesome/capacitor-screen-orientation
references/capawesome-screen-orientation.md
Screenshot
@capawesome/capacitor-screenshot
references/capawesome-screenshot.md
Secure Preferences
@capawesome-team/capacitor-secure-preferences
references/capawesome-secure-preferences.md
Share Target
@capawesome-team/capacitor-share-target
references/capawesome-share-target.md
Speech Recognition
@capawesome-team/capacitor-speech-recognition
references/capawesome-speech-recognition.md
Speech Synthesis
@capawesome-team/capacitor-speech-synthesis
references/capawesome-speech-synthesis.md
SQLite
@capawesome-team/capacitor-sqlite
references/capawesome-sqlite.md
Square Mobile Payments
@capawesome/capacitor-square-mobile-payments
references/capawesome-square-mobile-payments.md
Superwall
@capawesome/capacitor-superwall
references/capawesome-superwall.md
Torch
@capawesome/capacitor-torch
references/capawesome-torch.md
Wi-Fi
@capawesome-team/capacitor-wifi
references/capawesome-wifi.md
Zip
@capawesome-team/capacitor-zip
references/capawesome-zip.md

Capacitor Firebase Plugins

PluginPackageReference
Analytics
@capacitor-firebase/analytics
references/firebase-analytics.md
App
@capacitor-firebase/app
references/firebase-app.md
App Check
@capacitor-firebase/app-check
references/firebase-app-check.md
Authentication
@capacitor-firebase/authentication
references/firebase-authentication.md
Crashlytics
@capacitor-firebase/crashlytics
references/firebase-crashlytics.md
Firestore
@capacitor-firebase/firestore
references/firebase-firestore.md
Functions
@capacitor-firebase/functions
references/firebase-functions.md
Messaging
@capacitor-firebase/messaging
references/firebase-messaging.md
Performance
@capacitor-firebase/performance
references/firebase-performance.md
Remote Config
@capacitor-firebase/remote-config
references/firebase-remote-config.md
Storage
@capacitor-firebase/storage
references/firebase-storage.md

Capacitor MLKit Plugins

PluginPackageReference
Barcode Scanning
@capacitor-mlkit/barcode-scanning
references/mlkit-barcode-scanning.md
Face Detection
@capacitor-mlkit/face-detection
references/mlkit-face-detection.md
Face Mesh Detection
@capacitor-mlkit/face-mesh-detection
references/mlkit-face-mesh-detection.md
Selfie Segmentation
@capacitor-mlkit/selfie-segmentation
references/mlkit-selfie-segmentation.md
Subject Segmentation
@capacitor-mlkit/subject-segmentation
references/mlkit-subject-segmentation.md
Translation
@capacitor-mlkit/translation
references/mlkit-translation.md

Error Handling

  • Installation fails: Verify the package name is correct and the plugin version is compatible with the project's Capacitor version. Check
    @capacitor/core
    version in
    package.json
    .
  • npx cap sync
    fails
    : Ensure all native dependencies are installed. On iOS with CocoaPods, run
    cd ios/App && pod install
    . On Android, sync Gradle files.
  • Android build fails: Check that required Gradle variables are set in
    variables.gradle
    . Verify permissions are added to
    AndroidManifest.xml
    .
  • iOS build fails: Check that required
    Info.plist
    entries are present. Verify the deployment target meets the plugin's minimum requirement.
  • Plugin not found at runtime: Ensure
    npx cap sync
    was run after installation. For iOS, verify the dependency was installed (pod for CocoaPods, package for SPM). For Android, verify the Gradle sync completed.
  • Permission denied at runtime: Check that permissions are declared in platform config files AND requested at runtime via
    checkPermissions()
    /
    requestPermissions()
    where applicable.