https://github.com/sjelfull/url2png
Lets you embed screenshots of webpages via the URL2PNG API.
https://github.com/sjelfull/url2png
craftcms craftcms-plugin
Last synced: about 1 year ago
JSON representation
Lets you embed screenshots of webpages via the URL2PNG API.
- Host: GitHub
- URL: https://github.com/sjelfull/url2png
- Owner: sjelfull
- Created: 2014-09-06T11:05:02.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-02-25T19:46:19.000Z (over 9 years ago)
- Last Synced: 2025-04-11T00:13:52.881Z (about 1 year ago)
- Topics: craftcms, craftcms-plugin
- Language: PHP
- Size: 10.7 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Craft URL2PNG
Lets you embed screenshots of webpages via the URL2PNG API.
## Installation
* Place the **url2png** folder inside your **craft/plugins** folder
* Go to **settings/plugins** and install URL2PNG.
* Get your API key and secret from [url2png.com](https://www.url2png.com/) (signup with promo code **CRAFT** to get $40 credit.)
* Add the key/secret under URL2PNG settings
## Usage
### Image embed
```twig
{{ craft.url2png.img({
url: 'http://buildwithcraft.com',
width: 500
}) | raw }}
```
Remember to include the raw filter. There is no current option to prevent Craft autoescaping the HTML returned from plugin templates in the frontend.
### URL
```twig
{% set img = craft.url2png.url({
url: 'http://buildwithcraft.com',
thumbnail_max_width: 500
}) %}
```
## Options
| Name | Description | Default |
| ------------------------ | :------------------------------------------------------------------ | ------: |
| url | The url of the webpage you want to fetch ||
| thumbnail_max_width | Constrain screenshot based on width. i.e. 500 | 1:1 |
| viewport | Set viewport dimensions, adjust to your hearts content. i.e. 500x500 | 1480x1037 |
| fullpage | Will attempt to capture entire document canvas. | false |
| unique | Forces a fresh screenshot by varying this value. i.e. a timestamp. ||
| user_agent | Pass a custom user user agent ||
| accept_languages | Override the default HTTP Accept-Language header. | en-US,en;q=0.8 |
| custom_css_url | Fetches a CSS stylesheet and injects it. ||
| say_cheese | Delay screenshot until ```
``` is available. ||
| ttl | Set the TTL or "time to live" value for a screenshot in seconds. Defaults to 2592000 (30 days) ||
| alt | Sets the img alt attribute ||
| class | Sets the img class attribute ||
| width | Sets the img width attribute ||
| height | Sets the img height attribute ||
## Credits
Icon: Camera by Alfa Design from the Noun Project