@folk-org/react-command-palette

React Command Palette

WAI-ARIA compliant React command palette like the one in Atom and Sublime

Live Playground

For examples of the command palette in action, go to the

OR

To run that demo on your own computer:

• Clone this repository
• npm install
• npm run storybook
• Visit http://localhost:6006/

Usage

Install it in your project

$ npm i --save react-command-palette

Import into your react app and pass commands

import CommandPalette from 'react-command-palette';

const commands = [{
    name: "Foo",
    command() {}
  },{
    name: "Bar",
    command() {}
  }
  ... 
 ];
 
 ReactDOM.render(
  <CommandPalette commands={commands} />, 
  document.getElementById('app'))

Props

• open a boolean, when set to true it forces the command palette to be displayed. Defaults to "false".

• alwaysRenderCommands a boolean, Set it to true if you'd like to render suggestions even when the input is not focused.

• display one of "modal" or "inline", when set to "modal" the command palette is rendered centered inside a modal. When set to "inline", it is render inline with other page content. Defaults to "modal".

• header a string or a React.ComponentType which provides a helpful description for the usage of the command palette. The component is displayed at the top of the command palette. The header is not displayed by default. see: examples/sampleInstruction.js for reference

• closeOnSelect a boolean, when set to true the command palette will close immediateley when the user makes a selection. Defaults to "false".

• placeholder a string that contains a short text description which is displayed inside the the input field until the user provides input. Defaults to "Type a command".

• hotKeys a string that contains a keyboard shortcut for opening/closing the palette. Defaults to "command+shift+p". Uses mousetrap key combos

• options options controls how fuzzy search is configured. Note: use at your own risk, this is likley to change in the future. The search options are derived from these fuzzysort options. However the command palette options prop must have the following values included to function correctly:

    key: "name", // default is "name"
    keys: ["name"], // default is "name"
  
    // other options may be freely configured
    threshold: -Infinity, 
    limit: 7,
    allowTypo: true, 
    scoreFn: null 

• commands appears in the command palette. For each command in the array the object must have a name and a command. The name is a user friendly string that will be display to the user. The command is a function that will be executed when the user clicks or presses the enter key. Commands may also include custom properties where "this" will be bound to the command, for example:

    {
      id: 1,
      color: 'pink',
      name: "Foo",
      command() {
        document.location.href = `somepage.html?id=${this.id}&color=${this.color}`;
      }
    },
    ...

• renderCommand a React.func. By default, react-command-palette will render the suggestion.name_ for each command. However, if passed a custom react component renderCommand will display the command using any template you can imageine. The renderCommand code signature follows the same coding pattern defined by react-autosuggest's renderSuggestion property.

  function RenderCommand(suggestion) {
    // A suggestion object will be passed to your custom component for each command
    const { id, color, name } = suggestion;
    return (
      <div>
        <span>{id}</span>
        <span>{color}</span>
        <span>{name}</span>
      </div>
    );
  }
  
  const commands = [{
      id: 1,
      color: 'pink',
      name: "Foo",
      command() {
        document.location.href = `somepage.html?id=${this.id}&color=${this.color}`;
      }
    } ...];
  
  <CommandPalette
    commands={commands}
    renderCommand={RenderCommand}
  />

  see: https://github.com/moroshko/react-autosuggest#rendersuggestion-required.

  Note: the suggestion.hightlight will contain the rendered markup from fuzzysort, see the options prop. If the options prop contains an array of "keys" then then suggestion.hightlight will contain an array of matches, see: fuzzysort advanced usage or checkout the sampleChromeCommand.js

  Important: renderCommand must be a pure function (react-autosuggest, upon which this is based will optimize rendering performance based on this assumption).

• maxDisplayed a number between 1 and 500 that determines the maxium number of commands that will be rendered on screen. Defaults to 7

• spinner a string or a React.ComponentType that is displayed when the user selects an item. If a custom spinner is not set then the default spinner will be used. If a custom component or string is provided then it will automatically be wrapped inside a div with a role="status" attribute. If a component is provided then it will be be wrapped in a div that also contains a sibling node with a div contain "Loading..." visible only to screen readers.

• theme enables you to apply a sample or custom look-n-feel. Two themes are included with the command palette, Chrome and Atom. The CommandPalette comes with the Atom theme enabled default.

  Creating a new theme is also possible. There are four base components that should be styled, the trigger, spinner, react-modal and react-autosuggest components. All four can be styled at once via the theme prop.

  There are two steps to styling. First create a theme object to map your custom class names to their associated components. Then add styles that use the rules mapped in the theme prop.

  For example, to style the CommandPalette using CSS Modules, do:

  /* theme.css */
  .my-modal { ... }
  .my-overlay { ... }
  .my-container { ... }
  .my-input { ... }
  ...

  /* my-component.js */
  const theme = {
    modal:         "my-modal",
    overlay:       "my-overlay",
    container:     "my-container",
    content:       "my-content",
    input:         "my-input",
    ...
  }
  
  import theme from 'theme.css';
  
  <CommandPalette theme={theme} ... />

  When not specified, theme defaults to the included Atom theme. Complete sample themes are provided, see: Chrome,Sublime and Atom

  The following picture illustrates how theme keys correspond to CommandPalette DOM structure:

  

trigger a string or a React.ComponentType the opens the command palette when clicked. If a custom trigger is not set then by default a button will be used. If a custom component or string is provided then it will automatically be wrapped inside an accessible div that will allow it be keyboard accessible, clickable and focusable for assistive technologies.

Example with a component:

// jsx trigger prop
<CommandPalette commands={data} trigger={<b>Click Me!</b>}>

// html generated trigger
<div role="button" tabindex="0"><b>Click Me!</b></div>

Example with a string:

// jsx trigger prop
<CommandPalette commands={data} trigger="Click Me!">

// html generated trigger
<div role="button" tabindex="0">Click Me!</div>

When the trigger is clicked it will open the command palette, no custom handlers or events are required.

Developer Setup

# install dependencies
$ npm install

# run lint
$ npm run lint

# beautify code
$ npm run prettier

# visual regression tests
$ npm run chromatic

# run unit tests
$ npm test

# start the dev environment
$ npm start

# update the docs
$ npm run docs

Building with Docker

Build and tag the Docker image:

$ docker build -t  react-command-palette .

Then, spin up the container once the build is done:

$ docker run -it -v ${PWD}:/app -p 6006:6006 react-command-palette npm i && npm run dev

You only need to run "npm i" the when the container is first created. The devDependencies need to be installed to compile and test the build during development. On subsequent builds run:

$ docker run -it -v ${PWD}:/app -p 6006:6006 react-command-palette npm start

Open your browser to http://localhost:6006/ and you should see the app. Try making a change to the command-palette component within your code editor. You should see the app hot-reload. Kill the server once done.

Package for production with Docker:

CodeFresh.io will autmatically run this build to prepare the package for publication to npm whenever a pull request is merged to master.

Sponsors

Visual Regression Tests by ChromaticQA