Skip to main content
Light Dark System

Vue (version 2)

Vue plays nice with custom elements, so you can use maf-ui in your Vue apps with ease.

Installation

To add maf-ui to your Vue app, install the package from npm.

npm install maf-ui-kit

Next, include a theme and set the base path for icons and other assets. In this example, we’ll import the light theme and use the CDN as a base path.

import 'maf-ui-kit/dist/themes/light.css';
import { setBasePath } from 'maf-ui-kit/dist/utilities/base-path';

setBasePath('https://cdn.jsdelivr.net/npm/maf-ui-kit@0.0.1/cdn/');

Configuration

You’ll need to tell Vue to ignore maf-ui components. This is pretty easy because they all start with mf-.

import Vue from 'vue';
import App from './App.vue';

Vue.config.ignoredElements = [/mf-/];

const app = new Vue({
  render: h => h(App)
});

app.$mount('#app');

Now you can start using maf-ui components in your app!

Usage

Binding Complex Data

When binding complex data such as objects and arrays, use the .prop modifier to make Vue bind them as a property instead of an attribute.

<mf-color-picker :swatches.prop="mySwatches" />

Two-way Binding

One caveat is there’s currently no support for v-model on custom elements, but you can still achieve two-way binding manually.

<!-- This doesn't work -->
<mf-input v-model="name"></mf-input>
<!-- This works, but it's a bit longer -->
<mf-input :value="name" @input="name = $event.target.value"></mf-input>

If that’s too verbose for your liking, you can use a custom directive instead. This utility adds a custom directive that will work just like v-model but for maf-ui components. To install it, use this command.

npm install @shoelace-style/vue-mf-model@1

Next, import the directive and enable it like this.

import Vue from 'vue';
import maf-uiModelDirective from '@shoelace-style/vue-mf-model';
import App from './App.vue';

Vue.use(maf-uiModelDirective);
Vue.config.ignoredElements = [/mf-/];

const app = new Vue({
  render: h => h(App)
});

app.$mount('#app');

Now you can use the v-mf-model directive to keep your data in sync!

<mf-input v-mf-model="name"></mf-input>