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:

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

📦 Installing

Install Palette one of two ways:

• Install via Craft's Plugin Store
• Run composer require trendyminds/craft-palette and enable the plugin from "Settings > Plugins"

🤝 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:

• The Pixel & Tonic team and their hard work on Craft
• Resources like pluginfactory.io, the nystudio107 blog, and CraftQuest
• The wonderful Craft CMS community And tools like Tailwind CSS, PostCSS, and esbuild