README

Lets you embed screenshots of webpages via the URL2PNG API.

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
 cd /path/to/project
```

Then tell Composer to load the plugin:

 composer require superbig/craft-url2png

In the Control Panel, go to Settings → Plugins and click the “Install” button for URL2PNG.

Configuring URL2PNG

Place a copy of src/config.php in your Craft config directory, by default config/.

<?php
return [
    'apiKey'    => '',
    'apiSecret' => '',
];

Using URL2PNG

Image embed

{{ craft.url2png.img({
            url: 'http://buildwithcraft.com',
            width: 500
}) }}

URL

{% set img = craft.url2png.url({
        url: 'http://buildwithcraft.com',
        thumbnail_max_width: 500
        }) %}

<div style="background-image: url({{ img }}); width: 500px; height: 500px;"></div>

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 `<div id='url2png-cheese'></div>` 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

Brought to you by Superbig

superbig / craft-url2png

Maintainers

Details