Alternative contact formats plugin for the GOV.UK prototype kit

A plugin user flow for alternative contact formats, for use with the GOV.UK Prototype Kit.

This plugin allows you to insert the full DWP Choose alternative contact formats pattern into a prototype with minimal coding. It includes pages, routes and logic for collecting information about users' written and spoken contact needs.

Requirements

To use this plugin, first start a prototype by installing the GOV.UK Prototype Kit (version 13 or later).

1. Install the plugin

In the folder that contains your prototype, install the plugin by running the following terminal command:

npm install https://github.com/dwp/alternative-formats-plugin

2. Add the following code to your prototype's app/routes.js file

const alternativeFormatsPlugin = require("alternative-formats-plugin");

alternativeFormatsPlugin(router);

3. Add the pattern to your prototype

Link or redirect from any page in your prototype as shown below. In this example the link is a "Continue" button.

{# Example of a Continue button #}
{{ 
    govukButton({
        text: "Continue",
        href: "/dwp-alternative-formats-plugin/start?alternative_formats_exit_url=/your-exit-url",
        isStartButton: false
    })
}}

This link also controls what happens next when the user finishes choosing contact formats. In the link, replace /your-exit-url with the URL that should load when the user selects "Continue" on the last page of the pattern (the Check answers page).

(See Use links to set data for more about how this works.)

The user's answers are stored in the browser session and will be cleared (along with any other stored session data) by the "Clear data" link in the prototype footer.