Skip to content

Base class for all <author-*> custom elements (web components)

License

Notifications You must be signed in to change notification settings

author-elements/base

Repository files navigation

AuthorBaseElement Build Status

This is the base class used to build Author.io custom HTML elements (web components). It provides incredibly lightweight utilities and was designed for optimizing all <author-*> custom tags.

Source Size Deliverable Size npm

We're using BrowserStack to make sure these components work on the browsers developers care about.

Usage

This library must be included once in HTML pages before any author-* tags.

There are 4 versions of the base class available:

  1. author-base.min.js (ES6 Minified for Production)
  2. author-base.js (ES6 Unminified for Debugging)
  3. author-base.es5.min.js (ES5 Minified for Production)
  4. author-base.es5.js (ES5 Unminified for Debugging)

Each version has it's own source map, so it's always possible to trace activity back to a specific code block in the source.

You only need to choose one of these files. If you need to support Internet Explorer, older versions of Chrome/Firefox/Safari, then you likely need the ES5 version.

Via Global CDN

<html>
  <head>
    <script src="https://cdn.author.io/author-elements/base/1.0.0/author-base.min.js"></script>
    <script src="https://cdn.author.io/author-elements/whatever/x.x.x/author-whatever.min.js"></script>
  </head>
</html>

Via npm

First install the module locally:

npm install @author.io/element-base -S

Then include it in your HTML:

<html>
  <head>
    <script src="./node_modules/@author.io/element-base/dist/author-base.min.js"></script>
    <script src="https://domain.com/path/to/custom/element.js"></script>
  </head>
</html>