doenkids-web-components

DoenKids Web components

This is the repository that contains the web components to use with the external data API. This API exposes the programs and activities available for a customer location (or group). The purpose of these webcomponents is to drop them into your website and use them like regular HTML elements. Styling can be done with CSS as usual.

Documentation is available here

Getting Started

To use the external data API you need an API key. The components in this repository need that token and some date inputs to render your programs and activities.

Development

To start developing in this repository 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

Using this component

Script tag

• Put two script tags: <script type="module" src='https://unpkg.com/doenkids-web-components/dist/doenkids-web-components/doenkids-web-components.esm.js'></script> <script nomodule="" src='https://unpkg.com/doenkids-web-components/dist/doenkids-web-components/doenkids-web-components.js'></script> in the head of your index.html

• (Optionally): add the following stylesheet to the head of your index.html: <link rel="stylesheet" href="https://unpkg.com/doenkids-web-components/dist/doenkids-web-components/doenkids-web-components.css" type="text/css" >

• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

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

In a stencil-starter app

• Run npm install doenkids-web-components --save
• Add an import to the npm packages import doenkids-web-components;
• Then you can use the element anywhere in your template, JSX, html etc