2.5.0

Author: xiaolongrick

.gitignore

@@ -79,3 +79,7 @@ android/keystores/debug.keystore
 lib/
 .github/
 /example/ios/Podfile.lock
+tsconfig.typedoc.json
+typedoc.json
+docs/
+package-lock.json

.npmignore

@@ -78,3 +78,5 @@ android/keystores/debug.keystore
 # generated by bob
 lib/
 .github/
+tsconfig.typedoc.json
+typedoc.json

API.md

@@ -1,5 +1,40 @@
 ## Newest Release
 
+### 2.5.0 - 23 Oct. 2025
+New Features
+1. Added the features support for ComPDFKit PDF SDK for iOS V2.5.0.
+2. Added the features support for ComPDFKit PDF SDK for Android V2.5.0.
+3. Added Spanish language support.
+4. Added API to render PDF pages as images
+5. Added API for creating forms
+6. Added watermark configuration options
+7. Added configurable border color for search results
+8. Added configurable highlight color for search results
+9. Added rectangle drawing when jumping to a page
+10. Added API to set content editing types
+11. Added configuration for page editing menu options
+12. Added UI mode configuration
+13. Added bottom toolbar UI configuration
+14. Added BOTA interface configuration
+15. Added control for showing and hiding the search view
+16. Added API to save ongoing Ink annotations
+17. Added API to hide the context menu
+18. Added theme mode configuration on iOS
+19. Added signature method configuration on iOS
+20. Added Pencil annotation toolbar configuration on iOS
+
+Issues Addressed
+1. Fixed crash on Android caused by empty arrays in shape annotation properties
+2. Fixed issue where FreeText input was not properly centered on Android
+3. Fixed inconsistency between FreeText font size and the configured value on Android
+4. Fixed an issue where some documents crashed when opened on Android.
+5. Fixed an issue where content edits were not saved correctly on Android.
+6.  Fixed issue where imported FreeText annotations might not display on iOS
+7. Fixed issue where the watermark toolbar would not appear when the top toolbar was hidden on iOS
+
+
+## Previous Release
+
 ### 2.4.7 - 12 Sep. 2025
 New Features
 1. Added the features support for ComPDFKit PDF SDK for iOS V2.4.7.
@@ -11,11 +46,7 @@ New Features
 7. Fixed an issue where some documents failed to correctly trigger callbacks for the first or last page.
 
 
-
-## Previous Release
-
 ### 2.4.6 - 29 Aug. 2025
-
 1. Updated iOS ComPDFKit PDF SDK to version 2.4.6.
 2. Updated Android ComPDFKit PDF SDK to version 2.4.6.
 3. Added compatibility for Android 15 and Android 16.

CHANGELOG.md

@@ -94,11 +94,11 @@ Used to configure the initial display mode and supported modes when displaying a
 
 ##### **Parameters**
 
-| Name               | Type    | Description                                                  |
-| ------------------ | ------- | ------------------------------------------------------------ |
-| initialViewMode    | string  | Default mode to display when opening the PDF View, default is `viewer` |
-| availableViewModes | string  | Configure supported modes                                    |
-| readerOnly         | boolean | View only PDF documents, hiding all top and bottom toolbars.<br />**ComPDFKit SDK for Flutter Version:** => 2.0.2 |
+| Name               | Type   | Description                                                  |
+| ------------------ | ------ | ------------------------------------------------------------ |
+| initialViewMode    | string | Default mode to display when opening the PDF View, default is `viewer` |
+| availableViewModes | string | Configure supported modes                                    |
+| uiVisibilityMode   | string | Used to set the UI visibility mode<br/>**automatic**: Toolbars at the top and bottom are automatically shown or hidden when tapping on the PDF page<br/>**always**: Toolbars are always visible <br/>**never**: Toolbars are never displayed |
 
 ##### **Constants**
 
