PHPackages spatie/browsershot - 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. spatie/browsershot ActiveLibrary[PDF & Document Generation](/categories/documents) spatie/browsershot ================== Convert a webpage to an image or pdf using headless Chrome 5.2.3(2mo ago)5.2k32.1M—1.2%509[1 PRs](https://github.com/spatie/browsershot/pulls)20MITPHPPHP ^8.2CI passing Since May 2Pushed 3w ago55 watchersCompare [ Source](https://github.com/spatie/browsershot)[ Packagist](https://packagist.org/packages/spatie/browsershot)[ Docs](https://github.com/spatie/browsershot)[ GitHub Sponsors](https://github.com/spatie)[ RSS](/packages/spatie-browsershot/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (6)Versions (173)Used By (20)Security (10) [ ![Logo for Browsershot](https://camo.githubusercontent.com/a2dbd6419927c821feb7594ad13df6de9a5c96c8c813b574f9ffcc69bfb6c6a3/68747470733a2f2f7370617469652e62652f7061636b616765732f6865616465722f62726f7773657273686f742f68746d6c2f6c696768742e77656270) ](https://spatie.be/open-source?utm_source=github&utm_medium=banner&utm_campaign=browsershot)Render web pages to an image or PDF with Puppeteer ================================================== [](#render-web-pages-to-an-image-or-pdf-with-puppeteer) [![Latest Version](https://camo.githubusercontent.com/75305e58f66561b3701658b8899f040d309c704922fd28ebd687d15612523fa6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f7370617469652f62726f7773657273686f742e7376673f7374796c653d666c61742d737175617265)](https://github.com/spatie/browsershot/releases)[![MIT Licensed](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![run-tests](https://camo.githubusercontent.com/a5fd9a05744659e0313b5fbfbe974cc732bb688060f18866ced9183eb5692871/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7370617469652f62726f7773657273686f742f72756e2d74657374732e796d6c3f6c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/spatie/browsershot/actions)[![Total Downloads](https://camo.githubusercontent.com/79c514091011985df8233d43398e4008deffa00e65f79b2de2c51a2d26c15458/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f62726f7773657273686f742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/browsershot) The package can convert a web page to an image or PDF. The conversion is done behind the scenes by [Puppeteer](https://github.com/GoogleChrome/puppeteer) which runs a headless version of Google Chrome. Here's a quick example: ``` 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. ``` // 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`: ``` Browsershot::html('Hello world!!')->save('example.pdf'); ``` If your HTML input is already in a file locally use the : ``` 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: ``` 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: ``` $requests = Browsershot::url('https://example.com') ->triggeredRequests(); foreach ($requests as $request) { $url = $request['url']; //https://example.com/ } ``` To use Chrome's new [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome) pass the `newHeadless` method: ``` Browsershot::url('https://example.com')->newHeadless()->save($pathToImage); ``` Support us ---------- [](#support-us) Learn how to create a package like this one, by watching our premium video course: [![Laravel Package training](https://camo.githubusercontent.com/4c7f3720a29525e627f6004ee367e55def510e45d18e6bc974725812fa5cf257/68747470733a2f2f7370617469652e62652f6769746875622f7061636b6167652d747261696e696e672e6a7067)](https://laravelpackage.training) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). 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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). Documentation ------------- [](#documentation) All documentation is available [on our documentation site](https://spatie.be/docs/browsershot). Testing ------- [](#testing) For running the testsuite, you'll need to have Puppeteer installed. Pleaser refer to the Browsershot requirements [here](https://spatie.be/docs/browsershot/v4/requirements). Usually `npm -g i puppeteer` will do the trick. 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](https://github.com/spatie/pdf-to-text?tab=readme-ov-file#requirements). Usually `brew install poppler-utils` will suffice. Finally run the tests with: ``` composer test ``` Contributing ------------ [](#contributing) Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. Security -------- [](#security) If you've found a bug regarding security please mail instead of using the issue tracker. Alternatives ------------ [](#alternatives) If you're not able to install Node and Puppeteer, take a look at [v2 of browsershot](https://github.com/spatie/browsershot/tree/2.4.1), which uses Chrome headless CLI to take a screenshot. `v2` is not maintained anymore, but should work pretty well. If using headless Chrome does not work for you take a look at at `v1` of this package which uses the abandoned `PhantomJS` binary. Credits ------- [](#credits) - [Freek Van der Herten](https://github.com/freekmurze) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 83 — ExcellentBetter than 100% of packages Maintenance90 Actively maintained with recent releases Popularity80 Widely adopted with strong download metrics Community52 Growing community involvement Maturity94 Battle-tested with a long release history Bus Factor1 Top contributor holds 66.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~25 days Total 171 Last Release 89d ago Major Versions 1.9.1 → 2.0.02017-07-03 2.4.1 → 3.0.02017-10-16 2.4.2 → 3.15.02018-01-20 v3.x-dev → 4.0.02023-12-29 4.4.0 → 5.0.02024-11-25 PHP version history (6 changes)0.1.0PHP >=5.4.0 2.0.0PHP ^7.0 3.20.1PHP ^7.1 3.40.3PHP ^7.4|^8.0 3.59.0PHP ^8.0 4.0.0PHP ^8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/7535935?v=4)[Spatie](/maintainers/spatie)[@spatie](https://github.com/spatie) --- Top Contributors [![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (399 commits)")[![AlexVanderbist](https://avatars.githubusercontent.com/u/6287961?v=4)](https://github.com/AlexVanderbist "AlexVanderbist (23 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (23 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (14 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (13 commits)")[![vitorfigueiraacin](https://avatars.githubusercontent.com/u/177525390?v=4)](https://github.com/vitorfigueiraacin "vitorfigueiraacin (12 commits)")[![rubenvanassche](https://avatars.githubusercontent.com/u/619804?v=4)](https://github.com/rubenvanassche "rubenvanassche (12 commits)")[![Nielsvanpach](https://avatars.githubusercontent.com/u/10651054?v=4)](https://github.com/Nielsvanpach "Nielsvanpach (10 commits)")[![ziaratban](https://avatars.githubusercontent.com/u/6462878?v=4)](https://github.com/ziaratban "ziaratban (7 commits)")[![timvandijck](https://avatars.githubusercontent.com/u/4528796?v=4)](https://github.com/timvandijck "timvandijck (6 commits)")[![clementmas](https://avatars.githubusercontent.com/u/8032241?v=4)](https://github.com/clementmas "clementmas (6 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (6 commits)")[![brendt](https://avatars.githubusercontent.com/u/6905297?v=4)](https://github.com/brendt "brendt (6 commits)")[![JeppeKnockaert](https://avatars.githubusercontent.com/u/1913807?v=4)](https://github.com/JeppeKnockaert "JeppeKnockaert (5 commits)")[![bessone](https://avatars.githubusercontent.com/u/1089510?v=4)](https://github.com/bessone "bessone (5 commits)")[![vitorsemeano](https://avatars.githubusercontent.com/u/4042283?v=4)](https://github.com/vitorsemeano "vitorsemeano (5 commits)")[![darron1217](https://avatars.githubusercontent.com/u/8064923?v=4)](https://github.com/darron1217 "darron1217 (4 commits)")[![leonelvsc](https://avatars.githubusercontent.com/u/2332029?v=4)](https://github.com/leonelvsc "leonelvsc (4 commits)")[![alexwass-lr](https://avatars.githubusercontent.com/u/56585741?v=4)](https://github.com/alexwass-lr "alexwass-lr (4 commits)")[![itsgoingd](https://avatars.githubusercontent.com/u/821582?v=4)](https://github.com/itsgoingd "itsgoingd (4 commits)") --- Tags hacktoberfestphantomjsphpscreenshotpdfconvertimageheadlesswebpagechromescreenshotpuppeteer ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/spatie-browsershot/health.svg) ``` [![Health](https://phpackages.com/badges/spatie-browsershot/health.svg)](https://phpackages.com/packages/spatie-browsershot) ``` ### Alternatives [chrome-php/chrome Instrument headless chrome/chromium instances from PHP 2.6k4.5M64](/packages/chrome-php-chrome)[gotenberg/gotenberg-php A PHP client for interacting with Gotenberg, a developer-friendly API for converting numerous document formats into PDF files, and more! 3685.2M19](/packages/gotenberg-gotenberg-php)[spatie/pdf-to-image Convert a pdf to an image 1.4k15.2M64](/packages/spatie-pdf-to-image)[spiritix/php-chrome-html2pdf A PHP library for converting HTML to PDF using Google Chrome 153472.0k3](/packages/spiritix-php-chrome-html2pdf)[daandesmedt/phpheadlesschrome A PHP wrapper for using Google Chrome Headless mode. Convert URL or HTML to a PDF / screenshot. Easy to use and OOP interfaced. 92233.1k](/packages/daandesmedt-phpheadlesschrome)[tesla-software/chrome2pdf Convert HTML to Pdf using headless chrome. 308.1k](/packages/tesla-software-chrome2pdf) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)