Archer UXDS and Vue

Vue works well with custom elements, but has some minor limitations.

To work around this problems we provide custom element wrappers for better developer experience.

Please note that you will need to install both, the @archer-edu/ux-components as well as the @archer-edu/ux-components-vue packages.

Once you have installed both packages and defined the custom elements, Archer UXDS components behave mostly the way you would expect a Vue component to behave!

src/main.ts

import Vue from "vue";
import App from "./App.vue";
import { applyPolyfills, defineCustomElements } from "@archer-edu/ux-components/loader";
import "@archer-edu/ux-components/dist/ux-components/ux-components.css";

Vue.config.productionTip = false;
Vue.config.ignoredElements = [/archer-\w*/];

applyPolyfills().then(() => {
  defineCustomElements(window);
});

new Vue({
  render: h => h(App)
}).$mount("#app");

src/App.vue

<template>
  <div>
    <archer-button>Click!</archer-button>
  </div>
</template>

<script>
import Vue from 'vue'
import { ArcherButton } from "@archer-edu/ux-components-vue";

export default Vue.extend({
  name: "app",
  components: { ArcherButton },
});
</script>

Events in Vue

In order to prevent collisions with standard events and compatibility with other libraries and frameworks, some components of Archer UXDS are using custom event names. You can find documentation for the custom events on the respective component pages in the docs section.

Events in Vue are prefixed with: archer-{event-name}

Find Archer UXDS on Bitbucket.