diff --git a/README.md b/README.md index 2f85046..e366594 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ -# react-native-file-selector +# 迁移声明 -本项目基于 [react-native-file-selector](https://github.com/prscX/react-native-file-selector) +- 本仓库已迁移至 GitCode:[OpenHarmony-SIG/rntpc_react-native-file-selector](https://gitcode.com/openharmony-sig/rntpc_react-native-file-selector)。 +- 包名已更改为 `@react-native-ohos/react-native-file-selector`,支持直接从 npm 下载。 +- 更多详情请查阅新仓库的 README 文件。 +- 本仓库旧版本的文档已归档:[链接](/doc/zh-cn.md) -## 文档地址 / Documentation URL +# Migration Announcement -[中文 / Chinese](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-file-selector.md) - -## Codegen - -该库已接入 codegen,具体请查阅文档。 - -The library has been integrated with codegen. Please refer to the documentation for details. - -## 请悉知 / Acknowledgements - -本项目基于 [The Apache License (Apache)](https://github.com/prscX/react-native-file-selector/blob/master/LICENSE) ,请自由地享受和参与开源。 \ No newline at end of file +- This repository has been migrated to GitCode:[OpenHarmony-SIG/rntpc_react-native-file-selector](https://gitcode.com/openharmony-sig/rntpc_react-native-file-selector) +- The package name has been changed to `@react-native-ohos/react-native-file-selector` and is now available for direct download from npm. +- For more details, please refer to the README in the new repository. +- Archived documentation for versions in this repository can be found here: [Link](/doc/en.md) diff --git a/doc/en.md b/doc/en.md new file mode 100644 index 0000000..0942984 --- /dev/null +++ b/doc/en.md @@ -0,0 +1,209 @@ +> Template version: v0.2.2 + +

+

react-native-file-selector

+

+

+ + Supported platforms + + + License + +

