Quick start (Documentation)

Go to complete documentation

Setup a Vue 3 ( + typescript) projects

Install quick-shortcuts with npm

npm i quick-shortcuts

Setup

Import style.css from library where Shortcuts component will be used.

import 'quick-shortcuts/dist/style.css'

App.vue

<script setup lang="ts">
import { computed } from "vue";
import OptionIcon from "./components/OptionIcon.vue";

import "quick-shortcuts/dist/style.css";
import { Shortcuts } from "quick-shortcuts";
import type { Option } from "quick-shortcuts";

const options = computed<Option[]>(() => [
    {
        id: 1,
        title: "File",
        description: "File operations",
        icon: OptionIcon,
        isVisible: true,
        isDisabled: false,
        onSelect: () => alert("File selected"),
        children: [
            {
                id: 11,
                title: "New File",
                suffixText: "Create a new file",
                isVisible: true,
                onSelect: () => alert("New File selected"),
            },
            {
                id: 12,
                title: "Open File",
                suffixText: "Open an existing file",
                isVisible: true,
                onSelect: () => alert("Open File selected"),
            },
            {
                id: 13,
                title: "Save File",
                suffixText: "Save current progress",
                isVisible: true,
                onSelect: () => alert("Save File selected"),
            },
        ],
    },
])
</script>

<template>
    <div>
        <h2>Quick shortcuts tutorial</h2>
        <Shortcuts :options="options" />
    </div>
</template>

Basic setup is done.

Press ctrl + k for popup to appear. k is default key for shortcuts to trigger.