Catalyst Elements Bundle

API documentation & Demos ↗

A bundle of all the Catalyst Elements.

Installation

Install with npm:

npm install --save @catalyst-elements/bundle

Install with yarn:

yarn add @catalyst-elements/bundle

Please note that this package is not compatible with Bower.

Usage

As a Module (Recommend)

Import the module on each page that uses the component.

<script type="module" src="node_modules/@catalyst-elements/bundle/dist/catalyst-elements.js"></script>

All included elements will now be available for use - see release notes for details on which elements are included in the bundle.

As a Script

Import the script on each page that uses one or more catalyst elements.

<script src="node_modules/@catalyst-elements/bundle/dist/catalyst-elements.es5.min.js"></script>

Please note that this script has been transpiled to es5 and thus use of custom-elements-es5-adapter.js or an equivalent library is required. See es5 support on the Catalyst Elements wiki for details.

All included elements will now be available for use - see release notes for details on which elements are included in the bundle.

Browser Compatibility

See details on the wiki: Browser Compatibility

Contributions

Contributions are most welcome. Please read our contributing guidelines first.

Contribution for a particular element should be made on that element's repo.