compdfkit(rn) - v2.4.0

Author: xiaolongrick

API.md

@@ -1091,6 +1091,33 @@ const pages = [0, 1, 2];
 const result = await pdfReaderRef.current?.splitDocumentPages(savePath, pages);
 ```
 
+#### insertBlankPage
+
+Inserts a blank page at the specified index in the document.
+
+This method allows adding a blank page of a specified size at a specific index within the PDF document.
+It is useful for document editing scenarios where page insertion is needed.
+
+Parameters:
+
+| Name      | Type         | Description                                                  |
+| --------- | ------------ | ------------------------------------------------------------ |
+| pageIndex | number       | The index position where the blank page will be inserted. Must be a valid index within the document. |
+| pageSize  | CPDFPageSize | The size of the blank page to insert. Defaults to A4 size if not specified. |
+
+Returns a Promise.
+
+| Name   | Type | Description                                                  |
+| ------ | ---- | ------------------------------------------------------------ |
+| result | bool | A Promise that resolves to a boolean value indicating the success or failure of the blank page insertion. Resolves to `true` if the insertion was successful, `false` otherwise. |
+
+```tsx
+const pageSize = CPDFPageSize.a4;
+// Custom page size
+// const pageSize = new CPDFPageSize(500, 800);
+const result = await pdfRef.current?._pdfDocument.insertBlankPage(0, pageSize);
+```
+
 ### Annotations
 
 #### import Annotations
@@ -1170,6 +1197,34 @@ const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
 const annotations = await page?.getAnnotations();
 ```
 
+#### removeAnnotation
+
+Removes the specified annotation from the PDF document
+
+Parameters:
+
+| Name       | Type           | Description                   |
+| ---------- | -------------- | ----------------------------- |
+| annotation | CPDFAnnotation | The annotation to be removed. |
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name   | Type    | Description                                                 |
+| ------ | ------- | ----------------------------------------------------------- |
+| result | boolean | **true**: remove successful,<br />**false**: remove failed. |
+
+```tsx
+await pdfReaderRef?.current?._pdfDocument.removeAnnotation(annotation);
+// or use
+const pageIndex = 0;
+const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
+const widgets = await page?.getWidgets();
+const widgetToRemove = widgets[0];
+await page?.removeWidget(widgetToRemove);
+```
+
 #### flattenAllPages
 
 Flatten all pages of the current document.
