https://github.com/stechstudio/snapthis
Laravel SDK for SnapThis snapshot service
https://github.com/stechstudio/snapthis
Last synced: about 1 year ago
JSON representation
Laravel SDK for SnapThis snapshot service
- Host: GitHub
- URL: https://github.com/stechstudio/snapthis
- Owner: stechstudio
- License: mit
- Created: 2020-12-01T21:48:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-18T12:17:47.000Z (over 5 years ago)
- Last Synced: 2025-03-08T15:02:57.746Z (over 1 year ago)
- Language: PHP
- Size: 15.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel SDK for SnapThis snapshot service
[](https://packagist.org/packages/stechstudio/snapthis)
SnapThis is a screenshot service that will convert an URL or HTML payload into a PNG image or PDF file.
## Installation
You can install the package via composer:
```bash
composer require stechstudio/snapthis
```
Store your API key in the .env file:
```bash
SNAPTHIS_API_KEY=[your api key]
```
## Quickstart
Take a snapshot by using the `snapshot` or `pdf` methods. Return this result from a controller method to redirect to the snapshot:
```php
use SnapThis;
// Will take a PNG image snapshot and redirect the user:
return SnapThis::snapshot('https://laravel.com');
```
Or add the `download` method to force the snapshot to download for your user.
```php
return SnapThis::pdf('https://laravel.com')->download();
```
To get the raw binary contents use the `contents` method:
```php
$contents = SnapThis::pdf('https://laravel.com')->contents();
```
You can pass in an HTML string instead of a URL:
```php
SnapThis::pdf("Hello there");
```
You can also pass in a blade view, then simply chain the `snapshot` or `pdf` methods.
```php
$users = User::all();
return SnapThis::view('reports.users', ['users' => $users])->pdf();
```
## Options
There are quite a few options for customizing the snapshot. Documentation coming!
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.