⌨️ A command palette to easily jump to specific areas within Craft

Overview

Palette

⌨️ CMD+K your way around Craft!

🤔 What is Palette?

Palette allows you to easily jump to specific areas within Craft without lifting your hands off the keyboard!

That's the elevator pitch, at least. But, sometimes, you just need a visual:

Palette being demonstrated with a user typing a variety of strings into the search field

If you're a developer, you likely use similar shortcuts today in apps like:

  • VS Code
  • Slack
  • Alfred or Raycast
  • ...and many, many others

It should also exist in the CMS you use most, right?

⚡️ Features

  • 🔍 Available on the front-end and in the control panel
  • 🌗 Light and dark mode support
  • ⭐️ Zero setup necessary; just install and enable
  • 🏎 Compatible with full-page static caching strategies like Blitz
  • 🔐 Actions change based on user permissions and if admin changes are allowed
  • 🔌 Plugins that register navigation links, settings areas, and utilities are included automatically

The light and dark themes of Palette shown side by side with the default list of results

📦 Installing

Install Palette one of two ways:

🤝 Contributing

If you would like to contribute to Palette we tried to make it as easy as possible:

  1. Clone the repo
  2. Run npm i to install the Node dependencies
  3. Run npm start to begin the watch task
  4. Make your changes
  5. Run npm run build to compile and minify the CSS and JS
  6. Submit a PR!

❤️ Shout-outs

Palette could not exist without the efforts and incredible work of:

Comments
  • Tw palette v2

    Tw palette v2

    [Description of your change]

    This is in Process

    I have added a Tailwind Custom Palette that should allow us more control in the future. Currently we are now able to have access to native events, which allows us to do things like open a link in a new tab. In progress is dark mode and scrolling with keys.

    Relevant Basecamp task(s), GitHub Issue(s), or other links

    • Basecamp task: -https://3.basecamp.com/4448010/buckets/16001607/todos/4658655283#__recording_4660176260

    Review URL (If not sandbox)

    • Sandbox
    opened by seano424 1
  • 1.7.0

    1.7.0

    Added

    • Rebuilt command palette to support opening links in new tab via keyboard and mouse inputs

    Updated

    • Updated all dependencies
    • Removed kbar dependency

    Fixed

    • Palette no longer steals focused inputs in control panel
    opened by aaronbushnell 0
  • 3.0.0

    3.0.0

    Added

    • Rebuilt command palette to support opening links in new tab via keyboard and mouse inputs

    Updated

    • Updated all dependencies
    • Removed kbar dependency

    Fixed

    • Palette no longer steals focused inputs in control panel
    opened by aaronbushnell 0
  • Custom UI

    Custom UI

    [Description of your change] This is the custom palette using tailwind css

    Relevant Basecamp task(s), GitHub Issue(s), or other links

    • Basecamp task:
    • https://3.basecamp.com/4448010/buckets/16001607/todos/4658655283#__recording_4660176260

    Review URL (If not sandbox)

    • Sandbox
    opened by seano424 0
  • Headless UI

    Headless UI

    [Description of your change] This is using headless ui

    Relevant Basecamp task(s), GitHub Issue(s), or other links

    • Basecamp task:
    • https://3.basecamp.com/4448010/buckets/16001607/todos/4658655283#__recording_4660176260

    Review URL (If not sandbox)

    • Sandbox
    opened by seano424 0
  • 1.4.0

    1.4.0

    Added

    • New action: "Edit this entry". If we can map the URI of the front-end request to a Craft entry it will be added as the first action; allowing you to jump to that entry edit view from the front-end.

    Updated

    • "Go to {systemName}" action now only renders when calling Palette on a control panel route
    opened by aaronbushnell 0
  • 1.2.0

    1.2.0

    Added

    • New badgeCount property to display Craft's badge count values
    • Add badge counts for primary navigation items

    Updated

    • Move the Utility navigation badge count into the badgeCount property

    Fixed

    • Exclude source files from being included in the Composer package
    opened by aaronbushnell 0
  • 1.1.0

    1.1.0

    1.1.0 - 2022-02-07

    Added

    • New action: "Go to {systemName}": Go to the URL defined by siteUrl
    • Show the badge count when rendering utility items (for actions like "Updates")
    opened by aaronbushnell 0
Releases(3.1.0)
Owner
TrendyMinds
TrendyMinds is an Indianapolis-based agency working globally that specializes in web, video, advertising and PR.
TrendyMinds
Image Optimize Command - Easily optimize images using WP CLI

