@publicgarden/cookie-banner

Cookie Banner Web Component

This is a standalone cookie banner Web Component using Stencil.

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Component Setup

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/@publicgarden/cookie-banner@0.1.6/dist/cookie-banner.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install @publicgarden/cookie-banner --save
• Put a script tag similar to this <script src='node_modules/@publicgarden/cookie-banner/dist/cookie-banner.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Component Usage

Place the new component anywhere you like. The external-wrapper-class can be used to limit the inner width to the boundaries of your content wrapper element.

<cookie-banner
    external-wrapper-class="wrapper"
    text="This is the data privacy text with an :examplePlaceholder that will be replaced by a matching Link.">
</cookie-banner>

If you want to use link placeholders, additionally add this script somewhere:

<script>
var cmp = document.querySelector('cookie-banner');
cmp.links = [
    {
        placeholder: 'examplePlaceholder',
        label: 'Example Placeholder',
        url: 'https://www.example.com/data-privacy',
        blank: true,
    }
];
</script>

Component Development

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/ionic-team/stencil-component-starter.git cookie-banner
cd cookie-banner
git remote rm origin

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.