Getting Started
Einen Setup-Vorschlag mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.
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.
Neue Projektinstallation
Abschnitt mit dem Titel “Neue Projektinstallation”Sie können unser AI-gestütztes Setup verwenden, um Capacitor+ zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsVerwenden Sie dann die folgende Anweisung:
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.Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie die Pakete, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:
-
Kernpaket installieren
Terminal-Fenster npm install @capacitor-plus/core @capacitor-plus/cli -
Plattformpaket hinzufügen
Terminal-Fenster npm install @capacitor-plus/android # for Androidnpm install @capacitor-plus/ios # for iOS -
Initialisieren Sie Capacitor
Terminalfenster npx cap initTerminalfenster pnpm cap initTerminalfenster yarn cap initTerminalfenster bunx cap init -
Plattformen hinzufügen
Terminalfenster npx cap add androidTerminalfenster pnpm cap add androidTerminalfenster yarn cap add androidTerminalfenster bunx cap add androidTerminalfenster npx cap add iosTerminalfenster pnpm cap add iosTerminalfenster yarn cap add iosTerminalfenster bunx cap add ios
Von Official Capacitor migrieren
Abschnitt mit dem Titel “Von der offiziellen Capacitor migrieren”Wenn Sie ein bestehendes Capacitor-Projekt haben, ist die Migration zu Capacitor+ einfach:
-
Offizielle Pakete entfernen
Terminal-Fenster npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Installieren Sie Capacitor+-Pakete
Terminal-Fenster npm install @capacitor-plus/core @capacitor-plus/clinpm install @capacitor-plus/android # if using Androidnpm install @capacitor-plus/ios # if using iOS -
Synchronisieren Sie Ihr Projekt
Terminalfenster npx cap syncTerminalfenster pnpm cap syncTerminalfenster yarn cap syncTerminalfenster bunx cap sync
Benutzung
Abschnitt mit dem Titel “Benutzung”Da Capacitor+ mit API-kompatibel ist, funktioniert Ihre bestehende code ohne Änderungen:
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');Mit offiziellen Capacitor-Plugins
Abschnitt mit dem Titel “Mit offiziellen Capacitor-Plugins”Alle offiziellen Capacitor-Plugins funktionieren reibungslos:
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' });Mit Capgo-Plugins
Abschnitt mit dem Titel “Mit Capgo-Plugins”Capgo-Plugins funktionieren perfekt mit 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();How die Synchronisierung funktioniert
Sektion mit dem Titel “Wie die Synchronisierung funktioniert”┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- Tagliche Synchronisierung: GitHub Aktionen holen die neuesten Änderungen von
ionic-team/capacitor - Pull-Request-Erstellung: Änderungen werden als Pull-Requests an das
plusZweig - CI-Validierung: Vollständige Test-Suite läuft (Linter, Einheitstests, iOS-Build, Android-Build)
- Sicherheitsüberprüfung: KI-gestützte Analyse überprüft nach Sicherheitslücken und Bruchstellen
- Automatische Merge: Nur wenn CI erfolgreich ist UND Sicherheitsüberprüfung genehmigt hat
- Automatische Veröffentlichung: Neuere Version veröffentlicht unter npm
@capacitor-plus/*
Sicherheitsüberprüfungsdetails
Abschnitt mit Titel “Sicherheitsüberprüfungsdetails”Jeder Upstream-Sync wird auf folgende analysiert:
| Überprüfung | Was es Fängt |
|---|---|
| Sicherheit | : Befindet sich auf der Unternehmensprodukt/Preisliste-Seite. Rolle: UI-Label. Gesehen in: Seite enterprise.astro. Nachrichtenschlüssel `enterprise_hero_security_label` (Unternehmens-Helden-Sicherheitsbezeichnung). |
| Command Injection, XSS, Pfadüberprüfung, festgelegte Geheimnisse | Entfernte/umbenannte APIs, geänderte Signatur, Konfigurationsänderungen |
| Stabilität | Null-Verweise, unbehandelte Exceptions, Rassenbedingungen, Speicherlecks |
| Daten-Sicherheit | Datenverlustszenarien, Verletzungen der Privatsphäre, unsichere Speicherung |
| Code Integrität | Verschlüsselte code, verdächtige Netzwerkaufrufe, Hintertüren |
Pull-Request-Übermittlung
Abschnitt: 'Pull-Request-Übermittlung'Haben Sie ein PR im offiziellen Capacitor-Repo stecken? Lassen Sie es in Capacitor+ einfügen:
-
Ein Issue öffnen im Capacitor+-Repo mit Verweis auf Ihr upstream-PR
-
Oder submit direkt als ein PR zum
plusBranch -
Das Team wird es überprüfen, CI ausführen und einfügen, wenn es besteht
Somit können Sie und andere sofort von Ihrem Werk profitieren, ohne auf das upstream-Release-Zyklus warten zu müssen
Is this production-ready?
Sektion: Ist dies für die Produktion geeignet?Ja. Capacitor+ wird in Produktionsanwendungen verwendet. Jedes Release besteht denselben Test-Suite wie die offizielle Capacitor, plus zusätzliche Sicherheitsanalyse.
Werden meine offiziellen Plugins noch funktionieren?
Sektion: Werden meine offiziellen Plugins noch funktionieren?Ja. Alle @capacitor/* Plugins funktionieren mit Capacitor+ ohne weitere Konfiguration.
Wenn ein upstream-Release einen Bruchteil bringt?
Sektion: Was passiert, wenn ein upstream-Release einen Bruchteil bringt?Die AI-Sicherheitsprüfung meldet Bruchteile für eine manuelle Überprüfung. Sie sehen die Änderungen dokumentiert, bevor sie eingefügt werden.
Wie melde ich Fehler?
Sektion: Wie melde ich Fehler?Dateien im Capacitor + GitHub-Repositoryerstellen. Für Probleme, die auch das offizielle Capacitor betreffen, helfen wir bei der Koordination der upstream-Änderungen.
Kann ich beitragen?
Sektion mit dem Titel ‘Kann ich beitragen?’Absolut! PRs sind willkommen. Sie können Fixes direkt einreichen oder fordern, dass bestimmte upstream-PRs integriert werden.
Fortsetzen Sie mit dem ‘Getting Started’
Sektion mit dem Titel ‘Fortsetzen Sie mit dem ‘Getting Started’Wenn Sie Getting Started zur Planung von native Plugin-Arbeiten verwenden, verbinden Sie es mit Verwendung von Capacitor+ (@capacitor-plus)-Paketen für die native Fähigkeit in Verwendung von Capacitor+ (@capacitor-plus) Paketen Capgo Plugin-Ordner für den Produktworkflow in Capgo Plugin-Ordner Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins und Ionic-Enterprise-Plugin-Alternativen für den Produktworkflow in Ionic-Enterprise-Plugin-Alternativen