Installation

Stylesheet

Scripts

Include both of these before your app code.

Note that aui.js must not include type="module" since it relies on document.currentScript, a feature which is not available in ESM (ref).

Adoption

Adopting Skylab SDK into an existing web application? See Adoption.

Compatibility

Skylab components may be used with the following frameworks:

• React 16, 17, 18 (Skylab React package recommended); React server-side rendering is not supported
• Vue 2
• Angular 8
• Ember 3

If you don't see a framework/version here, it is either incompatible with Web Components (e.g. React 15), or we have not tested it yet. Please contact us on the #skylab Slack channel to check whether we are planning on supporting your preferred framework.

Environment

You may optionally set the environment as an attribute on the script tag where you load the aui.min.js script as seen below to use lower environment URLs (valid environments are: local, ci, qa, uat, sbx, prod):

Install Skylab SDK package

The Skylab SDK package is scoped to the Avalara organization and published to Artifactory. If Artifactory is not configured as your NPM registry, both locally and within your build process, set it up with a .npmrc file in the project root:

Then install Skylab SDK:

Documentation for previous versions

This docsite contains the documentation for the latest version of Skylab SDK. If you need to view documentation for a previous major version, you'll need to navigate directly to the desired component documentation page for the specified version, per the following table. Note that links will generally link back to the latest docsite, so url navigation will need to be manual.

Content Security Policy

Avalara requires a strict CSP in every app. It will be necessary to use a nonce, generated on each page load, in each script tag that pulls in Skylab SDK assets from the CDN (rather than using unsafe-inline in the CSP policy). For more information, please see the CSP Reference Guide.