The project is in a healthy, maintained state
A command palette for Rails using Stimulus and Ninja Keys.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.17, <= 3
>= 7.0, <= 20.0

Runtime

>= 6.0
 Project Readme

rails_command_palette

A command palette for Rails using Stimulus and Ninja Keys.

Install

Install the gem:

bundle add rails_command_palette --github=rootlyhq/rails_command_palette

Install Ninja Keys:

yarn add --dev ninja-keys

Install the Stimulus controller:

rails g command_palette:install

Usage

Controller

add_command(id:, title:, href: nil, frame: nil, hotkey: nil, icon: nil, section: nil, parent: nil, children: nil, **options)

frame is used when calling Turbo.visit for commands with href. icon accepts HTML.

View

<%= command_palette %>

License

The gem is available as open source under the terms of the MIT License.