JSPM

  • Created
  • Published
  • Downloads 1322
  • Score
    100M100P100Q113492F
  • License MIT

A component to allow users to accept or reject cookies which are not essential to making your service work.

Package Exports

  • @not-govuk/cookie-banner
  • @not-govuk/cookie-banner/dist/CookieBanner.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@not-govuk/cookie-banner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NotGovUK - Cookie Banner

A component to allow users to accept or reject cookies which are not essential to making your service work.

Using this package

First install the package into your project:

npm install -S @not-govuk/cookie-banner

Then use it in your code as follows:

import React, { createElement as h } from 'react';
import CookieBanner from '@not-govuk/cookie-banner';

export const MyComponent = props => (
  <CookieBanner
    aria-label="Cookies on [name of service]"
    messages={[
      {
        heading: 'Cookies on [name of service]',
        content: (
          <Fragment>
            <p className="govuk-body">We use some essential cookies to make this service work.</p>
            <p className="govuk-body">We’d also like to use analytics cookies so we can understand how you use the service and make improvements.</p>
          </Fragment>
        ),
        actions: (
          <Fragment>
            <Button value="accept" name="cookies">
              Accept analytics cookies
            </Button>
            <Button value="reject" name="cookies">
              Reject analytics cookies
            </Button>
            <A href="#">View cookies</A>
          </Fragment>
        )
      }
    ]}
  />
);

export default MyComponent;

Working on this package

Before working on this package you must install its dependencies using the following command:

pnpm install

Testing

Run the unit tests.

npm test

Building

Build the package by compiling the TypeScript source code.

npm run build

Clean-up

Remove any previously built files.

npm run clean