1.0.1 • Published 4 years ago

dwp-consent v1.0.1

Weekly downloads
3
License
ISC
Repository
github
Last release
4 years ago

The DWP Cookie Consent Package (node version);


To get started:

npm i dwp-consent

Then include the "dwp-consent" class in the element of your html.

<body class="dwp-consent">

OPTIONAL PARAMETERS:

The cookies page defaults to https://www.gov.uk/help/cookie-details. To override this, include "dwp-consent-cookiesPage" in the body element:

<body class="dwp-consent dwp-consent-cookies-page="https://www.bbc.co.uk/">

By default, the retention period for the cookie set by this tool is 28 days. To override this, include "dwp-consent-retention-period=days in the body element, where days = number of days to retain the cookie.

<body dwp-consent dwp-consent-retention-period=45>

By default, no header showing the service name or footer is added to the cookies consent page, as it is expected that this will be done by the app calling the page. However, if a header is required, "service-name=service" should be added to the body element:

<body dwp-consent dwp-consent-service-name="DWP Carers Allowance">

To add a footer:

<body class="dwp-consent dwp-consent-footer">

To display the page and banner in Welsh, add the "dwp-consent-welsh" class.

<body class="dwp-consent dwp-consent-welsh">

When invoked, dwp-cookie-consent looks for cookies beginning with 'DWP'; If no DWP cookies are found, the DWP Cookie Consent page is displayed. The pop-up explains our use of cookies and asks for permission to set cookies for advertising and analytic purposes. The default in both theses cases is 'no'. Responses are recorded as true and false in cookies and the popup disappears.

If there are DWP cookies already, a banner appears at the top of the page telling the user what permissions are set and offering the chance to change them


The cookies are:

DWP_allow_essential_cookies
DWP_allow_advertising_cookies - set to true if permission to use advertising cookies is given
DWP_allow_analytic_cookies - set to true if permission to use analytic cookies is given

The cookies expire after 28 days unless a different retention period has been set.