https://github.com/chaudharydeepanshu/pdf_manipulator
A flutter plugin for doing various manipulations such as merge, split, compress and many more on PDF easily.
https://github.com/chaudharydeepanshu/pdf_manipulator
compress dart decrypt encrypt flutter images-to-pdf merge pdf reorder rotate split
Last synced: 8 months ago
JSON representation
A flutter plugin for doing various manipulations such as merge, split, compress and many more on PDF easily.
- Host: GitHub
- URL: https://github.com/chaudharydeepanshu/pdf_manipulator
- Owner: chaudharydeepanshu
- License: agpl-3.0
- Created: 2022-09-24T14:17:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T14:01:52.000Z (over 1 year ago)
- Last Synced: 2025-02-05T13:47:10.652Z (over 1 year ago)
- Topics: compress, dart, decrypt, encrypt, flutter, images-to-pdf, merge, pdf, reorder, rotate, split
- Language: Kotlin
- Homepage: https://pub.dev/packages/pdf_manipulator
- Size: 239 KB
- Stars: 8
- Watchers: 1
- Forks: 11
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/pdf_manipulator) [](https://wakatime.com/badge/user/83f3b15d-49de-4c01-b8de-bbc132f11be1/project/db0907ad-0c7e-49cb-bbbb-a0fba05b6bc9)
## Word from creator
**Hello👋, This package is completely compatible with flutter and it also supports using Android Uri of picked file to work with which offers some real benefits such as manipulating them without caching or validating them without caching.**
**Yes, without a doubt, giving a free 👍 or ⭐ will encourage me to keep working on this plugin.**
## Package description
A flutter plugin for doing various manipulations such as merge, split, compress and many more on PDF easily.
**Note:** This project utilises itext7 for various operations involving PDFs and since itext7 AGPL V3 License is used in this plugin, it is also licenced under this licence. The project/plugin developer, the owner of the copyright, and the contributors are not accountable or liable for any damage resulting from this project/plugin.
## Features
- Works on Android 5.0 (API level 21) or later.
- Works with both absolute file path and Android native Uri.
- Supports merging multiple PDFs.
- Supports splitting PDF.
- Supports rotating PDF pages.
- Supports deleting PDF pages.
- Supports reordering PDF pages.
- Supports rotating, deleting, reordering PDF pages at the same time for more efficiency.
- Supports compressing PDF.
- Supports watermarking PDF.
- Supports encrypting PDF.
- Supports decrypting PDF.
- Supports converting images to PDF.
- Supports getting PDF validity and protection info.
- Supports getting PDF page size info.
**Note:** To use it in realease mode you will need to create a file named proguard-rules.pro in your project Android->App->proguard-rules.pro. In that file you need to add the below block of text at the end of the file.
```
# To use iText in release mode Otherwise we get
# PlatformException AbstractITextEvent is only for internal usage.
-keep public class com.itextpdf.**
-keep public class org.apache.**
```
For reference see this [project file](https://github.com/chaudharydeepanshu/files_tools/blob/main/android/app/proguard-rules.pro).
Then, setup your App->build.gradle buildTypes release config as done in this [project file](https://github.com/chaudharydeepanshu/files_tools/blob/54774ecf28d37c2a27d4fc666f7b178ad84ac46b/android/app/build.gradle#L77).
If you don't do all of this then you will get PlatformException: AbstractITextEvent is only for internal usage in Release build.
**Note:** If you are getting errors in you IDE after updating this plugin to newer version and the error contains works like Redeclaration, Conflicting declarations, Overload resolution ambiguity then to fix that you probably need to remove the older version of plugin from pub cache `C:\Users\username\AppData\Local\Pub\Cache\hosted\pub.dev\older_version` or simply run `flutter clean`.
## Getting started
- In pubspec.yaml, add this dependency:
```yaml
pdf_manipulator:
```
- Add this package to your project:
```dart
import 'package:pdf_manipulator/pdf_manipulator.dart';
```
## Basic Usage
### Merging multiple PDFs
```dart
String? mergedPdfPath = await PdfManipulator().mergePDFs(
params: PDFMergerParams(pdfsPaths: [pdfPath1, padfPath2]),
);
```
### Spliting PDF
```dart
String? mergedPdfPath = await PdfManipulator().mergePDFs(
params: PDFMergerParams(pdfsPaths: [pdfPath1, padfPath2]),
);
```
#### Split PDF by page count
```dart
List? splitPdfPaths = await PdfManipulator().splitPDF(
params: PDFSplitterParams(pdfPath: pdfPath, pageCount: 2),
);
```
#### Split PDF by size
```dart
List? splitPdfPaths = await PdfManipulator().splitPDF(
params: PDFSplitterParams(pdfPath: pdfPath, byteSize: splitSize),
);
```
#### Split PDF by page numbers
```dart
List? splitPdfPaths = await PdfManipulator().splitPDF(
params: PDFSplitterParams(pdfPath: pdfPath, pageNumbers: [2, 5]),
);
```
#### Extract PDF pages by page range
```dart
List? splitPdfPaths = await PdfManipulator().splitPDF(
params: PDFSplitterParams(pdfPath: pdfPath, pageRanges: ["2", "5-10"]),
);
```
### Rotaing PDF pages
```dart
String? rotatedPagesPdfPath = await PdfManipulator().pdfPageRotator(
params: PDFPageRotatorParams(pdfPath: pdfPath, pagesRotationInfo: [PageRotationInfo(pageNumber: 1, rotationAngle: 180)]),
);
```
### Deleting PDF pages
```dart
String? deletedPagesPdfPath = await PdfManipulator().pdfPageDeleter(
params: PDFPageDeleterParams(pdfPath: pdfPath, pageNumbers: [1, 2, 3]),
);
```
### Reordering PDF pages
```dart
String? reorderedPagesPdfPath = await PdfManipulator().pdfPageReorder(
params: PDFPageReorderParams(pdfPath: pdfPath, pageNumbers: [4, 1]),
);
```
### Rotating, Deleting, Reordering PDF pages at the same time
```dart
String? rotatedDeletedReorderedPagesPdfPath = await PdfManipulator().pdfPageRotatorDeleterReorder(
params: PDFPageRotatorDeleterReorderParams(
pdfPath: pdfPath,
pagesRotationInfo: [PageRotationInfo(pageNumber: 1, rotationAngle: 180)],
pageNumbersForReorder: [4, 3, 2, 1],
pageNumbersForDeleter: [3, 2]),
);
```
### Compressing PDF
```dart
String? compressedPdfPath = await PdfManipulator().pdfCompressor(
params: PDFCompressorParams(pdfPath: pdfPath, imageQuality: 100, imageScale: 1),
);
```
### Watermarking PDF
```dart
String? watermarkedPdfPath = await PdfManipulator().pdfWatermark(
params: PDFWatermarkParams(
pdfPath: pdfPath,
text: "Watermark Text",
watermarkColor: Colors.red,
fontSize: 50,
watermarkLayer: WatermarkLayer.overContent,
opacity: 0.7,
positionType: PositionType.center),
);
```
**Note:** When using `PositionType.custom` you need to provide `customPositionXCoordinatesList` and `customPositionYCoordinatesList`.
### Encrypting PDF
```dart
String? encryptedPdfPath = await PdfManipulator().pdfEncryption(
params: PDFEncryptionParams(
pdfPath: pdfPath,
ownerPassword: "ownerpw",
userPassword: "userpw",
encryptionAES256: true // Set true to enable encryptionAES256 encryption.
);
```
`PDFEncryptionParams` other parameters with their default values is as follows:-
- `bool allowPrinting = false` Set true to allow printing permission.
- `bool allowModifyContents = false` Set true to allow modify permission.
- `bool allowCopy = false` Set true to allow copy permission.
- `bool allowModifyAnnotations = false` Set true to allow modifying annotations permission.
- `bool allowFillIn = false` Set true to allow fill in permission.
- `bool allowScreenReaders = false` Set true to allow screen readers permission.
- `bool allowAssembly = false` Set true to allow assembly permission.
- `bool allowDegradedPrinting = false` Set true to allow degraded printing permission.
- `bool standardEncryptionAES40 = false` Set true to enable StandardEncryptionAES40 encryption. standardEncryptionAES40 implicitly sets doNotEncryptMetadata and encryptEmbeddedFilesOnly as false.
- `bool standardEncryptionAES128 = false` Set true to enable StandardEncryptionAES128 encryption. standardEncryptionAES128 implicitly sets EncryptionConstants.EMBEDDED_FILES_ONLY as false.
- `bool encryptionAES128 = false` Set true to enable encryptionAES128 encryption.
- `bool encryptEmbeddedFilesOnly = false` Set true to encrypt embedded files only.
- `bool doNotEncryptMetadata = false` Set true to not encrypt metadata.
**Note:** Please be aware that the passed encryption types may override permissions.
### Decrypting PDF
```dart
String? decryptedPdfPath = await PdfManipulator().pdfDecryption(
params: PDFDecryptionParams(
pdfPath: pdfPath,
password: ownerOrUserPassword,
);
```
### Converting images to PDF
```dart
List? pdfsPaths = await PdfManipulator().imagesToPdfs(
params: ImagesToPDFsParams(
imagesPaths: imagesPaths,
createSinglePdf: false,
);
```
Images in JPEG, JPEG2000, GIF, PNG, BMP, WMF, TIFF, CCITT and JBIG2 formats are supported.
### PDF validity and protection info
```dart
PdfValidityAndProtection? pdfValidityAndProtectionInfo = await PdfManipulator().pdfValidityAndProtection(
params: PDFValidityAndProtectionParams(
pdfPath: pdfPath,
);
/// Getting info.
bool? isPDFValid = pdfValidityAndProtectionInfo?.isPDFValid;
bool? isOwnerPasswordProtected = pdfValidityAndProtectionInfo?.isOwnerPasswordProtected;
bool? isOpenPasswordProtected = pdfValidityAndProtectionInfo?.isOpenPasswordProtected;
bool? isPrintingAllowed = pdfValidityAndProtectionInfo?.isPrintingAllowed;
bool? isModifyContentsAllowed = pdfValidityAndProtectionInfo?.isModifyContentsAllowed;
```
Don't provide password if you just want to check validity and protection. Only provide password if you want to check if that password is correct or not.
**Note:** If you only want to check validity and protection then I suggest to use [pdf_bitmaps](https://pub.dev/packages/pdf_bitmaps) as that is fast and requires less memory.
### PDF page size info
```dart
List? pdfPagesSizeInfo = await PdfManipulator().pdfPagesSize(
params: PDFPagesSizeParams(
pdfPath: pdfPath,
);
/// Getting 1st page info.
double? widthOfPage = pdfPagesSizeInfo[0]?.widthOfPage;
double? heightOfPage = pdfPagesSizeInfo[0]?.heightOfPage;
```
**Note:** If you only want to get page size then I suggest to use [pdf_bitmaps](https://pub.dev/packages/pdf_bitmaps) as that is fast and requires less memory.
Note: To try the demos shown in below images run the example included in this plugin.
