socheatsok78 / vuetify-kbar

[Incubation] A simple plug-n-play cmd+k interface for Vuetify

Vuetify kBar

A simple plug-n-play cmd+k interface for Vuetify.

Live demo

⚠️⚠️ This project is currently is in work-in-progress stage.

Guide

Install

Note: You'll need to bring your own vuetify.
You can install vuetify via npm install vuetify or yarn add vuetify.

$ npm install @socheatsok78/vuetify-kbar@next
# or
$ yarn add @socheatsok78/vuetify-kbar@next

Usage

<template>
  <v-app id="app">
    <v-kbar :actions="actions" />
  </v-app>
</template>

<script>
import { mdiClipboard } from '@mdi/js'

const actions = [
  {
    id: 'blog',
    name: 'Blog',
    description: '',
    shortcut: ['b'],
    keywords: 'writing words',
    perform: () => (window.location.pathname = 'blog')
  },
  {
    id: 'contact',
    name: 'Contact',
    shortcut: ['c'],
    keywords: 'email',
    perform: () => (window.location.pathname = 'contact')
  }
]

export default {
  name: 'App',
  components: {
    VKbar
  },
  data: () => ({
    actions: actions
  })
}
</script>

Development

This project was created using @vue/cli service.

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Run your unit tests

yarn test:unit

Lints and fixes files

yarn lint

Customize configuration

See Configuration Reference.

vuetify-kbar's Issues

Asset