yassin/ypdf

Y-PDF: Headless browser PDF generator for Laravel supporting full HTML/CSS/JS stacks.

Installs: 7

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/yassin/ypdf

v0.1.5 2025-12-08 08:41 UTC

This package is auto-updated.

Last update: 2025-12-08 08:42:05 UTC


README

A Laravel-ready package that uses a headless Chromium instance to render full HTML, CSS, JavaScript, Bootstrap, Tailwind, and jQuery experiences into pixel-perfect PDFs. Stop fighting traditional PHP PDF libraries that ignore styles — render the same markup your frontend already produces.

Highlights

  • Uses chrome-php/chrome, so anything Chromium can paint (Vue, React, Livewire, Blade + Tailwind, etc.) will appear in the PDF.
  • Simple API: YPdf::renderFromView() and YPdf::renderFromHtml() return binary data or save directly to disk.
  • Configurable viewport, margins, background printing, sandbox flags, and custom wait strategies before capturing the PDF.
  • Ships with a publishable config file so each project can point to its own Chromium binary, temp directory, and timeouts.
  • Designed to live inside its own repository — drop this folder into a separate git repo, push to GitHub, and submit to Packagist. Afterwards, require it in any Laravel app with Composer.

Package Structure

packages/
└── imar/
    └── ypdf/
        ├── composer.json
        ├── config/ypdf.php
        ├── src/
        │   ├── Contracts/
        │   ├── Drivers/
        │   ├── Facades/
        │   ├── YPdfManager.php
        │   └── YPdfServiceProvider.php
        └── README.md

Installation (after publishing to Packagist)

composer require yassin/ypdf

# Install the headless Chrome adapter only if you plan to use it
composer require chrome-php/chrome

php artisan vendor:publish --tag=ypdf-config

Want to write your own driver or call a remote rendering API instead? Set YPDF_DRIVER to a custom driver name and bind an implementation of YPdf\Contracts\PdfEngine in a service provider—no Chromium dependency required.

Ensure Chromium is installed on the server, or point HEADLESS_PDF_CHROME_BINARY to a bundled binary. Example .env entries:

YPDF_CHROME_BINARY=/usr/bin/google-chrome-stable
YPDF_TEMP=/var/tmp/ypdf
YPDF_NO_SANDBOX=true

Usage

use YPdf;

// Render a Blade view straight to disk
YPdf::renderFromViewToFile('pdfs.invoice', ['order' => $order], storage_path('app/pdfs/order.pdf'));

// Grab the binary and stream it to the browser
return response(
    YPdf::renderFromHtml($html),
    200,
    ['Content-Type' => 'application/pdf']
);

Need to render an authenticated page? Generate a signed URL and call YPdf::renderFromUrl($url).

Roadmap

  • Additional drivers (Playwright, remote rendering service)
  • Queued rendering + retry helpers
  • HTML pre-processors for asset inlining and critical CSS extraction

Contributions welcome once the package is in its own repository!