Getting Started

GitHub

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 package(s): `@capgo/capacitor-calendar`
Run the required Capacitor sync/update step after installation.
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/calendar/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.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Verwenden Sie dann die folgende Anweisung:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-calendar` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

npm install @capgo/capacitor-calendar
npx cap sync

iOS-Einrichtung

Add the usage descriptions your app needs to ios/App/App/Info.plist:

<key>NSCalendarsUsageDescription</key>
<string>This app needs calendar access.</string>
<key>NSCalendarsWriteOnlyAccessUsageDescription</key>
<string>This app needs permission to add calendar events.</string>
<key>NSCalendarsFullAccessUsageDescription</key>
<string>This app needs permission to read and manage calendar events.</string>
<key>NSRemindersUsageDescription</key>
<string>This app needs reminders access.</string>
<key>NSRemindersFullAccessUsageDescription</key>
<string>This app needs permission to read and manage reminders.</string>

iOS 17 und neuer unterscheidet zwischen schreibgeschützten und vollständigen Kalenderzugriffen. Erhalten Sie nur Benutzungsbeschreibungen für Erinnerungen, wenn Ihre App die APIs für Erinnerungen aufruft.

Apple-Referenz: Zum neuesten Kalenderzugriff aufsteigen.

Android-Einrichtung

Fügen Sie den Kalenderberechtigungen hinzu, die Ihre App benötigt android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_CALENDAR" />
<uses-permission android:name="android.permission.WRITE_CALENDAR" />

Android-Referenz: Kalender-Provider-Benutzerberechtigungen.

Kalender-Zugriff anfordern

import { CapacitorCalendar } from '@capgo/capacitor-calendar';

const permission = await CapacitorCalendar.requestFullCalendarAccess();

if (permission.result !== 'granted') {
  throw new Error('Calendar permission was not granted');
}

Für Apps, die nur Termine hinzufügen, verwenden Sie requestWriteOnlyCalendarAccess()Für Android-only-Leseflows verwenden Sie requestReadOnlyCalendarAccess().

Ereignis erstellen

Die Daten sind Unix-Zeitstempel in Millisekunden.

import { CapacitorCalendar } from '@capgo/capacitor-calendar';

const startDate = Date.now() + 60 * 60 * 1000;
const endDate = startDate + 60 * 60 * 1000;

const { id } = await CapacitorCalendar.createEvent({
  title: 'Product review',
  location: 'Capgo',
  startDate,
  endDate,
  description: 'Created with @capgo/capacitor-calendar',
});

console.log('Created event', id);

Das native Ereignis-Editor öffnen

await CapacitorCalendar.createEventWithPrompt({
  title: 'Planning session',
  location: 'Office',
  startDate: Date.now() + 24 * 60 * 60 * 1000,
  endDate: Date.now() + 25 * 60 * 60 * 1000,
});

Auf Android prompt-basierte Erstellung und Modifizierung von Anfragen geben nullDann werden die Ereignisse aufgelistet, wenn Sie das erstellte Ereignis-ID finden müssen.

Kommende Ereignisse auflisten

const now = Date.now();
const oneWeekFromNow = now + 7 * 24 * 60 * 60 * 1000;

const { result: events } = await CapacitorCalendar.listEventsInRange({
  from: now,
  to: oneWeekFromNow,
});

Ein Kalender auswählen

const { result: calendars } = await CapacitorCalendar.listCalendars();
const { result: defaultCalendar } = await CapacitorCalendar.getDefaultCalendar();

const calendarId = defaultCalendar?.id ?? calendars[0]?.id;

selectCalendarsWithPrompt() ist auf iOS verfügbar, wenn Sie das Systemkalenderpicker anzeigen möchten.

Erstellen Sie einen iOS-Erinnerung

const permission = await CapacitorCalendar.requestFullRemindersAccess();

if (permission.result === 'granted') {
  await CapacitorCalendar.createReminder({
    title: 'Send launch notes',
    dueDate: Date.now() + 2 * 24 * 60 * 60 * 1000,
    notes: 'Created with @capgo/capacitor-calendar',
  });
}

Reminder-APIs sind iOS-basiert.

Beispiel-App

Das Repository enthält ein Beispiel-App mit Capacitor Berechtigungsprüfungen, Ereignis-Erstellung, nativen Ereignis-Anfragen, Kalender-Liste und Ereignis-Liste.

iOS	Android

API-Referenz

Die vollständige API-Referenz wird im Paket README und TypeScript-Definitionen aufrechterhalten: