@spartez/vue-atlaskit

Unofficial Vue UI library, built according to the Atlassian Design Guidelines.

Installation

npm install @spartez/vue-atlaskit

ES6

//
// Register a component manually for optimal tree shaking
//
import { Spinner } from '@spartez/vue-atlaskit';

export default {
  components: {
    Spinner
  },
};

Browser

<script src="path/to/vue/vue.min.js"></script>
<script src="https://unpkg.com/@spartez/vue-atlaskit/dist/index.min.js"></script>
<!-- Components are registered globally -->

After that, you can use it in your templates:

<script>
  new Vue({
      el: '#app',
      template: `<Button>{{hello}}</Button>`,
      data: { hello: 'Click Me!' }
  })
</script>

For including styles you can either place the below styles in your index.html

<link href="https://unpkg.com/@spartez/vue-atlaskit/dist/bundle.css" rel="stylesheet">

Or you can import it to your webpack entry point file. This is usually your main.js file.

import '@spartez/vue-atlaskit/dist/bundle.css';

Contributing

See CONTRIBUTING.md.