@@ -1326,6 +1381,34 @@ await signatureWidget.addImageSignature('/path/to/image');
 await signatureWidget.updateAp();
 ```
 
+#### removeWidget
+
+Removes the specified widget from the PDF document
+
+Parameters:
+
+| Name   | Type       | Description               |
+| ------ | ---------- | ------------------------- |
+| widget | CPDFWidget | The widget to be removed. |
+
+Returns a Promise.
+
+Promise Parameters:
+
+| Name   | Type    | Description                                                 |
+| ------ | ------- | ----------------------------------------------------------- |
+| result | boolean | **true**: remove successful,<br />**false**: remove failed. |
+
+```tsx
+await pdfReaderRef?.current?._pdfDocument.removeWidget(widget);
+// or use
+const pageIndex = 0;
+const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
+const annotations = await page?.getAnnotations();
+const annotationToRemove = annotations[0];
+await page?.removeAnnotation(annotationToRemove);
+```
+
 ### Security
 
 #### isEncrypted

CHANGELOG.md

@@ -1,5 +1,30 @@
 ## Newest Release
 
+### 2.4.0 - 15 May. 2025
+
+1. Added the features support for ComPDFKit PDF SDK for iOS V2.4.0.  
+2. Added the features support for ComPDFKit PDF SDK for Android V2.4.0.
+3. Added configuration options for signature methods in signature form fields on Android.
+4. Added a document save reminder when exiting the interface on Android.
+5. Added functionality to erase existing Ink annotations on Android.
+6. Added APIs to delete annotations and form fields.
+7. Added an API to insert blank pages.
+8. Enhanced annotation property data.
+9. Enhanced form field property data.
+10. Fixed OOM crash issues on some devices during SDK initialization.
+11. Fixed an issue where signature appearance was not correctly displayed after digital signing.
+12. Fixed an issue where images failed to display after adding a watermark to certain documents.
+13. Fixed an issue that prevented inserting PNG images when inserting pages.
+14. Fixed incorrect handling of `ActionType_GoToR` and `ActionType_Launch` in hyperlink annotations.
+15. Fixed an issue where long input in electronic signatures within `ComPDFKit_Tools` caused incomplete display after saving.
+16. Fixed blurry display issue after zooming in on text annotations.
+17. Fixed jump behavior of `CPDFReaderView.setScale() `scaling method.
+18. Fixed a font inconsistency issue during content editing when adding text to already selected text with an existing device font.
+
+
+
+## Previous Release
+
 ### 2.3.0 - 21 Mar. 2025
 
 1. Added the features support for ComPDFKit PDF SDK for iOS iOS V2.3.0.
@@ -22,8 +47,6 @@
 18. Fixed the issue of Chinese garbled characters in the form name.
 19. Fixed the issue where the prompt did not appear for scanned PDF documents on iOS.
 
-## Previous Release
-
 ### 2.3.0-beta.1 - 28 Feb. 2025
 
 * Added import/export interface for form data in XFDF format files.

CONFIGURATION.md

@@ -213,24 +213,25 @@ Configure annotation-related settings, such as enabling types displayed in the a
 
 ##### **availableTypes Constants**
 
-| Name      |
-| --------- |
-| note      |
-| highlight |
-| underline |
-| squiggly  |
-| strikeout |
-| ink       |
-| circle    |
-| square    |
-| arrow     |
-| line      |
-| freetext  |
-| signature |
-| stamp     |
-| pictures  |
-| link      |
-| sound     |
+| Name       |
+| ---------- |
+| note       |
+| highlight  |
+| underline  |
+| squiggly   |
+| strikeout  |
+| ink        |
+| ink_eraser |
+| circle     |
+| square     |
+| arrow      |
+| line       |
+| freetext   |
+| signature  |
+| stamp      |
+| pictures   |
+| link       |
+| sound      |
 
 ##### availableTools Constants
 
@@ -366,6 +367,7 @@ Configure annotation-related settings, such as enabling types displayed in the a
       "squiggly",
       "strikeout",
       "ink",
+      "ink_eraser",
       "circle",
       "square",
       "arrow",
@@ -474,7 +476,7 @@ Switch to content editing mode to edit text and images. This configuration optio
 | -------------- | ----- | ------------------------------------------------------------ |
 | availableTypes | Array | Content editing mode, the editing mode displayed at the bottom of the view.<br>Default order: `editorText`, `editorImage` |
 | availableTools | Array | Available tools.<br/>including: `setting`, `undo`,`redo`     |
-| initAttribute  | obj   | 添加文本时的默认属性                                         |
+| initAttribute  | obj   | Default properties when adding text                          |
 
 * text
 
@@ -784,11 +786,13 @@ This section is used to configure the types of forms enabled in the view's botto
 
 ##### Parameters
 
-| Name                    | Type                | Example                      | Description                                                  |
-| ----------------------- | ------------------- | ---------------------------- | ------------------------------------------------------------ |
-| themeMode               | CPDFThemeMode       | light                        | Set the view theme style, support `light`, `dark`, `system`, the default is `light` theme<br />**ComPDFKit SDK for Flutter:** => 2.0.2<br />Only Android Platform. |
-| fileSaveExtraFontSubset | boolean             | true                         | When saving a document, whether to save the used font set together with the document. |
-| watermark               | CPDFWatermarkConfig | {   "saveAsNewFile" : true } | The user can configure the watermark addition popup, allowing them to choose whether to save the watermark directly to the current document or save it to a different directory.<br>**true**: Save to a different directory<br>**false**: Add to the current document directly |
+| Name                    | Type                | Example                                                      | Description                                                  |
+| ----------------------- | ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| themeMode               | CPDFThemeMode       | light                                                        | Set the view theme style, support `light`, `dark`, `system`, the default is `light` theme<br />**ComPDFKit SDK for Flutter:** => 2.0.2<br />Only Android Platform. |
+| fileSaveExtraFontSubset | boolean             | true                                                         | When saving a document, whether to save the used font set together with the document. |
+| watermark               | CPDFWatermarkConfig | {   "saveAsNewFile" : true, <br />"outsideBackgroundColor: ""<br />} | The user can configure the watermark addition popup, allowing them to choose whether to save the watermark directly to the current document or save it to a different directory.<br>**true**: Save to a different directory<br>**false**: Add to the current document directly |
+| signatureType           | String              | manual                                                       | Used to configure the default signing method when signing in the form field of CPDFReaderView.<br />Type:<br />* manual<br />* digital<br />* electronic |
+| enableExitSaveTips      | boolean             | true \| false                                                | When exiting, check if the document has been modified and prompt to save the document |
 
 ##### themeMode Constants
 
@@ -854,6 +858,7 @@ This section is used to configure the types of forms enabled in the view's botto
       "squiggly",
       "strikeout",
       "ink",
+      "ink_eraser",
       "circle",
       "square",
       "arrow",
@@ -1069,8 +1074,11 @@ This section is used to configure the types of forms enabled in the view's botto
     "themeMode" : "system",
     "fileSaveExtraFontSubset" : true,
     "watermark": {
-      "saveAsNewFile" : true
-    }
+      "saveAsNewFile" : true,
+      "outsideBackgroundColor" :""
+    },
+    "signatureType": "manual",
+    "enableExitSaveTips" : true
   }
 }
 ```