+ +> [!TIP] [GitHub address](https://github.com/react-native-oh-library/react-native-file-selector) + +## Installation and Usage + +Find the matching version information in the release address of a third-party library and download an applicable .tgz package: [@react-native-oh-tpl/react-native-file-selector Releases](https://github.com/react-native-oh-library/react-native-file-selector/releases).For older versions that are not published to npm, please refer to the [installation guide](/en/tgz-usage-en.md) to install the tgz package. + +Go to the project directory and execute the following instruction: + + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-file-selector +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-file-selector +``` + + +The following code shows the basic use scenario of the repository: + +> [!WARNING] The name of the imported repository remains unchanged. + +```jsx +import FileSelector from 'react-native-file-selector'; +import React from 'react'; +function App(): React.JSX.Element { + + return ( + {console.log("file selected: " + path);}} + onCancel={() => {console.log("cancelled");}} + />) +}; +export default App; +``` + +## Use Codegen + +If this repository has been adapted to Codegen, generate the bridge code of the third-party library by using the Codegen. For details, see[ Codegen Usage Guide](/en/codegen.md). + +## Link + +Currently, HarmonyOS does not support AutoLink. Therefore, you need to manually configure the linking. + +Open the harmony directory of the HarmonyOS project in DevEco Studio. + +### 1.Adding the overrides Field to oh-package.json5 File in the Root Directory of the Project + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "file:./react_native_openharmony" + } +} +``` + +### 2.Introducing Native Code + +Currently, two methods are available: + +1. (Recommended) Use the HAR file. +2. Directly link to the source code. + +Method 1 (recommended): Use the HAR file. + +> [!TIP] The HAR file is stored in the harmony directory in the installation path of the third-party library. + +Open entry/oh-package.json5 file and add the following dependencies: + +```json +"dependencies": { + "@rnoh/react-native-openharmony" : "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-file-selector": "file:../../node_modules/@react-native-oh-tpl/react-native-file-selector/harmony/file_selector.har" + } +``` + +Click the sync button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Method 2: Directly link to the source code. + +> [!TIP] For details, see[Directly Linking Source Code](/en/link-source-code.md) + + +### 3.Introducing RNFileSelectorPackage Package to ArkTS + +Open the entry/src/main/ets/RNPackagesFactory.ts file and add the following code: + +```diff + ... +import type {RNPackageContext, RNPackage} from '@rnoh/react-native-openharmony/ts'; ++import {RNFileSelectorPackage} from '@react-native-oh-tpl/react-native-file-selector/ts'; + + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ ++ new RNFileSelectorPackage(ctx) + ]; +} +``` + +### 4.Running + +Click the sync button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Then build and run the code. + +## Constraints + +### Compatibility + +To use this repository, you need to use the correct React-Native and RNOH versions. In addition, you need to use DevEco Studio and the ROM on your phone. + +Check the release version information in the release address of the third-party library: [@react-native-oh-tpl/react-native-file-selector Releases](https://github.com/react-native-oh-library/react-native-file-selector/releases) + +## Properties + + FileSelector + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| :---------------- | ------------------------------------------------------------ | ------ | -------- | ----------- | ----------------- | +| filter | Filter to sort the files | string | no | All | yes | +| path | Path of directory | string | no | All | yes | +| onDone | Function called when file is selected | func | no | All | yes | +| onCancel | Function called when file selector is closed without selecting any file | func | no | All | yes | +| title | Title on the toolbar | string | no | Android iOS | no | +| closeMenu | Color of tint | string | no | Android iOS | no | +| hiddenFiles | If true it shows hidden files as well | bool | no | Android | no | +| filterDirectories | Filter should be applied on directories or not | bool | no | Android | no | + +## API + +> [!tip] The Platform column indicates the platform where the properties are supported in the original third-party library. + +> [!tip] If the value of HarmonyOS Support is yes, it means that the HarmonyOS platform supports this property; no means the opposite; partially means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android. + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ---------------------- | -------- | -------- | -------- | ----------------- | +| Show | present a fileselector | function | no | All | yes | + + Show + +```js +Show(filter?: string, path?: string, onDone?: func, onCancel?: func, title?: string, closeMenu?: string, hiddenFiles?: bool, filterDirectories?: bool); +``` + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| :---------------- | ------------------------------------------------------------ | ------ | -------- | ----------- | ----------------- | +| filter | Filter to sort the files | string | no | All | yes | +| path | Path of directory | string | no | All | yes | +| onDone | Function called when file is selected | func | no | All | yes | +| onCancel | Function called when file selector is closed without selecting any file | func | no | All | yes | +| title | Title on the toolbar | string | no | Android iOS | no | +| closeMenu | Color of tint | string | no | Android iOS | no | +| hiddenFiles | If true it shows hidden files as well | bool | no | Android | no | +| filterDirectories | Filter should be applied on directories or not | bool | no | Android | no | + +## Known Issues + + +- [ ] FileSelector title: Harmony issue: [issue#4](https://github.com/react-native-oh-library/react-native-file-selector/issues/4) +- [ ] FileSelector closeMenu: Harmony issue: [issue#5](https://github.com/react-native-oh-library/react-native-file-selector/issues/5) +- [ ] FileSelector hiddenFiles: Harmony issue: [issue#6](https://github.com/react-native-oh-library/react-native-file-selector/issues/6) +- [ ] FileSelector filterDirectories: Harmony issue: [issue#7](https://github.com/react-native-oh-library/react-native-file-selector/issues/7) + +- [ ] Show title: Harmony issue: [issue#4](https://github.com/react-native-oh-library/react-native-file-selector/issues/4) +- [ ] Show closeMenu: Harmony issue: [issue#5](https://github.com/react-native-oh-library/react-native-file-selector/issues/5) +- [ ] Show hiddenFiles: Harmony issue: [issue#6](https://github.com/react-native-oh-library/react-native-file-selector/issues/6) +- [ ] Show filterDirectories: Harmony issue: [issue#7](https://github.com/react-native-oh-library/react-native-file-selector/issues/7) + +## Others + +## License + +This project is licensed under [Apache License 2.0](https://github.com/prscX/react-native-file-selector/blob/master/LICENSE). diff --git a/doc/zh-cn.md b/doc/zh-cn.md new file mode 100644 index 0000000..fdabdd0 --- /dev/null +++ b/doc/zh-cn.md @@ -0,0 +1,208 @@ + +> 模板版本:v0.2.2 + +

+

react-native-file-selector

+

+

+ + Supported platforms + + + License + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-file-selector) + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-tpl/react-native-file-selector Releases](https://github.com/react-native-oh-library/react-native-file-selector/releases) 。对于未发布到npm的旧版本,请参考[安装指南](/zh-cn/tgz-usage.md)安装tgz包。 + +进入到工程目录并输入以下命令: + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-file-selector +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-file-selector +``` + + +下面的代码展示了这个库的基本使用场景: + +> [!WARNING] 使用时 import 的库名不变。 + +```jsx +import FileSelector from 'react-native-file-selector'; +import React from 'react'; +function App(): React.JSX.Element { + + return ( + {console.log("file selected: " + path);}} + onCancel={() => {console.log("cancelled");}} + />) +}; +export default App; +``` + +## 使用 Codegen + +本库已经适配了 `Codegen` ,在使用前需要主动执行生成三方库桥接代码,详细请参考[ Codegen 使用文档](/zh-cn/codegen.md)。 + +## Link + +目前 HarmonyOS 暂不支持 AutoLink,所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony` + +### 1.在工程根目录的 `oh-package.json5` 添加 overrides 字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "file:./react_native_openharmony" + } +} +``` + +### 2.引入原生端代码 + +目前有两种方法: + +1. 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法); +2. 直接链接源码。 + +方法一:通过 har 包引入(推荐) + +> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。 + +打开 `entry/oh-package.json5`,添加以下依赖 + +```json +"dependencies": { + "@rnoh/react-native-openharmony" : "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-file-selector": "file:../../node_modules/@react-native-oh-tpl/react-native-file-selector/harmony/file_selector.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +方法二:直接链接源码 + +> [!TIP] 如需使用直接链接源码,请参考[直接链接源码说明](/zh-cn/link-source-code.md) + + +### 3.在 ArkTs 侧引入 RNFileSelectorPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`,添加: + +```diff + ... +import type {RNPackageContext, RNPackage} from '@rnoh/react-native-openharmony/ts'; ++import {RNFileSelectorPackage} from '@react-native-oh-tpl/react-native-file-selector/ts'; + + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ ++ new RNFileSelectorPackage(ctx) + ]; +} +``` + +### 4.运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息:[@react-native-oh-tpl/react-native-file-selector Releases](https://github.com/react-native-oh-library/react-native-file-selector/releases) + +## 属性 + + FileSelector + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| :--- | ----------- | ---- | -------- | -------- | ------------------ | +| filter | Filter to sort the files | string | no | All | yes | +| path | Path of directory | string | no | All | yes | +| onDone | Function called when file is selected | func | no | All | yes | +| onCancel | Function called when file selector is closed without selecting any file | func | no | All | yes | +| title | Title on the toolbar | string | no | Android iOS | no | +| closeMenu | Color of tint | string | no | Android iOS | no | +| hiddenFiles | If true it shows hidden files as well | bool | no | Android | no | +| filterDirectories | Filter should be applied on directories or not | bool | no | Android | no | + +## API + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| Show | present a fileselector | function | no | All | yes | + + Show + +```js +Show(filter?: string, path?: string, onDone?: func, onCancel?: func, title?: string, closeMenu?: string, hiddenFiles?: bool, filterDirectories?: bool); +``` + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| :--- | ----------- | ---- | -------- | -------- | ------------------ | +| filter | Filter to sort the files | string | no | All | yes | +| path | Path of directory | string | no | All | yes | +| onDone | Function called when file is selected | func | no | All | yes | +| onCancel | Function called when file selector is closed without selecting any file | func | no | All | yes | +| title | Title on the toolbar | string | no | Android iOS | no | +| closeMenu | Color of tint | string | no | Android iOS | no | +| hiddenFiles | If true it shows hidden files as well | bool | no | Android | no | +| filterDirectories | Filter should be applied on directories or not | bool | no | Android | no | + +## 遗留问题 + + +- [ ] FileSelector title:harmony暂不支持: [issue#4](https://github.com/react-native-oh-library/react-native-file-selector/issues/4) +- [ ] FileSelector closeMenu:harmony暂不支持: [issue#5](https://github.com/react-native-oh-library/react-native-file-selector/issues/5) +- [ ] FileSelector hiddenFiles:harmony暂不支持: [issue#6](https://github.com/react-native-oh-library/react-native-file-selector/issues/6) +- [ ] FileSelector filterDirectories:harmony暂不支持: [issue#7](https://github.com/react-native-oh-library/react-native-file-selector/issues/7) + +- [ ] Show title:harmony暂不支持: [issue#4](https://github.com/react-native-oh-library/react-native-file-selector/issues/4) +- [ ] Show closeMenu:harmony暂不支持: [issue#5](https://github.com/react-native-oh-library/react-native-file-selector/issues/5) +- [ ] Show hiddenFiles:harmony暂不支持: [issue#6](https://github.com/react-native-oh-library/react-native-file-selector/issues/6) +- [ ] Show filterDirectories:harmony暂不支持: [issue#7](https://github.com/react-native-oh-library/react-native-file-selector/issues/7) + +## 其他 + +## 开源协议 + +本项目基于 [Apache License 2.0](https://github.com/prscX/react-native-file-selector/blob/master/LICENSE) ,请自由地享受和参与开源。 \ No newline at end of file