secomapp/browsershot

Convert a webpage to an image from spatie

Convert a webpage to an image

, _(*1)

The package can convert a webpage to an image. To accomplish this conversion Phantomjs (included in the project) is used., _(*2)

This package is used to generate the sitepreviews on the homepage of spatie.be. It is also used by Gordon Murray to add previews to shared content., _(*3)

Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., _(*4)

Installation

This package can be installed through Composer., _(*5)

composer require secomapp/browsershot

When using Laravel there is a service provider that you can make use of., _(*6)

// app/config/app.php

'providers' => [
    '...',
    'Spatie\Browsershot\BrowsershotServiceProvider'
];

Please note that the provided binary is intented for use on Ubuntu., _(*7)

Usage

Here is a sample call to create an image of a webpage:, _(*8)

    $browsershot = new Spatie\Browsershot\Browsershot();
    $browsershot
        ->setURL('http://www.arstechnica.com')
        ->setWidth('1024')
        ->setHeight('768')
        ->save('targetdirectory/arstechnica-browsershot.jpg');

These methods are provided:, _(*9)

• setBinPath(): Specify the path to your own phantomjs-binary.
• setWidth(): Set the width of the image (defaults to 640).
• setHeight(): Set the height of the image (defaults to 480).
• setHeightToRenderWholePage(): Calling this method will result in the entire webpage being rendered.
• setURL(): Set the URL of the webpage which should be converted to an image
• save($targetFile): Starts the conversion-process. The targetfile should have one of these extensions: png, jpg, jpeg.

Other implementations

• Node.js

Contributing

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

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker., _(*11)

Credits

• Freek Van der Herten
• All Contributors

About Spatie

Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., _(*12)

License

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