How to install Element in your project

Element is not currently hosted on NPM (although we do hope to get it there). Because it's not hosted on NPM, in order to install it with your package manager, you first have to create an .npmrc file. This file tells npm/yarn where to go to get the @element packages that are not hosted on npm.org. It should go in the root of your project.

@element:registry=https://pkgs.dev.azure.com/JCI-UX/ELEMENT/_packaging/element-pre/npm/registry/
always-auth=true

Notice that this file specifies that only packages with an @element scope should use this registry. Every other package will be treated normally.

With that in place, you can use your favorite package manager to install Element just like you're used to!

# Install with yarn
yarn add @element/react

# Or, install with npm
npm i @element/react

We used @element/react as an example here, but you can now install any Element package, e.g. @element/components-web if you're working with vanilla JavaScript.