Prise en main
Prêt à copier un prompt de configuration avec les étapes d'installation et la guide Markdown complète pour ce plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these packages:
- `@capacitor-plus/core`
- `@capacitor-plus/cli`
- `@capacitor-plus/android` if the project targets Android
- `@capacitor-plus/ios` if the project targets iOS
Complete the required Capacitor initialization, platform, sync, native setup, and configuration work.
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/capacitor-plus/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.
Installation de Nouveau Projet
Installation de nouveau projetVous pouvez utiliser notre configuration assistée par l'IA pour installer Capacitor+. Ajoutez les compétences Capgo à votre outil IA à l'aide de la commande suivante :
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsColler dans le presse-papier
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capacitor-plus/core`, `@capacitor-plus/cli`, `@capacitor-plus/android`, and `@capacitor-plus/ios` packages in my project.Si vous préférez la configuration manuelle, installez les packages en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :
-
Installer les packages de base
Fenêtre de terminal npm install @capacitor-plus/core @capacitor-plus/cli -
Ajouter les packages de plateforme
Fenêtre de terminal npm install @capacitor-plus/android # for Androidnpm install @capacitor-plus/ios # for iOS -
Initialiser Capacitor
Fenêtre de terminal npx cap initFenêtre de terminal pnpm cap initFenêtre de terminal yarn cap initFenêtre de terminal bunx cap init -
Ajouter des plateformes
Fenêtre de terminal npx cap add androidFenêtre de terminal pnpm cap add androidFenêtre de terminal yarn cap add androidFenêtre de terminal bunx cap add androidFenêtre de terminal npx cap add iosFenêtre de terminal pnpm cap add iosFenêtre de terminal yarn cap add iosFenêtre de terminal bunx cap add ios
Migrer depuis l'official Capacitor
Section intitulée “Migrer depuis l'official Capacitor”Si vous avez un projet existant Capacitor, la migration vers Capacitor+ est simple :
-
Supprimer les packages officiels
Fenêtre de terminal npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Installez les packages Capacitor+
Fenêtre de terminal npm install @capacitor-plus/core @capacitor-plus/clinpm install @capacitor-plus/android # if using Androidnpm install @capacitor-plus/ios # if using iOS -
Synchronisez votre projet
Fenêtre de terminal npx cap syncFenêtre de terminal pnpm cap syncFenêtre de terminal yarn cap syncFenêtre de terminal bunx cap sync
Utilisation
Section intitulée « Utilisation »Depuis Capacitor+ est API-compatible, vos code existants fonctionnent sans modifications :
import { Capacitor } from '@capacitor/core';import { registerPlugin } from '@capacitor/core';
// Check platformconst platform = Capacitor.getPlatform();console.log('Running on:', platform);
// Check if nativeif (Capacitor.isNativePlatform()) { console.log('Running on native platform');}
// Register a custom pluginconst MyPlugin = registerPlugin('MyPlugin');Avec les Plugins officiels Capacitor
Section intitulée « Avec les Plugins officiels Capacitor »Tous les plugins officiels Capacitor fonctionnent sans heurt :
import { Camera, CameraResultType } from '@capacitor/camera';import { Geolocation } from '@capacitor/geolocation';import { Storage } from '@capacitor/preferences';
// Cameraconst photo = await Camera.getPhoto({ quality: 90, resultType: CameraResultType.Uri});
// Geolocationconst position = await Geolocation.getCurrentPosition();
// Storageawait Storage.set({ key: 'name', value: 'John' });Avec les Capgo Plugins
Section intitulée « Avec les Capgo Plugins »Les plugins Capgo fonctionnent parfaitement avec Capacitor+ :
import { CapacitorUpdater } from '@capgo/capacitor-updater';import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';import { CapacitorFlash } from '@capgo/capacitor-flash';
// Live updatesawait CapacitorUpdater.notifyAppReady();
// Screen orientationawait ScreenOrientation.lock({ orientation: 'portrait' });
// Flashlightawait CapacitorFlash.toggle();Comment fonctionne la synchronisation
Comment fonctionne la synchronisation┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- Daily Sync: GitHub Actions récupèrent les dernières mises à jour depuis
ionic-team/capacitor - Création de PR: Changes are proposed as pull requests to the
plusbranchement - Validation CI: Tout le jeu de tests est exécuté (lint, tests unitaires, build iOS, build Android)
- Révision de sécurité: L'analyse par intelligence artificielle vérifie les vulnérabilités et les changements brisants
- Auto-MergeSeulement si le CI passe et que la revue de sécurité approuve.
- Auto-Publication: Nouvelle version publiée sous npm
@capacitor-plus/*
Détails de la Revue de Sécurité
Section intitulée « Détails de la Revue de Sécurité »Chaque synchronisation en amont est analysée pour :
| Vérifier | Ce Qu'il Capture |
|---|---|
| Sécurité | Injection de commande, XSS, parcours de chemins, secrets fixés |
| Changements Importants | Mises à jour des APIs, changements de signatures, modifications de configuration |
| Stabilité | Fuites de pointeurs null, exceptions non gérées, conditions de course, fuites de mémoire |
| Data Safety | Scénarios de perte de données, violations de confidentialité, stockage non sécurisé |
| Intégrité Code | L'intégrité code obscurcie, appels réseau suspects, backdoors |
Soumettre votre PR
Section intitulée « Soumettre votre PR »Vous avez un PR bloqué dans le référentiel officiel Capacitor ? Le fait de le fusionner vous prendra Capacitor+ :
-
Ouvrir une question dans le Capacitor+ dépôt lié à votre PR upstream
-
Ou soumettre directement en tant que PR à la
plusbranch -
L'équipe passera en revue, exécutera la CI et mergera si cela passe
Vous et les autres pouvez ainsi profiter de votre travail immédiatement sans attendre le cycle de mise à jour du upstream.
Est-ce qu'il est prêt pour la production ?
Est-ce qu'il s'agit d'une version de production ?Oui. Capacitor+ est utilisé dans les applications en production. Chaque mise à jour passe le même ensemble de tests que Capacitor officiel, plus une analyse de sécurité supplémentaire.
Ma plugin officiel fonctionnera-t-il toujours ?
Section intitulée « Ma plugin officiel fonctionnera-t-il toujours ? »Oui. Tous les @capacitor/* plugins fonctionnent avec Capacitor+ sans modification.
What if upstream releases a breaking change?
Quel est l'impact d'une mise à jour majeure de la bibliothèque ?La revue de sécurité AI signale les changements de rupture pour examen manuel. Vous verrez les changements documentés avant qu'ils soient fusionnés.
Comment puis-je signaler des problèmes ?
Comment signaler des problèmes ?Signalez des problèmes sur le Capacitor+ GitHub dépôt. Pour les problèmes qui affectent également Capacitor officiel, nous coordonnerons l'amont.
Puis-je contribuer ?
Section intitulée « Puis-je contribuer ? »Oui ! Les PR sont les bienvenus. Vous pouvez soumettre des correctifs directement ou demander la fusion de PR spécifiques upstream.
Continuez de la section « Getting Started »
Section intitulée « Continuez de la section « Getting Started » »Si vous utilisez Getting Started pour planifier le travail de plugin natif, connectez-l’avec Utilisation de Capacitor+ (@capacitor-plus) Packages pour la capacité native dans l'Utilisation de Capacitor+ (@capacitor-plus) Packages, Répertoire du Plugin Capgo pour le flux de travail du produit dans le répertoire du plugin Capgo Capacitor Plugins by Capgo pour les détails d'implémentation dans Capacitor Plugins par Capgo Ajouter ou Mettre à Jour des Plugins pour les détails d'implémentation dans l'article Ajouter ou Mettre à Jour des Plugins. Alternatives de plugins Ionic Enterprise pour le flux de travail du produit dans les alternatives du plugin Entreprise Ionic.