Socket
Socket
Sign inDemoInstall

doenkids-web-components

Package Overview
Dependencies
2
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

doenkids-web-components

The DoenKids web components for the external data API


Version published
Maintainers
1
Install size
7.30 MB
Created

Readme

Source

Built With Stencil

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

FAQs

Last updated on 29 Jun 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc