Démarrage rapide
Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet 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
Vous pouvez utiliser notre configuration assistée par l'IA pour installer __CAPGO_KEEP_0__+. Ajoutez les compétences __CAPGO_KEEP_1__ à votre outil IA en utilisant la commande suivante :You can use our AI-Assisted Setup to install Capacitor+. Add the Capgo skills to your AI tool using the following command:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsCopier 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 Capacitor existant, la migration vers Capacitor+ est simple :
-
Supprimer les packages officiels
Fenêtre de terminal npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Installer Capacitor+ packages
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 -
Synchroniser 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 Capgo Plugins
Section intitulée “Avec 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
Section intitulée “Comment fonctionne la synchronisation”┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- Synchronisation quotidienne: GitHub Actions récupèrent les dernières modifications depuis
ionic-team/capacitor - Création de PR: Les modifications sont proposées sous forme de requêtes de fusion vers le
plusValidation 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 brisantsMise automatique à jour
- : Seulement si CI passe ET la révision de sécurité approuve__CAPGO_KEEP_0__
- Publier automatiquement: Nouvelle version publiée sur npm sous
@capacitor-plus/*
Détails de la revue de sécurité
Section intitulée “Détails de la revue de sécurité”Tout synchronisme upstream est analysé pour :
| Vérifier | Ce qu'il attrape |
|---|---|
| Sécurité | Injection de commandes, XSS, parcours de chemins, secrets fixés |
| Changements de rupture | API supprimées/renommées, signatures modifiées, changements de configuration |
| Stabilité | Références null, exceptions non gérées, conditions de course, fuites de mémoire |
| Sécurité des données | __CAPGO_KEEP_0__ Intégrité, scénarios de perte de données, violations de la vie privée, stockage non sécurisé |
| Code Integrity | Obfuscated code, suspicious network calls, backdoors |
Avez-vous un PR bloqué dans le référentiel officiel __CAPGO_KEEP_0__ ? Obtenez-le fusionné en __CAPGO_KEEP_1__+:
Ouvrir une questionHave a PR stuck in the official Capacitor repo? Get it merged in Capacitor+:
-
Ouvrir une question In le Capacitor+ dépôt Se référer à votre PR upstream
-
Ou soumettre directement Comme un PR à la
plusbranch -
L'équipe passera en revue, exécutera la CI, et fusionnera si cela passe
Cela permet à vous et aux autres de bénéficier de votre travail immédiatement sans attendre le cycle de mise en production de l'upstream.
Est-ce que cela est prêt pour la production?
Sous-titre “Est-ce que cela est prêt pour la production?”Yes. Capacitor+ est utilisé dans les applications de production. Chaque mise à jour passe le même ensemble de tests que la version officielle Capacitor, plus une analyse de sécurité supplémentaire.
Mon plugins officiels fonctionneront-ils toujours ?
Sous-titre : « Mon plugins officiels fonctionneront-ils toujours ? »Oui. Tous les @capacitor/* plugins fonctionnent avec Capacitor+ sans modification.
Quoi se passe si les développeurs upstream publient une modification de rupture ?
Sous-titre : « Quoi se passe si les développeurs upstream publient une modification de rupture ? »La revue de sécurité par l'IA signale les modifications de rupture pour examen manuel. Vous verrez les modifications documentées avant qu'elles soient fusionnées.
Comment signaler des problèmes ?
Sous-titre : « Comment signaler des problèmes ? »Signalez des problèmes sur le Capacitor+ GitHub repo. Pour les problèmes qui affectent également Capacitor, nous aiderons à coordonner l'amont.
Puis-je contribuer ?
Section intitulée « Puis-je contribuer ? »Absolument ! Les PR sont les bienvenus. Vous pouvez soumettre des correctifs directement ou demander que des PR spécifiques de l'amont soient fusionnés.
Continuez de la section « Démarrage »
Section intitulée « Continuez de la section « Démarrage » »Si vous utilisez Démarrage pour planifier le travail de plugin natif, connectez-le avec Utilisation de Capacitor+ (@capacitor-plus) Packages pour la capacité native dans Utilisation de Capacitor+ (@capacitor-plus) Packages, Capgo Répertoire des plugins pour le flux de produit dans le répertoire de plugin Capgo les plugins Capacitor par Capgo pour le détail d'implémentation dans les plugins Capacitor par Capgo, Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins, et Alternatives de Plugin d'Entreprise Ionic pour le flux de produit dans Alternatives de Plugin d'Entreprise Ionic.