Image Optimize Command is a WP CLI wrapper for spatie/image-optimizer which optimize gif, jpeg, jpg, png, svg, webp images by running them through a chain of various image optimization tools.

Typist Tech Limited 157 Dec 13, 2022
A CLI tool to check whether a specific composer package uses imported symbols that aren't part of its direct composer dependencies

A CLI tool to analyze composer dependencies and verify that no unknown symbols are used in the sources of a package. This will prevent you from using "soft" dependencies that are not defined within your composer.json require section.

Matthias Glaub 722 Dec 30, 2022
Lovely PHP wrapper for using the command-line

ShellWrap What is it? It's a beautiful way to use powerful Linux/Unix tools in PHP. Easily and logically pipe commands together, capture errors as PHP

James Hall 745 Dec 30, 2022
A PHP library for command-line argument processing

GetOpt.PHP GetOpt.PHP is a library for command-line argument processing. It supports PHP version 5.4 and above. Releases For an overview of the releas

null 324 Dec 8, 2022
Command-Line Interface tools

Aura.Cli Provides the equivalent of request ( Context ) and response ( Stdio ) objects for the command line interface, including Getopt support, and a

Aura for PHP 102 Dec 31, 2022
Another Command Line Argument Parser

Optparse — Another Command Line Argument Parser Install 1. Get composer. 2. Put this into your local composer.json: { "require": { "chh/optparse

Christoph Hochstrasser 18 Nov 1, 2019
👨🏻‍🚀 A command-line tool that gives you the Alpine Day 2021 schedule in your timezone. 🚀

Alpine Day Schedule a command-line tool that gives you the Alpine Day 2021 schedule in your timezone. ?? Quick start Requires PHP 7.4+ # First, instal

Nuno Maduro 11 Jun 10, 2021
PHP Interminal is a command-line tool that gives you access to PHP Internals discussions in your terminal.

PHP Interminal is a command-line tool that gives you access to PHP Internals discussions in your terminal. ??

Nuno Maduro 32 Dec 26, 2022
Patrol is an elegant command-line tool that keeps your PHP Project's dependencies in check.

Patrol is an elegant command-line tool that keeps your PHP Project's dependencies in check. Installation / Usage Requires PHP 8.0+ First, install Patr

Nuno Maduro 237 Nov 14, 2022
Twitter raffles in the command line, with PHP and minicli

Rafflebird Rafflebird is a highly experimental CLI application for giveaways / raffles on Twitter, built in PHP with Minicli. Disclaimer: The recent s

Erika Heidi 33 Nov 16, 2022
A command line code generator for Drupal.

Drupal Code Generator A command line code generator for Drupal. Installation Download the latest stable release of the code generator.

Ivan 227 Dec 14, 2022
A PHP command line tool used to install shlink

Shlink installer A PHP command line tool used to install shlink. Installation Install this tool using composer.

null 8 Nov 3, 2022
Laracon Schedule a command-line tool that gives you the Laracon Online schedule in your timezone.

Laracon Schedule a command-line tool that gives you the Laracon Online schedule in your timezone. ?? Quick start Requires PHP 7.4+ # First, install: c

Nuno Maduro 101 Sep 16, 2022
Vendor publish command for Lumen framework.

vendor:publish for Lumen framework This package contains a single command borrowed from the Laravel framework that enables you to use php artisan vend

Laravelista 208 Aug 12, 2022
Command-line control panel for Nginx Server to manage WordPress sites running on Nginx, PHP, MySQL, and Let's Encrypt

EasyEngine v4 EasyEngine makes it greatly easy to manage nginx, a fast web-server software that consumes little memory when handling increasing volume

EasyEngine 2k Jan 4, 2023
Backup your laravel database by a simple artisan command

Backup your laravel database by a simple artisan command This package will allow you to backup your laravel app database and you can also choose to se

Mohammed Omer 23 Feb 10, 2022
Generic PHP command line flags parse library

PHP Flag Generic PHP command line flags parse library Features Generic CLI options and arguments parser. Support set value data type(int,string,bool,a

PHP Toolkit 23 Nov 13, 2022
A simple command-line tool whose aim is to facilitate the continous delivery of PHP apps

Deployer Simple command-line tool that aims to facilitate the continous delivery of PHP apps, particularly Laravel apps. Imagine you want to update yo

Fernando Bevilacqua 4 Sep 8, 2021