カレンダー Capacitor プラグイン

@capgo/capacitor-calendar の使用方法

この @capgo/capacitor-calendar Capacitor パッケージを使用すると、Capacitor アプリで iOS および Android のネイティブカレンダーイベントを管理できます。カレンダーの権限リクエスト、イベントの作成・編集、ネイティブカレンダー UI の表示、カレンダーやイベントの一覧取得、iOS でのリマインダー管理が可能です。

インストール

npm install @capgo/capacitor-calendar
npx cap sync

ネイティブ権限の設定

iOS では、アプリに必要な使用目的の記述を以下に追加してください： 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>NSRemindersFullAccessUsageDescription</key>
<string>This app needs permission to read and manage reminders.</string>

Android では、アプリに必要なカレンダー権限を以下に追加してください： android/app/src/main/AndroidManifest.xml:

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

権限をリクエスト

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

const permission = await CapacitorCalendar.requestFullCalendarAccess();

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

イベントを作成

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);

ネイティブイベントUIを開く

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

イベント一覧

const now = Date.now();

const { result: events } = await CapacitorCalendar.listEventsInRange({
  from: now,
  to: now + 7 * 24 * 60 * 60 * 1000,
});

iOSリマインダー

const permission = await CapacitorCalendar.requestFullRemindersAccess();

if (permission.result === 'granted') {
  await CapacitorCalendar.createReminder({
    title: 'Send launch notes',
    dueDate: Date.now() + 2 * 24 * 60 * 60 * 1000,
  });
}

リマインダーはiOSでのみ利用可能です。

リファレンス全文

• GitHub: https://github.com/Cap-go/capacitor-calendar/
• ドキュメント: /docs/plugins/calendar/