Flutter日历添加插件add_2_calendar的使用

add_2_calendar 是一个用于向各个平台默认日历添加事件的简单Flutter插件。以下是关于如何安装和使用的详细介绍。

安装

pubspec.yaml文件配置

在你的 pubspec.yaml 文件中添加如下依赖：

dependencies:
  add_2_calendar: ^2.1.2

然后运行 flutter pub get 来安装此包。

Android集成

对于Android，如果你需要不打开日历应用直接添加事件，则需要在 AndroidManifest.xml 中添加以下权限：

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

从API 30开始，还需要在 AndroidManifest.xml 中添加包可见性配置：

<queries>
  <intent>
    <action android:name="android.intent.action.INSERT" />
    <data android:mimeType="vnd.android.cursor.item/event" />
  </intent>
</queries>

iOS集成

为了让此插件在iOS 10+上正常工作，请确保在 info.plist 文件中添加以下内容：

<key>NSCalendarsUsageDescription</key>
<string>我们需要访问您的日历来添加事件。</string>

<key>NSContactsUsageDescription</key>
<string>我们需要访问您的联系人以提供位置自动补全功能。</string>

使用方法

要将事件添加到日历中，你需要创建一个 Event 对象并调用 Add2Calendar.addEvent2Cal() 方法。下面是一个完整的示例代码：

import 'package:flutter/material.dart';
import 'package:add_2_calendar/add_2_calendar.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  final GlobalKey<ScaffoldMessengerState> scaffoldMessengerKey =
      GlobalKey<ScaffoldMessengerState>();

  Event buildEvent({Recurrence? recurrence}) {
    return Event(
      title: 'Test event',
      description: 'This is a test event added via the add_2_calendar plugin.',
      location: 'Location of the event',
      startDate: DateTime.now(),
      endDate: DateTime.now().add(const Duration(hours: 1)),
      iosParams: const IOSParams(
        reminder: Duration(minutes: 15), // 提前15分钟提醒
        url: "http://example.com", // 事件的相关链接
      ),
      androidParams: const AndroidParams(
        emailInvites: ["test@example.com"], // 邀请的邮件列表
      ),
      recurrence: recurrence,
    );
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      scaffoldMessengerKey: scaffoldMessengerKey,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Add event to calendar example'),
        ),
        body: ListView(
          children: [
            ListTile(
              title: const Text('Add normal event'),
              trailing: const Icon(Icons.calendar_today),
              onTap: () {
                Add2Calendar.addEvent2Cal(buildEvent());
              },
            ),
            const Divider(),
            ListTile(
              title: const Text('Add weekly recurring event for 3 months'),
              trailing: const Icon(Icons.calendar_today),
              onTap: () {
                Add2Calendar.addEvent2Cal(buildEvent(
                  recurrence: Recurrence(
                    frequency: Frequency.weekly,
                    endDate: DateTime.now().add(const Duration(days: 90)),
                  ),
                ));
              },
            ),
            const Divider(),
            ListTile(
              title: const Text('Add monthly recurring event every 2 months for 6 times (1 year)'),
              trailing: const Icon(Icons.calendar_today),
              onTap: () {
                Add2Calendar.addEvent2Cal(buildEvent(
                  recurrence: Recurrence(
                    frequency: Frequency.monthly,
                    interval: 2,
                    ocurrences: 6,
                  ),
                ));
              },
            ),
            const Divider(),
            ListTile(
              title: const Text('Add yearly recurring event for 10 years (Android only)'),
              trailing: const Icon(Icons.calendar_today),
              onTap: () {
                Add2Calendar.addEvent2Cal(buildEvent(
                  recurrence: Recurrence(
                    frequency: Frequency.yearly,
                    rRule: 'FREQ=YEARLY;COUNT=10;WKST=SU',
                  ),
                ));
              },
            ),
            const Divider(),
          ],
        ),
      ),
    );
  }
}

以上代码展示了如何创建一个简单的Flutter应用程序，并通过 add_2_calendar 插件来添加不同类型的日历事件（包括重复事件）。你可以根据自己的需求调整这些代码。

注意事项

• 日期时间：请参考 DateTime文档，以确保你提供的日期格式正确。
• iOS语言支持：如果你想让iOS的日历界面支持多种语言，可以在 info.plist 文件中添加支持的语言列表。

希望这个指南能帮助你在Flutter项目中成功集成 add_2_calendar 插件！如果有任何问题或需要进一步的帮助，请随时提问。