Getting Started
Kopieren Sie einen Einrichtungsprompt mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen 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.
Neuer Projekt-Installation
Abschnitt mit dem Titel “Neuer Projekt-Installation”-
Installieren von Kern-Paketen
Terminal-Fenster npm install @capacitor-plus/core @capacitor-plus/cli -
Hinzufügen von Plattform-Paketen
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 offiziellen Capacitor migrieren
Abschnitt mit dem Titel „Von offiziellen Capacitor migrieren“Wenn Sie ein bestehendes Capacitor-Projekt haben, ist die Migration zu Capacitor+ einfach:
-
Offizielle Pakete entfernen
Terminalfenster npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Capacitor+-Pakete installieren
Terminalfenster npm install @capacitor-plus/core @capacitor-plus/clinpm install @capacitor-plus/android # if using Androidnpm install @capacitor-plus/ios # if using iOS -
Ihre Projekt synchronisieren
Terminalfenster npx cap syncTerminalfenster pnpm cap syncTerminalfenster yarn cap syncTerminalfenster bunx cap sync
Verwendung
Abschnitt mit dem Titel “Verwendung”Da Capacitor+ 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-Erweiterungen”Capgo-Erweiterungen 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();Wie die Synchronisierung funktioniert
Abschnitt 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 │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- Tägliche Synchronisierung: GitHub-Aktionen holen die neuesten Änderungen von
ionic-team/capacitor - Pull-Request-Erstellung: Änderungen werden als Pull-Requests zur
plusZweig - CI-Validierung: Vollständige Test-Suite läuft (Lint, Einheitstests, iOS-Build, Android-Build)
- Sicherheitsüberprüfung: KI-gestützte Analyse überprüft auf Sicherheitslücken und veränderte Funktionalitäten
- Automatische Merging: Nur wenn CI erfolgreich ist UND Sicherheitsüberprüfung genehmigt hat
- Automatisches Veröffentlichen: Neuere Version wird unter npm veröffentlicht
@capacitor-plus/*
Sicherheitsüberprüfung Details
Abschnitt mit dem Titel „Sicherheitsüberprüfung Details“Jeder Upstream-Sync wird auf folgende Aspekte analysiert:
| Überprüfung | Was es fängt |
|---|---|
| Sicherheit | Befehlsinjektion, XSS, Pfadüberprüfung, festgelegte Geheimnisse |
| Änderungen mit Sicherheitsrisiken | Entfernte/umbenannte APIs, geänderte Signatur, Konfigurationsänderungen |
| Stabilität | Null-Verweise, unbehaltene Exceptions, Rassenbedingungen, Speicherverluste |
| Daten-Sicherheit | Datenverlustszenarien, Verletzungen der Privatsphäre, unsichere Speicherung |
| Code Integrität | Verschlüsselte code, verdächtige Netzwerkaufrufe, Hintertüren |
Dein Pull-Request einreichen
Abschnitt: "Dein Pull-Request einreichen"Hast du einen Pull-Request im offiziellen Capacitor-Repository stecken? Lass ihn in Capacitor+:
-
Eine Issue öffnen im Capacitor+-Repository mit Verweis auf deinen upstream-Pull-Request
-
Oder submit direkt als Pull-Request zu der
plusBranch -
Das Team wird ihn überprüfen, CI ausführen und wenn er erfolgreich ist, mergen.
So können Sie und andere direkt von Ihrem Werk profitieren, ohne auf das Release-Zyklus der Oberfläche warten zu müssen.
Ist dies für die Produktion bereit?
Abschnitt mit dem Titel „Ist dies für die Produktion bereit?“Ja. Capacitor+ wird in Produktionsanwendungen verwendet. Jedes Release besteht denselben Test-Suite wie die offizielle Capacitor, plus zusätzliche Sicherheitsanalyse.
Wird meine offizielle Plugin noch funktionieren?
Abschnitt mit dem Titel „Wird meine offizielle Plugin noch funktionieren?“Ja. Alle @capacitor/* Plugins funktionieren mit Capacitor+ ohne weitere Konfiguration.
Was passiert, wenn die Oberfläche ein breakender Change veröffentlicht?
Abschnitt mit dem Titel „Was passiert, wenn die Oberfläche ein breakender Change veröffentlicht?“Die AI-Sicherheitsprüfung kennzeichnet Änderungen, die eine manuelle Überprüfung erfordern. Sie sehen die Änderungen dokumentiert, bevor sie integriert werden.
Wie melde ich Probleme?
Wie melde ich Probleme?Dateien im Capacitor + GitHubRepo melden. Für Probleme, die auch offizielle Capacitor betreffen, helfen wir bei der Koordination von Änderungen.
Kann ich beitragen?
Kann ich beitragen?Absolut! Pull Requests sind willkommen. Sie können Fixes direkt einreichen oder bitten, dass bestimmte upstream-PRs integriert werden.
Weiter geht es von Getting Started
Kann ich beitragen?Wenn Sie Einstieg um native Plugin-Arbeit zu planen, verbinden Sie es mit Mit Capacitor+ (@capacitor-plus) Paketen für die native Fähigkeit in Mit Capacitor+ (@capacitor-plus) Paketen, Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis, 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.