Code Monkey home page Code Monkey logo

command-palette's Introduction

Social Card of Stacks

npm version GitHub Actions Commitizen friendly

Command Palettes

Command Palettes, similar to kbar, are often used within applications. This library is to help create a custom & performant command palette for your application. Useful functions & headless components included.

🤖 Zero-config, by design
🎨 Built-in animations
🧙🏼‍♀️ Fully customizable components
Highly performant

The simple way to to use & design ⌘-k command palettes.

Get Started

It's incredibly easy to get started with this Command Palette stack. Simply install either of the following packages, dependent on whether you want to use framework agnostic Web Components or Vue components.

npm install @stacksjs/command-palette-elements
npm install @stacksjs/command-palette-vue

🤖 Usage

Web Component usage
<html>
  <body>
    <command-palette></command-palette>
    <script src="command-palette.js"></script>
  </body>
</html>
Vue 2 & 3 usage
<script setup lang="ts">
import CommandPalette from '@stacksjs/command-palette-vue'
</script>

<template>
  <CommandPalette />
</template>

You're developing your own command palette components and simply want to reuse the functions/composables?

Functions usage
npm install command-palette-fx

After you installed the command-palette library, you can then make of functions in the following way:

import { isDark, toggleDark } from 'command-palette-fx'

console.log('is dark mode?', isDark)

🧪 Testing

pnpm test

📈 Changelog

Please see our releases page for more information on what has changed recently.

💪🏼 Contributing

Please see CONTRIBUTING for details.

🏝 Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Open Web Discord Server

📄 License

The MIT License (MIT). Please see LICENSE for more information.

Made with ❤️

command-palette's People

Contributors

chrisbbreuer avatar

Stargazers

 avatar  avatar

Watchers

 avatar

command-palette's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

  • WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore(deps): update actions/setup-node action to v4
  • chore(deps): update dependency @vitejs/plugin-vue to v5
  • chore(deps): update dependency change-case to v5
  • chore(deps): update dependency consola to v3
  • chore(deps): update dependency conventional-changelog-cli to v5
  • chore(deps): update dependency eslint to v9
  • chore(deps): update dependency esno to v4
  • chore(deps): update dependency lint-staged to v15
  • chore(deps): update dependency minimatch to v9
  • chore(deps): update dependency rimraf to v5
  • chore(deps): update dependency typescript to v5
  • chore(deps): update dependency unbuild to v2
  • chore(deps): update dependency vite to v5
  • chore(deps): update dependency vue-tsc to v2
  • chore(deps): update node.js to v20 (node, @types/node)
  • chore(deps): update pnpm to v9
  • chore(deps): update vitest monorepo to v1 (major) (@vitest/coverage-istanbul, vitest)
  • 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/ci.yml
  • actions/checkout v3
  • actions/setup-node v3
  • actions/checkout v3
  • actions/setup-node v3
  • actions/checkout v3
  • actions/setup-node v3
  • actions/checkout v3
  • actions/setup-node v3
.github/workflows/release.yml
  • actions/checkout v3
  • actions/setup-node v3
nodenv
.node-version
  • node 18.10.0
npm
.stacks/artisan/package.json
  • @jsdevtools/ez-spawn ^3.0.4
  • cac ^6.7.14
  • giget ^0.1.7
  • kolorist ^1.6.0
  • pathe ^0.3.9
  • unbuild ^0.8.11
  • node >=v18.10.0
  • pnpm >=7.13.2
  • pnpm 7.13.2
.stacks/functions/package.json
  • pnpm 7.13.2
.stacks/package.json
  • @babel/types ^7.19.3
  • @iconify-json/heroicons-outline ^1.1.4
  • @iconify-json/heroicons-solid ^1.1.5
  • @jsdevtools/ez-spawn ^3.0.4
  • @julr/unocss-preset-forms ^0.0.2
  • @ow3/eslint-config ^0.30.0
  • @rollup/pluginutils ^4.2.1
  • @types/bcryptjs ^2.4.2
  • @types/crypto-js ^4.1.1
  • @types/fs-extra ^9.0.13
  • @types/minimatch ^5.1.2
  • @types/node ^18.8.3
  • @types/prompts ^2.4.1
  • @unocss/preset-icons ^0.45.26
  • @unocss/transformer-compile-class ^0.45.26
  • @unocss/vite ^0.45.26
  • @vitejs/plugin-vue ^3.1.2
  • @vitest/coverage-istanbul ^0.24.0
  • @vueuse/core ^9.3.0
  • @vueuse/shared ^9.3.0
  • bcryptjs ^2.4.3
  • bumpp ^8.2.1
  • cac ^6.7.14
  • change-case ^4.1.2
  • collect.js ^4.34.3
  • commitizen ^4.2.5
  • consola ^2.15.3
  • conventional-changelog-cli ^2.2.2
  • crypto-js ^4.1.1
  • cz-git ^1.3.11
  • detect-indent ^7.0.1
  • detect-newline ^4.0.0
  • eslint ^8.24.0
  • esno ^0.16.3
  • events ^3.3.0
  • fast-glob ^3.2.12
  • fs-extra ^10.1.0
  • giget ^0.1.7
  • jiti ^1.16.0
  • js-base64 ^3.7.2
  • lint-staged ^13.0.3
  • local-pkg ^0.4.2
  • minimatch ^5.1.0
  • nitropack ^0.5.4
  • only-allow ^1.1.1
  • pathe ^0.3.9
  • rimraf ^3.0.2
  • simple-git-hooks ^2.8.0
  • typescript ^4.8.4
  • unbuild ^0.8.11
  • unocss ^0.45.26
  • unplugin-auto-import ^0.11.2
  • unplugin-vue-components ^0.22.8
  • vite ^3.1.6
  • vite-plugin-inspect ^0.7.5
  • vitepress 1.0.0-alpha.19
  • vitest ^0.24.0
  • vue ^3.2.40
  • vue-tsc ^1.0.0
  • node >=v18.10.0
  • pnpm >=7.13.2
  • pnpm 7.13.2
.stacks/vue-components/package.json
  • pnpm 7.13.2
.stacks/web-components/package.json
  • pnpm 7.13.2
package.json
  • @headlessui/vue ^1.7.3
  • node >=v18.10.0
  • pnpm >=7.13.2
  • pnpm 7.13.2

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.