@@ -114,7 +114,7 @@ Used to configure the initial display mode and supported modes when displaying a
 {
   "modeConfig": {
     "initialViewMode": "viewer",
-    "readerOnly": false,
+    "uiVisibilityMode": "automatic",
     "availableViewModes": [
       "viewer",
       "annotations",
@@ -141,6 +141,10 @@ Configure functions for the top toolbar in the PDF view.
 | mainToolbarVisible          | boolean | Whether to display the toolbar at the top of the main interface view. |
 | annotationToolbarVisible    | boolean | Shows or hides the annotation toolbar that appears at the bottom of the view when in annotation mode. |
 | showInkToggleButton         | boolean | Whether to display the toggle/slide and drawing state buttons in the upper-left corner when drawing ink annotations. |
+| contentEditorToolbarVisible | boolean | Show or hide the bottom toolbar in content editing mode      |
+| formToolbarVisible          | boolean | Show or hide the bottom toolbar in form mode                 |
+| signatureToolbarVisible     | boolean | Show or hide the bottom toolbar in signature mode            |
+|                             |         |                                                              |
 
 ##### **Constants**
 
@@ -153,22 +157,27 @@ Configure functions for the top toolbar in the PDF view.
 
 ##### **availableMenus Constants**
 
-| Name           | Description                                                |
-| -------------- | ---------------------------------------------------------- |
+| Name           | Description                                                  |
+| -------------- | ------------------------------------------------------------ |
 | viewSetting    | Settings related to PDF viewing, such as scroll direction and theme. |
 | documentEditor | Displays a list of PDF document thumbnails and allows page manipulation such as addition and deletion. |
-| documentInfo   | Displays information related to the PDF document.           |
+| documentInfo   | Displays information related to the PDF document.            |
 | watermark      | Adds text or image watermark to the document, saving it as a new document. |
-| security       | Sets viewing and permission passwords for the document.     |
+| security       | Sets viewing and permission passwords for the document.      |
 | flattened      | Flattens annotations and other content within the document, making annotations uneditable. |
-| save           | Saves the document.                                         |
-| share          | Shares the PDF document.                                    |
+| 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,
+    "contentEditorToolbarVisible" : true,
+    "annotationToolbarVisible" : true,
+    "formToolbarVisible" : true,
+    "signatureToolbarVisible" : true,
+    "showInkToggleButton": true,
     "androidAvailableActions": [
       "thumbnail",
       "search",
@@ -792,10 +801,11 @@ This section is used to configure the types of forms enabled in the view's botto
 | ----------------------- | ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | 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 |
+| watermark               | CPDFWatermarkConfig |                                                              | Watermark configuration when opening the Add Watermark view  |
 | thumbnail               | CPDFThumbnail       | {   "title" : "",   <br />"backgroundColor": "",  <br /> "editMode" : true <br />} |                                                              |
+| enableErrorTips         | boolean             | true \| false                                                | Whether to enable error prompts. For example, if a page cannot add a highlight annotation, setting this to false will prevent the prompt message from appearing. |
+| 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 |
+| bota                    | CPDFBotaConfig      |                                                              | Used to configure the enabled feature types and menu options in the BOTA interface |
 
 ##### themeMode Constants
 
@@ -1040,15 +1050,13 @@ The context menu configuration in form mode displays different context menu opti
 }
 ```
 
-
-
 ## Json Example
 
 ```json
 {
   "modeConfig": {
     "initialViewMode": "viewer",
-    "readerOnly": false,
+    "uiVisibilityMode": "automatic",
     "availableViewModes": [
       "viewer",
       "annotations",
@@ -1059,7 +1067,10 @@ The context menu configuration in form mode displays different context menu opti
   },
   "toolbarConfig": {
     "mainToolbarVisible" : true,
+    "contentEditorToolbarVisible" : true,
     "annotationToolbarVisible" : true,
+    "formToolbarVisible" : true,
+    "signatureToolbarVisible" : true,
     "showInkToggleButton": true,
     "androidAvailableActions": [
       "thumbnail",
@@ -1310,23 +1321,87 @@ The context menu configuration in form mode displays different context menu opti
     "pageSpacing": 10,
     "margins" : [0,0,0,0],
     "pageScale": 1.0,
-    "pageSameWidth": true
+    "pageSameWidth": true,
+    "enableMinScale": true
   },
   "global" : {
     "themeMode" : "system",
     "fileSaveExtraFontSubset" : true,
     "watermark": {
-      "saveAsNewFile" : true,
-      "outsideBackgroundColor" : ""
+      "types" : [ "text" , "image" ],
+      "saveAsNewFile" : false,
+      "outsideBackgroundColor" : "",
+      "text" : "",
+      "image" : "tools_logo",
+      "textSize" : 40,
+      "textColor" : "#FF000000",
+      "scale" : 1.5,
+      "rotation" : 0,
+      "opacity" : 255,
+      "isFront" : false,
+      "isTilePage" : false
     },
-    "signatureType": "manual",
-    "enableExitSaveTips" : true,
     "thumbnail": {
       "title" : "",
       "backgroundColor": "",
       "editMode" : true
     },
-    "enableErrorTips" : true
+    "bota": {
+      "tabs": ["outline", "bookmark", "annotations"],
+      "menus": {
+        "annotations": {
+          "global": [
+            { "id": "importAnnotation" },
+            { "id": "exportAnnotation" },
+            { "id": "removeAllAnnotation" },
+            { "id": "removeAllReply" }
+          ],
+          "item": [
+            { "id": "reviewStatus",
+              "subMenus": [
+                "accepted",
+                "rejected",
+                "cancelled",
+                "completed",
+                "none"
+              ]
+            },
+            { "id": "markedStatus" },
+            {
+              "id": "more",
+              "subMenus": [
+                "addReply",
+                "viewReply",
+                "delete"
+              ]
+            }
+          ]
+        }
+      }
+    },
+    "signatureType": "manual",
+    "enableExitSaveTips" : true,
+    "enableErrorTips" : true,
+    "search": {
+      "normalKeyword": {
+        "borderColor": "#00000000",
+        "fillColor": "#77FFFF00"
+      },
+      "focusKeyword": {
+        "borderColor": "#00000000",
+        "fillColor": "#CCFD7338"
+      }
+    },
+    "pageEditor": {
+      "menus": [
+        "insertPage",
+        "replacePage",
+        "extractPage",
+        "copyPage",
+        "rotatePage",
+        "deletePage"
+      ]
+    }
   },
   "contextMenuConfig" : {
     "global": {

CONFIGURATION.md

@@ -152,8 +152,8 @@ open ios/Podfile
 ```diff
 target 'MyApp' do
     # ...
-+  pod "ComPDFKit", podspec:'https://file.compdf.com/cocoapods/ios/compdfkit_pdf_sdk/2.4.7/ComPDFKit.podspec'
-+  pod "ComPDFKit_Tools", podspec:'https://file.compdf.com/cocoapods/ios/compdfkit_pdf_sdk/2.4.7/ComPDFKit_Tools.podspec'
++  pod "ComPDFKit", podspec:'https://file.compdf.com/cocoapods/ios/compdfkit_pdf_sdk/2.5.0/ComPDFKit.podspec'
++  pod "ComPDFKit_Tools", podspec:'https://file.compdf.com/cocoapods/ios/compdfkit_pdf_sdk/2.5.0/ComPDFKit_Tools.podspec'
     # ...
 end
 ```
@@ -163,8 +163,8 @@ end
 ```diff
 target 'MyApp' do
     # ...
-+  pod 'ComPDFKit', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.4.7'
-+  pod 'ComPDFKit_Tools', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.4.7'
++  pod 'ComPDFKit', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.5.0'
++  pod 'ComPDFKit_Tools', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.5.0'
     # ...
 end
 ```

README.md

@@ -2,6 +2,8 @@ buildscript {
   repositories {
     google()
     mavenCentral()
+    maven { url 'https://central.sonatype.com/repository/maven-snapshots/' }
+
   }
 
   dependencies {
@@ -81,7 +83,7 @@ dependencies {
   compileOnly fileTree(include: ['*.jar','*.aar'], dir: 'libs')
   implementation "com.facebook.react:react-native:+"
 
-  api "com.compdf:compdfkit-tools:2.4.7"
+  api "com.compdf:compdfkit-tools:2.5.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'