README.md

@@ -6,6 +6,9 @@
 
 [ComPDFKit for React Native](https://www.compdf.com/react-native) allows you to quickly and seamlessly add PDF functions to any React Native application, elevating your Android and iOS apps with annotations, content editing, conversion, data extraction, etc.
 
+Watch the video here:
+[![image](https://img.youtube.com/vi/2ug2nPkuOy4/maxresdefault.jpg)](https://youtu.be/2ug2nPkuOy4)
+
 ## Related
 
 - [ComPDFKit PDF Library for iOS](https://github.com/ComPDFKit/PDF-SDK-iOS)
@@ -17,6 +20,8 @@
 
 ## Prerequisites
 
+A development environment for running React Native projects using the React Native CLI. If you're using **Expo**, check out our [integration guide docs](./docs/How to Use ComPDFKit PDF SDK for ReactNative with Expo.md) on the topic.
+
 * A license is required for trial. Please contact our [sales team](https://www.compdf.com/contact-sales) to obtain a free trial license.
 * npm or yarn
 * ComPDFKit SDK => 2.0.1
@@ -115,8 +120,8 @@ open ios/Podfile
 ```diff
 target 'MyApp' do
     # ...
-+    pod "ComPDFKit", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit/2.3.0.podspec'
-+  pod "ComPDFKit_Tools", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit_tools/2.3.0.podspec'
++    pod "ComPDFKit", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit/2.4.0.podspec'
++  pod "ComPDFKit_Tools", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit_tools/2.4.0.podspec'
     # ...
 end
 ```
@@ -126,8 +131,8 @@ end
 ```diff
 target 'MyApp' do
     # ...
-+  pod 'ComPDFKit', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.3.0'
-+  pod 'ComPDFKit_Tools', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.3.0'
++  pod 'ComPDFKit', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.4.0'
++  pod 'ComPDFKit_Tools', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.4.0'
     # ...
 end
 ```

android/build.gradle

@@ -78,16 +78,14 @@ repositories {
 
   mavenCentral()
   google()
-  maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
-
 }
 
 
 dependencies {
   compileOnly fileTree(include: ['*.jar','*.aar'], dir: 'libs')
   implementation "com.facebook.react:react-native:+"
 
-  api "com.compdf:compdfkit-tools:2.3.0"
+  api "com.compdf:compdfkit-tools:2.4.0"
   api 'com.github.bumptech.glide:glide:4.15.1'
   annotationProcessor 'com.github.bumptech.glide:compiler:4.15.1'
   api 'androidx.documentfile:documentfile:1.0.1'

android/src/main/java/com/compdfkitpdf/reactnative/CompdfkitPdfModule.java

@@ -22,6 +22,7 @@
 
 import androidx.annotation.NonNull;
 
+import com.compdfkit.core.document.CPDFAbility;
 import com.compdfkit.core.document.CPDFSdk;
 import com.compdfkit.tools.common.pdf.CPDFConfigurationUtils;
 import com.compdfkit.tools.common.pdf.CPDFDocumentActivity;
@@ -117,6 +118,7 @@ public void init_(String license, Promise promise) {
     CPDFSdk.init(mReactContext, license, true, (code, msg) -> {
       Log.d(TAG, "init_: code:" + code + ", msg:" + msg);
       promise.resolve(code == CPDFSdk.VERIFY_SUCCESS);
+      CPDFAbility.checkLicenseAllAbility();
     });
   }
 

android/src/main/java/com/compdfkitpdf/reactnative/modules/CPDFViewModule.java

@@ -489,6 +489,28 @@ public void addWidgetImageSignature(int tag, int pageIndex, String uuid, String
     });
   }
 
+  @ReactMethod
+  public void removeAnnotation(int tag, int pageIndex, String uuid, Promise promise) {
+    uiBlock(nativeViewHierarchyManager -> {
+      promise.resolve(mPDFViewInstance.removeAnnotation(tag, pageIndex, uuid));
+    });
+  }
+
+  @ReactMethod
+  public void removeWidget(int tag, int pageIndex, String uuid, Promise promise){
+    uiBlock(nativeViewHierarchyManager -> {
+      promise.resolve(mPDFViewInstance.removeWidget(tag, pageIndex, uuid));
+    });
+  }
+
+  @ReactMethod
+  public void insertBlankPage(int tag, int pageIndex, int width, int height, Promise promise){
+    uiBlock(nativeViewHierarchyManager -> {
+      promise.resolve(mPDFViewInstance.insertBlankPage(tag, pageIndex, width, height));
+    });
+  }
+
+
   private void uiBlock(UIBlock uiBlock) {
     UIManagerModule uiManager = getReactApplicationContext().getNativeModule(UIManagerModule.class);
     if (uiManager != null) {

android/src/main/java/com/compdfkitpdf/reactnative/util/CAppUtils.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright © 2014-2025 PDF Technologies, Inc. All Rights Reserved.
+ *
+ * THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
+ * AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE ComPDFKit LICENSE AGREEMENT.
+ * UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
+ * This notice may not be removed from this file.
+ *
+ */
+
+package com.compdfkitpdf.reactnative.util;
+
+
+import androidx.annotation.ColorInt;
+import com.facebook.react.bridge.Arguments;
+import com.facebook.react.bridge.WritableArray;
+
+public class CAppUtils {
+
+
+  public static String toHexColor(@ColorInt int color){
+    int rgb = color & 0x00FFFFFF;
+    String hex = Integer.toHexString(rgb).toUpperCase();
+    while (hex.length() < 6) {
+      hex = "0" + hex;
+    }
+    return "#" + hex;
+  }
+
+  public static WritableArray intArrayToWritableArray(int[] intArray) {
+    WritableArray writableArray = Arguments.createArray();
+    if (intArray != null) {
+      for (int value : intArray) {
+        writableArray.pushInt(value);
+      }
+    }
+    return writableArray;
+  }
+}