README.md

Command Bar 🐜

Simple `⌘K` command bar for Vue

Important

This has been re-implemented as a native web component and is no longer maintained.

• 🚀 Fast, efficient, keyboard-driven UX
• 😌 Opinionated: it doesn't do much, but what it does is very easy to use
• 👌 Fully typed and tested
• 🛝 Check out Tasks for a demo and example usage

Installation

With a package manager:

npm i github:andreasphil/vue-command-bar#<tag>

Usage

Import the styling for the command bar in your App.vue (or where you need it):

import "@andreasphil/design-system/style.css" layer(theme);
import "@andreasphil/vue-command-bar/style.css";

To make the command bar available to your app, wrap the part of the application that should have access to it inside the VueCommandBar component:

<script setup lang="ts">
import VueCommandBar from "@andreasphil/vue-command-bar";
</script>

<template>
  <VueCommandBar>
    <!-- Your app -->
  </VueCommandBar>
</template>

In any component inside the VueCommandBar, you can now call the useCommandBar composable to get access to the context. This will provide you with methods for registering and removing commands, as well as opening the bar manually:

import { useCommandBar } from "@andreasphil/vue-command-bar";

// This will be returned by the method for registering commands. We can use
// this to clean up commands only needed by specific components/views when
// the user navigates away from those.
let cleanup;

const { registerCommand } = useCommandBar();

cleanup = registerCommand({
  id: "a_command",
  name: "A command",
  // See the Command type for all available options
});

To learn more about the available props, check out the docs in CommandBar.vue. For examples, see the demo.

Development

Command Bar is compatible with Vue 3 and built with Vite. Packages are managed by pnpm. Tests are powered by Vitest. The following commands are available:

pnpm dev          # Start development server
pnpm test         # Run tests once
pnpm test:watch   # Run tests in watch mode
pnpm build        # Bundle for production

Credits

This library uses a number of open source packages listed in package.json.

Thanks 🙏