baseui-wc-utils

Web component utilities to reuse common code

Usage no npm install needed!

<script type="module">
  import baseuiWcUtils from 'https://cdn.skypack.dev/baseui-wc-utils';
</script>

README

Base UI: Web component utilities

Dependencies

  • Node v6+
  • Yarn (optional, only if you want to reduce packages install time)

To run local dev server (http://localhost:1818/)

npm start
  1. Install dependencies
  2. Clean build folder
  3. lint JS files
  4. starts webpack dev server
  5. auto update browser window/tab using Hot Module Replacement (HMR)

To just generate docs for JS

npm run docs

To bundle for production

npm run release
  1. This will perform first 3 steps from above and tree shake and minify for production
  2. Also creates documentation for JS files using jsdoc blocker comments

Usage guide (to be updated)

Import only needed helpers to utilize tree shaking

import { dom, BaseClass } from 'baseui-wc-utils';

Or

import baseuiWcUtils from 'baseui-wc-utils';

in browser script tag

const { dom } = window.baseuiWcUtils or var dom = window.baseuiWcUtils.dom;