模板版本:v0.4.0

react-native-calendar-events

本项目基于 react-native-calendar-events 开发。

该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-calendar-events 版本所属关系如下:

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-calendar-events ~2.4.0 Gitcode Releases 0.82.* API12+ 2.2.0 Npm Address
@react-native-ohos/react-native-calendar-events ~2.3.0 Gitcode Releases 0.77.* API12+ 2.2.0 Npm Address
@react-native-ohos/react-native-calendar-events ~2.2.1 Gitcode Releases 0.72.* API12+ 2.2.0 Npm Address
@react-native-oh-tpl/react-native-calendar-events <=2.2.0-0.0.4@deprecated Github Releases 0.72.* API12+ 2.2.0 Npm Address

1. 安装与使用

进入到工程目录并输入以下命令:

npm

npm install @react-native-ohos/react-native-calendar-events

yarn

yarn add @react-native-ohos/react-native-calendar-events

下面的代码展示了这个库的基本使用场景:

使用时 import 的库名不变。


import React, { useEffect } from 'react';
import {
  SafeAreaView,
  StyleSheet,
  ScrollView,
  View,
  Text,
  StatusBar,
  Button,
  Alert,
} from 'react-native';
import RNCalendarEvents from 'react-native-calendar-events';

const Header = ({ children }: { children: React.ReactNode }) => (
  <View style={styles.header}>
    <Text style={styles.headerText}>{children}</Text>
    <Text>Welcome to{'\n'}React Native</Text>
  </View>
);

const Colors = {
  primary: '#1292B4',
  white: '#FFF',
  lighter: '#F3F3F3',
  light: '#DAE1E7',
  dark: '#444',
  black: '#000',
};

//fetchAllEvent
const fetchAllEventStartTime: string = "2025-09-14T08:30:45.123Z"
const fetchAllEventEndTime: string = "2025-09-17T08:30:45.123Z"

function CalendarDemo() {
  useEffect(() => {
    async function deleteAllEvents() {
      try {
        const events = await RNCalendarEvents.fetchAllEvents(fetchAllEventStartTime, fetchAllEventEndTime);
        if (events.length > 0) {
          for (const event of events) {
            //删除每一个事件
            await RNCalendarEvents.removeEvent(event.id);
          }
        }
      } catch (error) {
        console.warn('Failed to delete events:', error);
      }
    }
    deleteAllEvents();
  }, []);

  return (
    <>
      <StatusBar barStyle="dark-content" />
      <SafeAreaView>
        <ScrollView
          contentInsetAdjustmentBehavior="automatic"
          style={styles.scrollView}>
          <Header />
          <View style={styles.engine}>
            <Text style={styles.footer}>Engine: Hermes</Text>
          </View>

          <View style={styles.body}>
            <View style={styles.sectionContainer}>
              <Text style={styles.sectionTitle}>Read/Write Auth</Text>
              <Text style={styles.sectionDescription}>
                <Button
                  title="Request auth"
                  onPress={() => {
                    RNCalendarEvents.requestPermissions().then(
                      (result: string) => {
                        Alert.alert('Auth requested', result);
                      },
                      (result: string) => {
                        console.error(result);
                      },
                    );
                  }}
                />
                <Text>{'\n'}</Text>
                <Button
                  title="Check auth"
                  onPress={() => {
                    RNCalendarEvents.checkPermissions().then(
                      (result: string) => {
                        Alert.alert('Auth check', result);
                      },
                      (result: string) => {
                        console.error(result);
                      },
                    );
                  }}
                />
              </Text>
            </View>
            <View style={styles.sectionContainer}>
              <Text style={styles.sectionTitle}>Calendars</Text>
              <Text style={styles.sectionDescription}>
                <Button
                  title="Find calendars"
                  onPress={() => {
                    RNCalendarEvents.findCalendars().then(
                      (result) => {
                        Alert.alert(
                          'Calendars',
                          result
                            .reduce((acc: string[], cal) => {
                              acc.push(cal.title);
                              return acc;
                            }, [])
                            .join('\n'),
                        );
                      },
                      (result) => {
                        console.error(result);
                      },
                    );
                  }}
                />
              </Text>
            </View>
          </View>
        </ScrollView>
      </SafeAreaView>
    </>
  );
};

