https://github.com/benjamineruvieru/react-native-pdf-from-image
Generate PDF documents from an array of images.
https://github.com/benjamineruvieru/react-native-pdf-from-image
image-to-pdf pdf-generation pdf-generation-react react-native
Last synced: 9 months ago
JSON representation
Generate PDF documents from an array of images.
- Host: GitHub
- URL: https://github.com/benjamineruvieru/react-native-pdf-from-image
- Owner: benjamineruvieru
- License: mit
- Created: 2025-01-29T14:19:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-04T12:39:06.000Z (about 1 year ago)
- Last Synced: 2025-09-12T23:47:16.365Z (10 months ago)
- Topics: image-to-pdf, pdf-generation, pdf-generation-react, react-native
- Language: Kotlin
- Homepage: https://docs.benjamineruvieru.com/docs/react-native-pdf-from-image/
- Size: 3.12 MB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
React Native Pdf From Image Library
Generate PDF documents from an array of images.
## 🌟 Features
- **Image to PDF Conversion**: Effortlessly convert images into PDF documents.
- **Customizable Paper Sizes**: Choose from standard paper sizes or define custom dimensions for your PDFs.
## Old Architecture Support
~~react-native-pdf-from-image is a pure TurboModule, and **requires the new architecture to be enabled**.~~
~~- Work is ongoing to support the old architecture.~~
The library now supports both new and old architecture! 🎉🎉🎉
## 🚀 Installation
```sh
npm install react-native-pdf-from-image
```
or
```sh
yarn add react-native-pdf-from-image
```
```sh
cd ios && pod install
```
## 📖 Usage
Here's a basic example of how to use the library:
```js
import { createPdf } from 'react-native-pdf-from-image';
const images = ['path/to/image1.jpg'];
const { filePath } = createPdf({
imagePaths: images,
name: 'myPdf',
paperSize: 'A4', // optional
// optional
customPaperSize: {
height: 300,
width: 300,
},
});
```
> **Note:** When using the old architecture, make sure to await the `createPdf` function as it returns a Promise.
```js
import { createPdf } from 'react-native-pdf-from-image';
// Old Architecture
const generatePdf = async () => {
const images = ['path/to/image1.jpg'];
const { filePath } = await createPdf({
imagePaths: images,
name: 'myPdf',
paperSize: 'A4', // optional
// optional
customPaperSize: {
height: 300,
width: 300,
},
});
};
```
## 📦 Props
### createPdf(params)
- params : An object containing the following properties:
- imagePaths (Array of strings): An array of file paths to the images you want to include in the PDF.
- name (string): The name of the PDF file to be created.
- paperSize (string, optional): The size of the paper for the PDF. Common sizes like 'A4' are supported.
- customPaperSize (object, optional): An object specifying custom dimensions for the paper size. It should have height and width properties.
### Returns
- An object containing:
- filePath (string): The file path to the generated PDF document.
> **Note:** If neither paperSize or customPaperSize is passed then the image dimensions would be used as the paper size of the pdf.
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
```
```