PHPackages                             netflex/renderer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. netflex/renderer

ActiveLibrary[PDF & Document Generation](/categories/documents)

netflex/renderer
================

High level API for working with the Netflex Foundation PDF generator

v6.4.0(2mo ago)0694↑50%2MITPHPPHP ^8.2

Since May 20Pushed 2mo agoCompare

[ Source](https://github.com/netflex-sdk/renderer)[ Packagist](https://packagist.org/packages/netflex/renderer)[ Docs](https://github.com/netflex-sdk/renderer)[ RSS](/packages/netflex-renderer/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (12)Versions (304)Used By (2)

Netflex Renderer
================

[](#netflex-renderer)

[![Stable version](https://camo.githubusercontent.com/a5f3ed332e4023b48a1ee33384fe545b87aa09f3dfbbb891ddafc240c3a3e93e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6e6574666c65782f72656e64657265723f6c6162656c3d737461626c65)](https://packagist.org/packages/netflex/renderer)[![Build status](https://github.com/netflex-sdk/framework/actions/workflows/split_monorepo.yaml/badge.svg)](https://github.com/netflex-sdk/framework/actions/workflows/split_monorepo.yaml)[![License: MIT](https://camo.githubusercontent.com/4ab654ac03c01efe43cce5fc4de153c5bef02688bd1f4d004ffd69ac63c31211/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e6574666c65782d73646b2f6c6f672e737667)](https://opensource.org/licenses/MIT)[![Contributors](https://camo.githubusercontent.com/e01836b76903338fa30a2133b13b6a0ae9710f22af63bd0f66128df370003623/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f6e6574666c65782d73646b2f73646b2e7376673f636f6c6f723d677265656e)](https://github.com/netflex-sdk/sdk/graphs/contributors)[![Downloads](https://camo.githubusercontent.com/b724d1a873677176d3a7d09ae3c8c338d4219c6ef15f78bdfbc5e92adccc8db9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f6e6574666c65782f72656e6465726572)](https://packagist.org/packages/netflex/renderer/stats)

\[READ ONLY\] Subtree split of the Netflex Renderer component (see [netflex/framework](https://github.com/netflex-sdk/framework))

This package provides a high-level builder interface for generating PDF's, images, and server side rendering of HTML.

Full API reference is [available here](https://netflex-sdk.github.io/docs/api/Netflex/Render.html).

Table of contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Usage](#usage)
    - [Generating PDF/JPG/PNG/HTML](#generating-pdfjpgpnghtml)
        - [From raw HTML](#from-raw-html)
        - [By rendering a View](#by-rendering-a-view)
        - [By rendering a named Route](#by-rendering-a-named-route)
        - [By rendering a URL](#by-rendering-a-url)
    - [Setting pixel ratio](#setting-pixel-ratio)
    - [Specifying a timeout](#specifying-a-timeout)
    - [Waiting for the document to load](#waiting-for-the-document-to-load)
    - [Retrieving the rendered content](#retrieving-the-rendered-content)
- [PDF](#pdf)
    - [Specify page ranges](#specify-page-ranges)
    - [Print background](#print-background)
    - [Margings](#margings)
    - [Paper format](#paper-format)
    - [Document scaling](#document-scaling)
    - [Explicit size](#explicit-size)
    - [Landscape mode](#landscape-mode)
    - [Set size from CSS](#set-size-from-css)
    - [Setting custom header and footer](#setting-custom-header-and-footer)
        - [Outputting page numbers etc.](#outputting-page-numbers-etc)
        - [Page break utilities](#page-break-utilities)
    - [Tags and metadata](#tags-and-metadata)
- [Images](#images)
    - [Setting viewport size](#setting-viewport-size)
    - [Capturing a specific element using a CSS selector](#capturing-a-specific-element-use-a-css-selector)
    - [Clip](#clip)
    - [Full page](#full-page)
    - [JPG](#jpg)
        - [Quality](#quality)
    - [PNG](#png)
        - [Transparent](#transparent)
- [HTML](#html)
    - [Server Side Rendering (SSR)](#server-side-rendering-ssr)
- [MJML](#mjml)
    - [Usage in Mailable](#usage-in-mailable)
- [View macros](#view-macros)

Installation
------------

[](#installation)

```
composer require netflex/renderer
```

Usage
-----

[](#usage)

### Generating PDF/JPG/PNG/HTML

[](#generating-pdfjpgpnghtml)

These methods also applies to the `HTML`, `PNG`, and `JPG` classes.

#### From raw HTML

[](#from-raw-html)

```