Euclid-components NPM

Provides reusable Vue components for the Universit of Edinburgh's EUCLID application.

If you're not a member of Student Systems staff actively developing EUCLID then this probably isn't what you're looking for or any use to you. You're welcome to browse it though.

Usage

Install with npm.

npm install euclid-components-save-dev

Then require individual components in your Vue components:

const DynamicListbox = require('euclid-components').DynamicListbox;

Documentation

Documentation is included in the Git repository (but not in npm). As well as explaining how each component works, it also provides live examples using the components themselves.

To view and develop this documentation, run npm run docs. It will run the documentation through localhost and automatically update with any changes to the components and documentation files.

We'll host this somewhere soon.

Releasing

When ready to release, ensure that documentation and unit tests have been written, bump the version number (following semver) and run npm run release.

Note that the test "DynamicListbox emits an event with a translation" may occassionally fail in Headless Chrome, which I haven't been able to figure out yet. If so, just re-run npm run release until it passes.