@edx/cookie-policy-banner

The edX cookie policy banner component implemented in React.

Stats

StarsIssuesVersionUpdatedCreatedSize
@edx/cookie-policy-banner
191.2.22 years ago3 years agoMinified + gzip package size for @edx/cookie-policy-banner in KB

Readme

cookie-policy-banner

Greenkeeper badge npm npm

Introduction

edX cookie policy banner React component

Installation

npm i --save @edx/cookie-policy-banner

Usage

import CookiePolicyBanner from '@edx/cookie-policy-banner';

// Can import sass file this way
// Or as an import in one of your sass files with other third party sass files
import '@edx/cookie-policy-banner/build/cookie-policy-banner.scss';

const SomeWrappingComponent = () => (
  <div>
    <span>Blahblablah</span>
    <CookiePolicyBanner />
  </div>
);

Styling

As noted in a comment in the previous code example, you can import the styles associated with the CookiePolicyBanner component directly (if this is supported by your webpack config) or by importing the sass file as part of one of your existing sass files (probably where your other third-party sass files are imported).

// base.scss
@import 'thirdPartySass';
@import 'anotherThirdPartySass';
@import '@edx/cookie-policy-banner/build/cookie-policy-banner';

Storybook

storybook

Storybook is a useful tool for showcasing the expected and potential usage of components.

Executing

npm run start

locally builds the Storybook for the CookiePolicyBanner component on port 3003.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.