npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2021 – Pkg Stats / Ryan Hefner

command-pal

v0.2.7

Published

<h1 align="center" style="font-family: mono">command-pal</h1> <p align="center">⌨ The hackable command palette for the web, inspired by <a href="https://github.com/microsoft/vscode">Visual Studio Code</a>.</p>

Downloads

41

Readme

screen cap

Benefit's of Command Palettes

  • Ease of use
    • Simply 1 keyboard shortcut to remember
    • Fuzzy search allows you to find commands easily
  • Speed
    • Keyboard makes it fast to access any command/function
    • Fuzzy search allows for quick ordering of commands
    • Efficient to find a commands that you used once a long time ago
  • Discoverability
    • You can scroll down the entire list of commands
    • Find commands by simply searching the Command palette
    • Tips and functions can be given to you as you type

Features

  • JS framework agnostic (can be attached to any site)
  • Keyboard first control (shortcuts configurable)
  • Custom commands
  • Nested commands
  • Fuzzy text matching (fuse.js)
  • Themeable (theme-light.css and theme-dark.css included)
  • Mobile friendly (button in bottom-left)

screen cap

Links

Why?

Command Palettes have alwyas impressed me with how easy they are to use and develop for. I rarely see them on the web platform, so I thought I'd give it a shot.

Get Started

Install

Either install from npm

yarn add command-pal

Or use the script tag

<script src="https://cdn.jsdelivr.net/npm/command-pal"></script>

Usage - Simple

const c = new CommandPal({
  hotkey: "ctrl+space",
  commands: [
    {
      name: "Send Message",
      shortcut: "ctrl+m",
      handler: () => alert("Send Message"),
    },
    {
      name: "Search Contacts",
      handler: () => alert("Searching contacts..."),
    },
    {
      name: "Goto Profile",
      shortcut: "ctrl+4",
      handler: () => window.location.hash = "profile",
    },
  ],
});
c.start();

Usage - Avanced

const c = new CommandPal({
  hotkey: "ctrl+space",
  commands: [
    {
      name: "Change Language",
      children: [
        {
          name: "English",
          handler: () => alert("Changing to English")
        },
        {
          name: "Spanglish",
          handler: () => alert("Changing to Spanglish")
        }
      ]
    },
    {
      name: "Goto About",
      handler: () => window.location.hash = "about",
    },
  ],
});
c.start();

API

CommandPal instance

const c = new CommandPal({
  hotkey: "ctrl+space",
  commands: [
    // Commands go here
  ]
});
// Start the instance
c.start()
// Destroy the instance
c.destroy()

Subscribe to events

There's a few events that can be subscribed to during command-pal's execution.

// When a command is executed
c.subscribe("exec", (e) => { console.log("exec", { e }); });
// On TextChanged
c.subscribe("textChanged", (e) => { console.log("textChanged", { e }); });
// When a command palette is opened
c.subscribe("opened", (e) => { console.log("opened", { e }); });
// When a command palette is closed
c.subscribe("closed", (e) => { console.log("closed", { e }); });

Command Item

{
  // Required name of command (displayed)
  name: "Open Messages",
  // Required name of command (displayed)
  description: "View all messages in inbox",
  // Shortcut of command
  shortcut: "ctrl+3",
  // Callback function of the command to execute
  handler: (e) => {
    // DO SOMETHING
  }
  // Child commands which can be executed
  children: [...]
},

Command Item Child

Note: Child commands cannot have shortcuts.

{
  // Required name of command (displayed)
  name: "Open Messages",
  // Required name of command (displayed)
  description: "View all messages in inbox",
  // Callback function of the command to execute
  handler: (e) => {
    // DO SOMETHING
  }
},

Local Development

To develop on command-pal simply clone, install and run

npm run dev

Have a go, PR's and issues always welcome.

Prior Art

Many applications have implemented this before, here's a few. My favourite implementation is the VScode, which is the main influence for this project.

Editors

Misc