Installation

Installation

Install the Vibrant UI libraries:

npm install @vibrant-ui/components @vibrant-ui/core @vibrant-ui/styles @fortawesome/pro-regular-svg-icons

Authorization

Please note that all packages are private and can only be installed with a (classic) personal access token from Github with the read:packages scope. To add the token to your global .npmrc file, run the following commands:

npm config set "@vibrant-ui:registry" https://npm.pkg.github.com/
npm config set "//npm.pkg.github.com/:_authToken" INSERT_TOKEN_HERE

In addition, the icon component requires Font Awesome Pro, which can be installed using a Font Awesome authentication token. Add the key to your global .npmrc file by running the following command:

npm config set "@fortawesome:registry" https://npm.fontawesome.com/
npm config set "//npm.fontawesome.com/:_authToken" INSERT_TOKEN_HERE

Frameworks

Once you've installed the packages, you can integrate them into your project. Choose your preferred framework below for specific installation instructions:

We have no official installation guides for other React frameworks, but as long as Vanilla Extract is supported, Vibrant UI should work fine.