timvermaercke/craft-whitepapers

Let users download whitepapers (or any other secure file) after they drop their email address

1.0.0 2022-07-20 14:51 UTC

This package is auto-updated.

Last update: 2024-05-20 18:51:49 UTC


README

Let your users download whitepapers (or other files), but not before leaving their email address.

The plugin also provides a Field Type, to link a whitepaper to an entry and it provides CSV exports per whitepaper as well!

Screenshots

Frontend (example implementation)

Code Example implementation

The above is an example of an implementation of this plugin

Admin

Overview

Admin Overview

Detail

Admin Detail

Requirements

This plugin requires Craft CMS 4.0.0 or later

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
    
  2. Then tell Composer to load the plugin:

     composer require timvermaercke/craft-whitepaper
    
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Test.

Brought to you by Tim Vermaercke

How to use

Create a Whitepaper object in /admin/whitepapers first.

Then you can add the following snippet to your templates:

<form action="/actions/whitepapers/public/download-whitepaper" method="post">
    {{ csrfInput() }}
    {{ hiddenInput('whitepaperId', 1) }}

    <label for="email">Email</label>
    <input type="email" id="email" name="email" />

    <input type="submit" value="Download" />
</form>

You can also create a field in Craft and use the custom field "Whitepaper", eg. in a Globals Set:

Create a field:

Settings - create a field

Create a globals set

Settings - create a globals set

Fill out the globals set:

Globals

Use the value in your templates:

{# will output the selected whitepaper id #}
{{ settings.fieldWhitepaper }}