docs: The first version for OpenHarmony

fluttercandies · Mar 13, 2024 · 5fcab8d · 5fcab8d
1 parent e9f10b2
commit 5fcab8d
Show file tree

Hide file tree

Showing 6 changed files with 168 additions and 102 deletions.
diff --git a/README.md b/README.md
@@ -7,10 +7,11 @@
 [![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://stackoverflow.com/questions/tagged/flutter?sort=votes)
 [![FlutterCandies](https://pub.idqqimg.com/wpa/images/group.png)](https://jq.qq.com/?_wv=1027&k=5bcc0gy)
 
-Compresses image as native plugin (Obj-C/Kotlin). This library works on Android and iOS.
+Compresses image as native plugin (Obj-C/Kotlin). This library works on Android, iOS, macOS, Web, OpenHarmony.
 
 - [flutter\_image\_compress](#flutter_image_compress)
   - [Why don't you use dart to do it](#why-dont-you-use-dart-to-do-it)
+  - [Platform Features](#platform-features)
   - [Usage](#usage)
   - [About common params](#about-common-params)
     - [minWidth and minHeight](#minwidth-and-minheight)
@@ -33,7 +34,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
   - [About EXIF information](#about-exif-information)
   - [Web](#web)
   - [About macOS](#about-macos)
-  - [Platform Features](#platform-features)
+  - [OpenHarmony](#openharmony)
 
 ## Why don't you use dart to do it
 
@@ -42,6 +43,25 @@ Q：Dart already has image compression libraries. Why use native?
 A：For unknown reasons, image compression in Dart language is not efficient,
 even in release version. Using isolate does not solve the problem.
 
+## Platform Features
+
+| Feature                    | Android |  iOS  |           Web           | macOS | OpenHarmony |
+| :------------------------- | :-----: | :---: | :---------------------: | :---: | :-------: |
+| method: compressWithList   |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressAssetImage |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressWithFile   |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| format: jpeg               |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: png                |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |   ❌   |     ✅     |
+| format: heic               |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |   ✅   |     ✅     |
+| param: rotate              |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: keepExif            |    ✅    |   ✅   |            ❌            |   ✅   |     ❌     |
+
+[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
+
+
 ## Usage
 
 See the [![pub](https://img.shields.io/pub/v/flutter_image_compress.svg)](https://pub.dev/packages/flutter_image_compress/versions) version.
@@ -368,20 +388,11 @@ Open xcode project, select Runner target, and change the value of `macOS Deploym
 And, change the `Podfile`:
 Change `platform` to `platform :osx, '10.15'`.
 
-## Platform Features
 
-| Feature                    | Android |  iOS  |           Web           | macOS |
-| :------------------------- | :-----: | :---: | :---------------------: | :---: |
-| method: compressWithList   |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressAssetImage |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressWithFile   |    ✅    |   ✅   |            ❌            |  ✅   |
-| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |  ✅   |
-| format: jpeg               |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: png                |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |  ❌   |
-| format: heic               |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |  ✅   |
-| param: rotate              |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: keepExif            |    ✅    |   ✅   |            ❌            |  ✅   |
+## OpenHarmony
+
+The currently supported image formats for parsing include JPEG, PNG, GIF, RAW, WebP, BMP, and SVG. However, the encoding output image formats are currently limited to JPEG, PNG, and WebP only.
+
+当前支持的解析图片格式包括 JPEG、PNG、GIF、RAW、WebP、BMP、SVG . 编码输出图片格式当前仅支持 JPEG、PNG 和 WebP.
+
 
-[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
diff --git a/packages/flutter_image_compress/README.md b/packages/flutter_image_compress/README.md
@@ -7,10 +7,11 @@
 [![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://stackoverflow.com/questions/tagged/flutter?sort=votes)
 [![FlutterCandies](https://pub.idqqimg.com/wpa/images/group.png)](https://jq.qq.com/?_wv=1027&k=5bcc0gy)
 
-Compresses image as native plugin (Obj-C/Kotlin). This library works on Android and iOS.
+Compresses image as native plugin (Obj-C/Kotlin). This library works on Android, iOS, macOS, Web, OpenHarmony.
 
 - [flutter\_image\_compress](#flutter_image_compress)
   - [Why don't you use dart to do it](#why-dont-you-use-dart-to-do-it)
+  - [Platform Features](#platform-features)
   - [Usage](#usage)
   - [About common params](#about-common-params)
     - [minWidth and minHeight](#minwidth-and-minheight)
@@ -33,7 +34,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
   - [About EXIF information](#about-exif-information)
   - [Web](#web)
   - [About macOS](#about-macos)
-  - [Platform Features](#platform-features)
+  - [OpenHarmony](#openharmony)
 
 ## Why don't you use dart to do it
 
@@ -42,6 +43,25 @@ Q：Dart already has image compression libraries. Why use native?
 A：For unknown reasons, image compression in Dart language is not efficient,
 even in release version. Using isolate does not solve the problem.
 
+## Platform Features
+
+| Feature                    | Android |  iOS  |           Web           | macOS | OpenHarmony |
+| :------------------------- | :-----: | :---: | :---------------------: | :---: | :-------: |
+| method: compressWithList   |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressAssetImage |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressWithFile   |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| format: jpeg               |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: png                |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |   ❌   |     ✅     |
+| format: heic               |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |   ✅   |     ✅     |
+| param: rotate              |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: keepExif            |    ✅    |   ✅   |            ❌            |   ✅   |     ❌     |
+
+[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
+
+
 ## Usage
 
 See the [![pub](https://img.shields.io/pub/v/flutter_image_compress.svg)](https://pub.dev/packages/flutter_image_compress/versions) version.
@@ -368,20 +388,11 @@ Open xcode project, select Runner target, and change the value of `macOS Deploym
 And, change the `Podfile`:
 Change `platform` to `platform :osx, '10.15'`.
 
-## Platform Features
 
-| Feature                    | Android |  iOS  |           Web           | macOS |
-| :------------------------- | :-----: | :---: | :---------------------: | :---: |
-| method: compressWithList   |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressAssetImage |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressWithFile   |    ✅    |   ✅   |            ❌            |  ✅   |
-| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |  ✅   |
-| format: jpeg               |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: png                |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |  ❌   |
-| format: heic               |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |  ✅   |
-| param: rotate              |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: keepExif            |    ✅    |   ✅   |            ❌            |  ✅   |
+## OpenHarmony
+
+The currently supported image formats for parsing include JPEG, PNG, GIF, RAW, WebP, BMP, and SVG. However, the encoding output image formats are currently limited to JPEG, PNG, and WebP only.
+
+当前支持的解析图片格式包括 JPEG、PNG、GIF、RAW、WebP、BMP、SVG . 编码输出图片格式当前仅支持 JPEG、PNG 和 WebP.
+
 
-[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
diff --git a/packages/flutter_image_compress_common/README.md b/packages/flutter_image_compress_common/README.md
@@ -7,10 +7,11 @@
 [![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://stackoverflow.com/questions/tagged/flutter?sort=votes)
 [![FlutterCandies](https://pub.idqqimg.com/wpa/images/group.png)](https://jq.qq.com/?_wv=1027&k=5bcc0gy)
 
-Compresses image as native plugin (Obj-C/Kotlin). This library works on Android and iOS.
+Compresses image as native plugin (Obj-C/Kotlin). This library works on Android, iOS, macOS, Web, OpenHarmony.
 
 - [flutter\_image\_compress](#flutter_image_compress)
   - [Why don't you use dart to do it](#why-dont-you-use-dart-to-do-it)
+  - [Platform Features](#platform-features)
   - [Usage](#usage)
   - [About common params](#about-common-params)
     - [minWidth and minHeight](#minwidth-and-minheight)
@@ -33,7 +34,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
   - [About EXIF information](#about-exif-information)
   - [Web](#web)
   - [About macOS](#about-macos)
-  - [Platform Features](#platform-features)
+  - [OpenHarmony](#openharmony)
 
 ## Why don't you use dart to do it
 
@@ -42,6 +43,25 @@ Q：Dart already has image compression libraries. Why use native?
 A：For unknown reasons, image compression in Dart language is not efficient,
 even in release version. Using isolate does not solve the problem.
 
+## Platform Features
+
+| Feature                    | Android |  iOS  |           Web           | macOS | OpenHarmony |
+| :------------------------- | :-----: | :---: | :---------------------: | :---: | :-------: |
+| method: compressWithList   |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressAssetImage |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressWithFile   |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| format: jpeg               |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: png                |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |   ❌   |     ✅     |
+| format: heic               |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |   ✅   |     ✅     |
+| param: rotate              |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: keepExif            |    ✅    |   ✅   |            ❌            |   ✅   |     ❌     |
+
+[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
+
+
 ## Usage
 
 See the [![pub](https://img.shields.io/pub/v/flutter_image_compress.svg)](https://pub.dev/packages/flutter_image_compress/versions) version.
@@ -368,20 +388,11 @@ Open xcode project, select Runner target, and change the value of `macOS Deploym
 And, change the `Podfile`:
 Change `platform` to `platform :osx, '10.15'`.
 
-## Platform Features
 
-| Feature                    | Android |  iOS  |           Web           | macOS |
-| :------------------------- | :-----: | :---: | :---------------------: | :---: |
-| method: compressWithList   |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressAssetImage |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressWithFile   |    ✅    |   ✅   |            ❌            |  ✅   |
-| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |  ✅   |
-| format: jpeg               |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: png                |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |  ❌   |
-| format: heic               |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |  ✅   |
-| param: rotate              |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: keepExif            |    ✅    |   ✅   |            ❌            |  ✅   |
+## OpenHarmony
+
+The currently supported image formats for parsing include JPEG, PNG, GIF, RAW, WebP, BMP, and SVG. However, the encoding output image formats are currently limited to JPEG, PNG, and WebP only.
+
+当前支持的解析图片格式包括 JPEG、PNG、GIF、RAW、WebP、BMP、SVG . 编码输出图片格式当前仅支持 JPEG、PNG 和 WebP.
+
 
-[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
diff --git a/packages/flutter_image_compress_macos/README.md b/packages/flutter_image_compress_macos/README.md
@@ -7,10 +7,11 @@
 [![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://stackoverflow.com/questions/tagged/flutter?sort=votes)
 [![FlutterCandies](https://pub.idqqimg.com/wpa/images/group.png)](https://jq.qq.com/?_wv=1027&k=5bcc0gy)
 
-Compresses image as native plugin (Obj-C/Kotlin). This library works on Android and iOS.
+Compresses image as native plugin (Obj-C/Kotlin). This library works on Android, iOS, macOS, Web, OpenHarmony.
 
 - [flutter\_image\_compress](#flutter_image_compress)
   - [Why don't you use dart to do it](#why-dont-you-use-dart-to-do-it)
+  - [Platform Features](#platform-features)
   - [Usage](#usage)
   - [About common params](#about-common-params)
     - [minWidth and minHeight](#minwidth-and-minheight)
@@ -33,7 +34,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
   - [About EXIF information](#about-exif-information)
   - [Web](#web)
   - [About macOS](#about-macos)
-  - [Platform Features](#platform-features)
+  - [OpenHarmony](#openharmony)
 
 ## Why don't you use dart to do it
 
@@ -42,6 +43,25 @@ Q：Dart already has image compression libraries. Why use native?
 A：For unknown reasons, image compression in Dart language is not efficient,
 even in release version. Using isolate does not solve the problem.
 
+## Platform Features
+
+| Feature                    | Android |  iOS  |           Web           | macOS | OpenHarmony |
+| :------------------------- | :-----: | :---: | :---------------------: | :---: | :-------: |
+| method: compressWithList   |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressAssetImage |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| method: compressWithFile   |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| format: jpeg               |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: png                |    ✅    |   ✅   |            ✅            |   ✅   |     ✅     |
+| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |   ❌   |     ✅     |
+| format: heic               |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |   ✅   |     ✅     |
+| param: rotate              |    ✅    |   ✅   |            ❌            |   ✅   |     ✅     |
+| param: keepExif            |    ✅    |   ✅   |            ❌            |   ✅   |     ❌     |
+
+[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
+
+
 ## Usage
 
 See the [![pub](https://img.shields.io/pub/v/flutter_image_compress.svg)](https://pub.dev/packages/flutter_image_compress/versions) version.
@@ -368,20 +388,11 @@ Open xcode project, select Runner target, and change the value of `macOS Deploym
 And, change the `Podfile`:
 Change `platform` to `platform :osx, '10.15'`.
 
-## Platform Features
 
-| Feature                    | Android |  iOS  |           Web           | macOS |
-| :------------------------- | :-----: | :---: | :---------------------: | :---: |
-| method: compressWithList   |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressAssetImage |    ✅    |   ✅   |            ✅            |  ✅   |
-| method: compressWithFile   |    ✅    |   ✅   |            ❌            |  ✅   |
-| method: compressAndGetFile |    ✅    |   ✅   |            ❌            |  ✅   |
-| format: jpeg               |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: png                |    ✅    |   ✅   |            ✅            |  ✅   |
-| format: webp               |    ✅    |   ✅   | [🌐][webp-compatibility] |  ❌   |
-| format: heic               |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: quality             |    ✅    |   ✅   | [🌐][webp-compatibility] |  ✅   |
-| param: rotate              |    ✅    |   ✅   |            ❌            |  ✅   |
-| param: keepExif            |    ✅    |   ✅   |            ❌            |  ✅   |
+## OpenHarmony
+
+The currently supported image formats for parsing include JPEG, PNG, GIF, RAW, WebP, BMP, and SVG. However, the encoding output image formats are currently limited to JPEG, PNG, and WebP only.
+
+当前支持的解析图片格式包括 JPEG、PNG、GIF、RAW、WebP、BMP、SVG . 编码输出图片格式当前仅支持 JPEG、PNG 和 WebP.
+
 
-[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"