README

Official Laravel bridge for zentiq-labs/fast-pdf. Adds Blade view rendering, Facade access, and native Laravel HTTP response helpers. Powered by direct headless Chromium IPC. Zero Node.js. Zero Puppeteer.

Requirements

Requirement	Version
PHP	`^8.3`
Laravel	`^12.0`
zentiq-labs/fast-pdf	`^1.0`
Chromium / Google Chrome	Any headless-capable build

Installation

composer require zentiq-labs/laravel-fast-pdf

The service provider and FastPdf facade are auto-discovered via Laravel's package discovery.

Publish the config

php artisan vendor:publish --tag=fast-pdf-config

This copies config/fast-pdf.php into your application's config directory.

Quick Start

Via Facade

use ZentiqLabs\FastPdf\Laravel\Facades\FastPdf;

// Render a Blade view and return a download response
return FastPdf::fromView('invoices.pdf', ['invoice' => $invoice])
    ->landscape()
    ->withTailwind()
    ->download('invoice-001.pdf');

// Render inline in the browser
return FastPdf::fromHtml($html)->inline('report.pdf');

Via Dependency Injection

use ZentiqLabs\FastPdf\Laravel\FastPdfManager;

class InvoiceController extends Controller
{
    public function __construct(private readonly FastPdfManager $pdf) {}

    public function download(Invoice $invoice): Response
    {
        return $this->pdf
            ->fromView('pdf.invoice', compact('invoice'))
            ->paperSize('a4')
            ->download("invoice-{$invoice->number}.pdf");
    }
}

Configuration

After publishing, edit config/fast-pdf.php. Key options:

Key	Default	Description
`binary`	(auto-discovered)	Absolute path to the Chromium binary
`timeout`	`30`	Max seconds per render
`paper_size`	`a4`	Default paper size
`orientation`	`portrait`	`portrait` or `landscape`
`emulate_media`	`print`	CSS media type: `print` or `screen`
`containerized`	`false`	Set `true` inside Docker/Alpine
`allow_local_file_access`	`false`	Enable only for fully trusted HTML
`chromium_flags`	`['--disable-dev-shm-usage']`	Extra Chromium CLI flags

Environment variables

Variable	Description
`FAST_PDF_BINARY`	Absolute path to the Chromium binary
`FAST_PDF_TIMEOUT`	Render timeout in seconds
`FAST_PDF_CONTAINERIZED`	`true` when running in Docker
`FAST_PDF_ALLOW_LOCAL_FILE_ACCESS`	`true` to enable local file reads

Fluent Builder API

FastPdfManager returns a LaravelPdfBuilder. All methods are chainable.

Method	Description
`fromView(string $view, array $data = [])`	Render a Blade view as the PDF source
`fromHtml(string $html)`	Use a raw HTML string as the source
`fromFile(string $path, array $data = [])`	Render a PHP template file as the source
`paperSize(PaperSize\|string $size)`	Set paper size
`landscape()`	Landscape orientation
`portrait()`	Portrait orientation
`margins(float $t, float $r, float $b, float $l, string $unit = 'mm')`	Override margins
`withTailwind()`	Inject standalone Tailwind CDN
`emulateMedia(string $media = 'print')`	CSS media type
`output(): string`	Return raw binary PDF bytes
`save(string $path): void`	Write to a file path
`download(string $filename = 'document.pdf'): Response`	Browser download response
`inline(string $filename = 'document.pdf'): Response`	Inline browser response

Blade Template Example

{{-- resources/views/pdf/invoice.blade.php --}}
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Invoice {{ $invoice->number }}</title>
</head>
<body>
    <h1>Invoice #{{ $invoice->number }}</h1>
    <p>Total: ${{ number_format($invoice->total, 2) }}</p>
</body>
</html>

return FastPdf::fromView('pdf.invoice', ['invoice' => $invoice])
    ->withTailwind()
    ->download("invoice-{$invoice->number}.pdf");

Docker and Alpine Linux

FROM php:8.3-fpm-alpine
RUN apk add --no-cache chromium
ENV FAST_PDF_BINARY=/usr/bin/chromium-browser
ENV FAST_PDF_CONTAINERIZED=true

In config/fast-pdf.php or .env:

FAST_PDF_CONTAINERIZED=true

Testing

composer test

With coverage:

composer test:coverage

Static analysis (PHPStan level 9):

composer check

Code style (PSR-12):

composer cs

Contributing

Contributions, issues, and feature requests are welcome. Please ensure any pull request:

Targets the develop branch.
Ships with corresponding test coverage for all new behaviour.
Passes the full CI pipeline (test, check, cs) locally before opening a PR.
Follows Conventional Commits.

License

The MIT License (MIT). See LICENSE for details.

Developed and maintained by Usman Khan at Zentiq Labs.

zentiq-labs / laravel-fast-pdf

Package info

Security

Statistics