spatie/browsershot

Convert a webpage to an image or pdf using headless Chrome

, _(*1)

Convert a webpage to an image or pdf using headless Chrome

, _(*2)

The package can convert a webpage to an image or pdf. The conversion is done behind the scenes by Puppeteer which controls a headless version of Google Chrome., _(*3)

Here's a quick example:, _(*4)

use Spatie\Browsershot\Browsershot;

// an image will be saved
Browsershot::url('https://example.com')->save($pathToImage);

It will save a pdf if the path passed to the save method has a pdf extension., _(*5)

// a pdf will be saved
Browsershot::url('https://example.com')->save('example.pdf');

You can also use an arbitrary html input, simply replace the url method with html:, _(*6)

Browsershot::html('<h1>Hello world!!</h1>')->save('example.pdf');

If your HTML input is already in a file locally use the :, _(*7)

Browsershot::htmlFromFilePath('/local/path/to/file.html')->save('example.pdf');

Browsershot also can get the body of an html page after JavaScript has been executed:, _(*8)

Browsershot::url('https://example.com')->bodyHtml(); // returns the html of the body

If you wish to retrieve an array list with all of the requests that the page triggered you can do so:, _(*9)

$requests = Browsershot::url('https://example.com')
    ->triggeredRequests();

foreach ($requests as $request) {
    $url = $request['url']; //https://example.com/
}

To use Chrome's new headless mode pass the newHeadless method:, _(*10)

Browsershot::url('https://example.com')->newHeadless()->save($pathToImage);

Support us

Learn how to create a package like this one, by watching our premium video course:, _(*11)

, _(*12)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*13)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*14)

Documentation

All documentation is available on our documentation site., _(*15)

Testing

For running the testsuite, you'll need to have Puppeteer installed. Pleaser refer to the Browsershot requirements here. Usually npm -g i puppeteer will do the trick., _(*16)

Additionally, you'll need the pdftotext CLI which is part of the poppler-utils package. More info can be found in in the spatie/pdf-to-text readme. Usually brew install poppler-utils will suffice., _(*17)

Finally run the tests with:, _(*18)

composer test

Contributing

Please see CONTRIBUTING for details., _(*19)

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., _(*20)

Alternatives

If you're not able to install Node and Puppeteer, take a look at v2 of browsershot, which uses Chrome headless CLI to take a screenshot. v2 is not maintained anymore, but should work pretty well., _(*21)

If using headless Chrome does not work for you take a look at at v1 of this package which uses the abandoned PhantomJS binary., _(*22)

Credits

• Freek Van der Herten
• All Contributors

And a special thanks to Caneco for the logo ✨, _(*23)

License

The MIT License (MIT). Please see License File for more information., _(*24)