@shoelace-style/vue-sl-model

A custom Vue directive that makes two-way binding Shoelace components easier.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@shoelace-style/vue-sl-model
711.0.14 months ago3 years agoMinified + gzip package size for @shoelace-style/vue-sl-model in KB

Readme

Vue Directive for Two-way Binding Shoelace Components
A custom Vue 3 directive that makes two-way binding Shoelace components easier.
Instructions for Vue 2 users
If you're looking for a directive that's compatible with Vue 2, install version 1 of this package:
npm install @shoelace-style/vue-sl-model@1

Then follow these instructions instead.

Usage

Install the directive with this command.
npm install @shoelace-style/vue-sl-model

Next, import the directive into your app and enable it like this.
import "@shoelace-style/shoelace/dist/themes/light.css"
import "@shoelace-style/shoelace/dist/components/input/input"

import ShoelaceModelDirective from '@shoelace-style/vue-sl-model'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)
app.use(ShoelaceModelDirective)

app.config.compilerOptions.isCustomElement = tag => tag.startsWith('sl-')

// If using Vite, the above "isCustomElement" needs to be deleted and defined in vite.config.js
// See below for an example vite.config.js

app.mount('#app')

Now you can use the v-sl-model directive to keep your data in sync!
<sl-input v-sl-model="name"></sl-input>

Why is this necessary?

Currently, there's no support for v-model on custom elements in Vue. You can handle two-way binding manually, but's it rather verbose.
<!-- This doesn't work -->
<sl-input v-model="name"></sl-input>

<!-- This works, but it's a bit longer -->
<sl-input :value="name" @input="name = $event.target.value"></sl-input>

This utility solves this problem by creating a custom directive that works just like v-model but for Shoelace components.

Using Vite

// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: (tag) => tag.startsWith('sl-')
        }
      },
    })
  ]
})