Catalyst is available as an npm module
@github/catalyst. To install into your project, use the command
npm install @github/catalyst.
Catalyst has no strict dependencies, but it relies on TypeScript for decorator support, so you should also configure your project to use TypeScript. Read the TypeScript docs on how to set up TypeScript on a new project.
Catalyst uses modern browser standards, and so requires evergreen browsers or may require polyfilling native functionality in older browsers. You'll need to ensure the following features are available:
dom4libraries can polyfill this.
@webcomponents/custom-elementscan polyfill this.
mutation-observercan polyfill this.
Please note this list may increase over time. Catalyst will never ship with polyfills that add missing browser functionality, but will continue to use the latest Web Standards, and so may require more polyfills as new releases come out.