const styles = StyleSheet.create({
  scrollView: {
    backgroundColor: Colors.lighter,
  },
  engine: {
    position: 'absolute',
    right: 0,
  },
  body: {
    backgroundColor: Colors.white,
  },
  sectionContainer: {
    marginTop: 32,
    paddingHorizontal: 24,
  },
  sectionTitle: {
    fontSize: 24,
    fontWeight: '600',
    color: Colors.black,
  },
  sectionDescription: {
    marginTop: 8,
    fontSize: 18,
    fontWeight: '400',
    color: Colors.dark,
  },
  footer: {
    color: Colors.dark,
    fontSize: 12,
    fontWeight: '600',
    padding: 4,
    paddingRight: 12,
    textAlign: 'right',
  },
  header: {
    padding: 20,
    backgroundColor: Colors.primary,
  },
  headerText: {
    fontSize: 20,
    fontWeight: 'bold' as 'bold',
    color: Colors.white,
  },
});

export default CalendarDemo;

2. 使用 Codegen

本库已经适配了 Codegen ,在使用前需要主动执行生成三方库桥接代码,详细请参考 Codegen 使用文档

是否支持autolink RN框架版本
~2.4.0 Yes 0.82
~2.3.0 No 0.77
~2.2.1 Yes 0.72
<= 2.2.0-0.0.4@deprecated No 0.72

使用AutoLink的工程需要根据该文档配置,Autolink框架指导文档:https://gitcode.com/openharmony-sig/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md

如您使用的版本支持 Autolink,并且工程已接入 Autolink,可跳过ManualLink配置。

ManualLink: 此步骤为手动配置原生依赖项的指导

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

此步骤为手动配置原生依赖项的指导。

3.1. Overrides RN SDK

为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.72.38" // ohpm 在线版本
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
  }
}

3.2. 引入原生端代码

目前有两种方法:

  1. 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
  2. 直接链接源码。

方法一:通过 har 包引入(推荐)

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5,添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-ohos/react-native-calendar-events": "file:../../node_modules/@react-native-ohos/react-native-calendar-events/harmony/calendar_events.har"
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

3.3. 配置 CMakeLists 和引入 CalendarEventPackage

若使用的是 <= 2.2.0-0.0.4 版本,请跳过本章。

打开 entry/src/main/cpp/CMakeLists.txt,添加:

...

project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")

add_subdirectory("${RNOH_CPP_DIR}" ./rn)

# RNOH_END: manual_package_linking_1
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-calendar-events/src/main/cpp" ./calendar_events)
# RNOH_END: manual_package_linking_1

add_library(rnoh_app SHARED
    "./PackageProvider.cpp"
    "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)

target_link_libraries(rnoh_app PUBLIC rnoh)

# RNOH_BEGIN: manual_package_linking_2
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_calendar_events)
# RNOH_BEGIN: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

+ #include "CalendarEventsPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
+        std::make_shared<CalendarEventsPackage>(ctx)
}

3.4. 在 ArkTs 侧引入 CalendarEventPackage

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

  ...
+ import { CalendarEventPackage } from "@react-native-ohos/react-native-calendar-events/ts"

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new CalendarEventPackage(ctx),
  ];
}

3.5. 运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

4. 约束与限制

4.1. 兼容性

要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。

在以下版本验证通过:

  1. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  2. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
  3. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.328 SP26;

4.2. 权限要求

在 entry 目录下的module.json5中添加权限

打开 entry/src/main/module.json5,添加:

...
"requestPermissions": [
+  {
+    "name": "ohos.permission.READ_CALENDAR",
+    "reason": "$string:Access_calendar",
+    "usedScene": {
+      "abilities": [
+        "FormAbility"
+      ],
+      "when":"inuse"
+    }
+  },
+  {
+    "name": "ohos.permission.WRITE_CALENDAR",
+    "reason": "$string:Access_calendar",
+    "usedScene": {
+      "abilities": [
+        "FormAbility"
+      ],
+      "when":"inuse"
+    }
+  }
]

在 entry 目录下添加申请日历权限的原因

打开 entry/src/main/resources/base/element/string.json,添加:

...
{
  "string": [
+    {
+      "name": "Access_calendar",
+      "value": "access calendar"
+    }
  ]
}

5. API

"Platform"列表示该属性在原三方库上支持的平台。

"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。

Name Description Type Required Platform HarmonyOS Support
requestPermissions((readOnly = false)) Request calendar authorization. Authorization must be granted before accessing calendar events. function No All yes
checkPermissions((readOnly = false)) Get calendar authorization status. function No All yes
findCalendars() Finds all the calendars on the device. function No All yes
saveCalendar(calendar) Create a calendar. function No All yes
removeCalendar(id) Removes a calendar. function No All yes
findEventById(id) Find calendar by id. function No All yes
fetchAllEvents(startDate, endDate, calendars) Fetch all calendar events. function No All yes
saveEvent(title, details, options) Creates or updates a calendar event. To update an event, the event id must be defined. function No All yes
removeEvent(id, options) Removes calendar event. function No All yes

6. 遗留问题

7. 其他

8. 开源协议

本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。