@uq-elipse/vue-component-library v0.2.6

vue-component-library

Library of Vue components adhering to eLIPSE design system. This is in the form of a node module, however the version on npm is not the most recent update stored on GitHub, so please look below for using the most recent version in development.

Installation (to use library in your project)

npm install @uq-elipse/vue-component-library

Components in the library do not have fonts included, so that fonts set by the consumer can automatically be applied. For consistency with the eLIPSE Design System, we expect consumers to set the font-family of their app to:

font-family: 'Open Sans', 'Helvetica', sans-serif;

Installation (to work on library development)

IMPORTANT: Development on the library does not work when testing locally with a Babel project using npm link

First, create your test Vue app

mkdir ~/Desktop/my-project
cd ~/Desktop/my-project
vue create hello-world

Clone the repo/node module

cd ~/Desktop
git clone https://github.com/UQ-eLIPSE/vue-component-library.git

Run npm link inside the module’s root folder:

cd ~/Desktop/vue-component-library
npm link

In your test Vue app, run npm link <module_name>

cd ~/Desktop/my-project/hello-world
npm link @uq-elipse/vue-component-library

For more information on npm link, see: https://medium.com/@alexishevia/the-magic-behind-npm-link-d94dcb3a81af

Usage

In your main.ts or main.js file, add this before the new Vue instance is created

import Vue from 'vue'
import VueComponentLibrary from '@uq-elipse/vue-component-library'

Vue.use(VueComponentLibrary)

Releasing an update to the library

Please refer to the file release.md for instructions.