compdfkit(rn) - 2.2.0

Author: xiaolongrick

API.md

@@ -8,8 +8,6 @@ ComPDFKit React Native supports TypeScript. Types used in this document will be
 
 ComPDFKit contains static methods for global library initialization, configuration, and utility methods.
 
-
-
 ### init_
 
 Initialize the ComPDFKit SDK offline using your ComPDFKit commercial license key. Please contact our sales to obtain a trial license.
@@ -140,7 +138,6 @@ ComPDFKit.openDocument(document, '', ComPDFKit.getDefaultConfig({}))
 
 When using the `ComPDFKit.openDocument` method or the `CPDFReaderView` UI component to display a PDF file, you need to pass configuration parameters to customize the UI features and PDF view properties. `ComPDFKit` provides default configuration parameters through `ComPDFKit.getDefaultConfig`. You can retrieve them using the following example:
 
----
 
 ```tsx
 ComPDFKit.getDefaultConfig({})
@@ -198,6 +195,22 @@ ComPDFKit.getDefaultConfig({
 
 For more configuration parameter descriptions, please see [CPDFCONFIGURATION.md](./CONFIGURATION.md).
 
+### removeSignFileList
+
+Delete the signature saved in the electronic signature annotation list.
+
+Returns a Promise.
+
+| Name   | Type    | Description                                                  |
+| ------ | ------- | ------------------------------------------------------------ |
+| result | boolean | Returns `true` if the deletion was successful, otherwise returns `false`. |
+
+```tsx
+ComPDFKit.removeSignFileList();
+```
+
+
+
 ## CPDFReaderView - Props
 
 ### Open Document
@@ -274,5 +287,181 @@ Used to pass configuration parameters when rendering a PDF file to customize UI
   />
 ```
 
+### Document
+
+#### hasChange
+Checks whether the document has been modified.
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name      | Type    | Description                                                  |
+| --------- | ------- | ------------------------------------------------------------ |
+| hasChange | boolean | `true`: The document has been modified,   <br/>`false`: The document has not been modified. |
+
+```tsx
+const hasChange = await pdfReaderRef.current?.hasChange();
+```
+
+#### save
+
+Save the current document changes.
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name   | Type    | Description                                            |
+| ------ | ------- | ------------------------------------------------------ |
+| result | boolean | **true**: Save successful,<br/>**false**: Save failed. |
 
+```js
+const saveResult = await pdfReaderRef.current.save();
+```
+
+#### onSaveDocument
+
+function, optional
+
+This function will be called when the document is saved.
+
+Parameters:
+
+| Name       | Type | Description             |
+| ---------- | ---- | ----------------------- |
+| pageNumber | int  | the current page number |
+
+```tsx
+<CPDFReaderView
+	onSaveDocument={()=>{}}
+	/>
+```
+
+### Viewer
+
+#### setMargins
+
+Set the current PDF view margin.
+
+Parameters:
+
+| Name   | Type | Description   |
+| ------ | ---- | ------------- |
+| left   | int  | margin left   |
+| top    | int  | margin top    |
+| right  | int  | margin right  |
+| bottom | int  | margin bottom |
+
+```tsx
+await pdfReaderRef.current?.setMargins(10,10,10,10);
+```
+
+
+
+### Page
+
+#### setDisplayPageIndex
+
+Jump to the index page.
+
+Parameters:
+
+| Name      | Type | Description    |
+| --------- | ---- | -------------- |
+| pageIndex | int  | 需要跳转的页码 |
+
+```tsx
+await pdfReaderRef.current?.setDisplayPageIndex(1);
+```
+
+#### getCurrentPageIndex
+
+get current page index.
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name      | Type | Description                |
+| --------- | ---- | -------------------------- |
+| pageIndex | int  | 返回当前文档展示的页面索引 |
+
+```tsx
+const pageIndex = await pdfReaderRef.current?.getCurrentPageIndex();
+```
+
+#### onPageChanged
+
+function, optional
+
+This function is called when the page number has been changed.
+
+Parameters:
+
+| Name       | Type | Description             |
+| ---------- | ---- | ----------------------- |
+| pageNumber | int  | the current page number |
+
+```tsx
+<CPDFReaderView
+	onPageChanged={(pageIndex:number)=>{
+	}}
+  />
+```
+
+### Annotations
+
+#### import Annotations
+
+Imports annotations from the specified XFDF file into the current PDF document.
+
+Parameters:
+
+| Name     | Type   | Description                                                  |
+| -------- | ------ | ------------------------------------------------------------ |
+| xfdfFile | string | Path of the XFDF file to be imported.<br/>The Android platform supports the following paths：<br/>- **assets file**:'file:///android_assets/test.xfdf'<br/>- **file path**: '/data/xxx.xfdf'<br/>- **Uri**: 'content://xxxx' |
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name   | Type    | Description                                                |
+| ------ | ------- | ---------------------------------------------------------- |
+| result | boolean | **true**: import successful,<br/>**false**: import failed. |
+
+```tsx
+const result = await pdfReaderRef.current.importAnnotations('xxx.xfdf');
+```
+
+#### export Annotations
+Exports annotations from the current PDF document to an XFDF file.
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name     | Type   | Description                                                  |
+| -------- | ------ | ------------------------------------------------------------ |
+| xfdfPath | string | The path of the XFDF file if export is successful; an empty string if the export fails. |
+
+```tsx
+const exportXfdfFilePath = await pdfReaderRef.current?.exportAnnotations();
+```
+
+
+#### removeAllAnnotations
+Delete all comments in the current document.
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name   | Type    | Description |
+| ------ | ------- | ----------- |
+| result | boolean | true、false |
+
+```tsx
+const removeResult = await pdfReaderRef.current?.removeAllAnnotations();
+```
 

CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Newest Release
 
+### 2.2.0 - 13 Dec. 2024
+* Added features support for ComPDFKit PDF SDK for [Android V2.2.0](https://www.compdf.com/pdf-sdk/changelog-android#v2-2-0).
+* Added features support for ComPDFKit PDF SDK for [iOS V2.2.0](https://www.compdf.com/pdf-sdk/changelog-ios#v2-2-0).
+* Added import and export annotation interfaces.
+* Added delete all annotations interface.
+* Added get page number interface and page number listener callback.
+* Added save document callback.
+* Optimized document saving logic on iOS platform.
+
+
+
+## Previous Release
+
 ### 2.1.3-2 - 26 Sep 2024
 
 * Added the features support for ComPDFKit PDF SDK for Android V2.1.3.
@@ -11,8 +24,6 @@
 * Fixed crash when releasing watermarks.
 * Fixed memory leak in the property window of the ComPDFKit_Tools module.
 
-## Previous Release
-
 ### 2.1.3-1 - 25 Sep 2024
 
 * Added the features support for ComPDFKit PDF SDK for iOS V2.1.3.

CONFIGURATION.md

@@ -114,6 +114,7 @@ Used to configure the initial display mode and supported modes when displaying a
 {
   "modeConfig": {
     "initialViewMode": "viewer",
+    "readerOnly": false,
     "availableViewModes": [
       "viewer",
       "annotations",
@@ -131,12 +132,13 @@ Configure functions for the top toolbar in the PDF view.
 
 ##### **Parameters**
 
-| Name                        | Type  | Description                                                  |
-| --------------------------- | ----- | ------------------------------------------------------------ |
-| androidAvailableActions     | Array | Functions available in the top toolbar for Android platform.<br />Defaults: `thumbnail`, `search`, `bota`, `menu` |
-| iosLeftBarAvailableActions  | Array | Functions available in the left side of the top toolbar for iOS platform.<br />Defaults: `back`, `thumbnail` |
-| iosRightBarAvailableActions | Array | Functions available in the right side of the top toolbar for iOS platform.<br />Defaults: `search`, `bota`, `menu` |
-| availableMenus              | Array | A list of more functions popped up by the `menu` option on the top toolbar. |
+| Name                        | Type    | Description                                                  |
+| --------------------------- | ------- | ------------------------------------------------------------ |
+| androidAvailableActions     | Array   | Functions available in the top toolbar for Android platform.<br />Defaults: `thumbnail`, `search`, `bota`, `menu` |
+| iosLeftBarAvailableActions  | Array   | Functions available in the left side of the top toolbar for iOS platform.<br />Defaults: `back`, `thumbnail` |
+| iosRightBarAvailableActions | Array   | Functions available in the right side of the top toolbar for iOS platform.<br />Defaults: `search`, `bota`, `menu` |
+| availableMenus              | Array   | A list of more functions popped up by the `menu` option on the top toolbar. |
+| mainToolbarVisible          | boolean | 是否显示主界面视图顶部工具栏                                 |
 
 ##### **Constants**
 
@@ -160,9 +162,11 @@ Configure functions for the top toolbar in the PDF view.
 | save           | Saves the document.                                         |
 | share          | Shares the PDF document.                                    |
 | openDocument   | Opens the system file selector to choose and open a PDF document. |
+| snip           | The PDF capture function allows you to capture an area in the PDF document and convert it into an image. |
 ```json
 {
    "toolbarConfig": {
+    "mainToolbarVisible" : true,
     "androidAvailableActions": [
       "thumbnail",
       "search",
@@ -187,7 +191,8 @@ Configure functions for the top toolbar in the PDF view.
       "flattened",
       "save",
       "share",
-      "openDocument"
+      "openDocument",
+      "snip"
     ]
   }
 }
@@ -756,6 +761,7 @@ This section is used to configure the types of forms enabled in the view's botto
 | pageSpacing         | int     | 10           | Spacing between each page of the PDF.<br/>default `10px`.    |
 | pageScale           | double  | 1.0          | Page scale value, default 1.0.<br/>value range:1.0~5.0       |
 | pageSameWidth       | boolean | true         | only android platform.                                       |
+| margins             | Array   | [0,0,0,0]    | Set the outer spacing of the PDF area. The setting order is: left, top, right, bottom. |
 
 ##### displayMode Constants
 
@@ -809,6 +815,7 @@ This section is used to configure the types of forms enabled in the view's botto
     ]
   },
   "toolbarConfig": {
+    "mainToolbarVisible" : true,
     "androidAvailableActions": [
       "thumbnail",
       "search",
@@ -833,7 +840,8 @@ This section is used to configure the types of forms enabled in the view's botto
       "flattened",
       "save",
       "share",
-      "openDocument"
+      "openDocument",
+      "snip"
     ]
   },
   "annotationsConfig": {
@@ -1052,6 +1060,7 @@ This section is used to configure the types of forms enabled in the view's botto
     "enableSliderBar": true,
     "enablePageIndicator": true,
     "pageSpacing": 10,
+    "margins" : [0,0,0,0],
     "pageScale": 1.0,
     "pageSameWidth":true
   },