https://github.com/renderpdf-io/renderpdf-laravel
RenderPDF.io Library for Laravel projects
https://github.com/renderpdf-io/renderpdf-laravel
html2pdf html2pdf-api htmltopdf htmltopdf-api laravel laravel-library pdf render-pdf
Last synced: about 2 months ago
JSON representation
RenderPDF.io Library for Laravel projects
- Host: GitHub
- URL: https://github.com/renderpdf-io/renderpdf-laravel
- Owner: renderpdf-io
- License: mit
- Created: 2024-07-31T07:01:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T14:22:03.000Z (almost 2 years ago)
- Last Synced: 2025-12-14T14:44:18.359Z (6 months ago)
- Topics: html2pdf, html2pdf-api, htmltopdf, htmltopdf-api, laravel, laravel-library, pdf, render-pdf
- Language: PHP
- Homepage: https://renderpdf.io
- Size: 95.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Render HTML to PDF for Laravel - RenderPDF.io Laravel Driver
[](https://github.com/renderpdf-io/renderpdf-laravel/actions/workflows/build.yml)
[](https://codecov.io/gh/renderpdf-io/renderpdf-laravel)
[RenderPDF.io](https://renderpdf.io) provides awesome & developer-friendly APIs to convert HTML to PDF.
This is a Laravel package provides an easy integration with **RenderPDF.io**
## Requirement
- PHP 8.1 and above
- Laravel 10 and above
## Installation
```bash
composer install renderpdf-io/renderpdf-laravel
```
Note: for Laravel 10 users, you need to install `GuzzleHTTP` too.
Add the `services.renderpdf-io.key` config into your `config/services.php` (required):
```php
// config/services.php
return [
'renderpdf-io' => [
'key' => env('RENDER_PDF_IO_API_KEY'),
],
];
```
## Usage
### Facade style
Simply use the `RenderPdfIo` facade
```php
use RenderPdfIo\RenderPdfIo;
use RenderPdfIo\Services\RenderPdfOptions;
public function renderPdf()
{
$fileUrl = RenderPdfIo::render(new RenderPdfOptions(
htmlContent: '
This is a new PDF
',
));
}
```
### Dependency Injection style
In case you want to use DI style, we got you:
```php
use RenderPdfIo\Services\RenderPdfIoService;
use RenderPdfIo\Services\RenderPdfOptions;
class InvoiceController
{
public function download(RenderPdfIoService $renderPdfService)
{
$fileUrl = $renderPdfService->render(new RenderPdfOptions(
htmlContent: '
This is a new PDF using DI
',
));
}
}
```
See all the available options here: [RenderPdfOptions.php](./src/Services/RenderPdfOptions.php)
## Contributing
Thank you for your consideration to contribute to Laravel library of RenderPDF.io, please feel free to:
- Open an issue for bug reports.
- Submit a PR for improvements/enhancements.
## License
This library is free to use, under [MIT License](./LICENSE).