@e-bydesignca/constellation-ui v0.1.0

Constellation UI Library

This library is built using Vue 3 and is only compatible with Vue 3 apps.

Installation

To use this library in your Vue 3 app, install it from the NPM registry

npm install --save @e-bydesignca/constellation-ui

Peer Dependency Installs

The Constellation UI Library depends on Font Awesome. If you do not have it installed, run:

npm install --save @fortawesome/vue-fontawesome@3.0.0-3 @fortawesome/pro-duotone-svg-icons@6.0.0-beta1 @fortawesome/fontawesome-svg-core@1.2.36

Note: As of version 1.0.0 of this library, the peer dependencies are version specific, so please make sure you install the versions shown above.

Configuration of Font Awesome

After installing the Font Awesome packages, configure your Vue app's main.ts/js file to use Font Awesome in the following manner:

import { library } from "@fortawesome/fontawesome-svg-core"

import {
  FontAwesomeIcon,
  FontAwesomeLayers,
  FontAwesomeLayersText,
} from "@fortawesome/vue-fontawesome"

// Tree shake the library by only using the specific icons you need.
import { faCoffeePot as fadCoffeePot } from "@fortawesome/pro-duotone-svg-icons"

library.add(fadCoffeePot)

createApp(App)
  .component("font-awesome-icon", FontAwesomeIcon)
  .component("font-awesome-layers", FontAwesomeLayers)
  .component("font-awesome-layers-text", FontAwesomeLayersText)
  .mount("#app")

Note: The Constellation UI Library uses only the Pro Duotone icons.