CommandPalette
Search and run application commands from one place.
Live TypeScript example
Try the component here, then use the source below in your application.
Open commands, then choose Show summary or navigate to the Grid example.
import '@bluui/web/styles.css'
import { createCommandPalette } from "@bluui/web";
export function mount(host: HTMLElement) {
const output = document.createElement("p");
host.append(output);
const palette = createCommandPalette(
host,
{
TriggerLabel: "Open commands",
ShowTrigger: true,
EnableShortcut: false,
Commands: [
{
Key: "summary",
Label: "Show summary",
Description: "Run a local application action.",
},
{ Key: "grid", Label: "Open grid", Group: "Navigate" },
],
},
{
Command: (key) => {
if (key === "grid") location.hash = "grid";
else output.textContent = "Workspace summary: 3 active projects.";
},
},
);
return {
destroy() {
palette.destroy();
output.remove();
},
};
}
const instance = mount(document.getElementById('example')!)
// When this page or framework component is removed:
// instance.destroy()
Install the library and add the host element
npm install https://bluui.blutekmedia.com/downloads/bluui-web-0.2.6.tgz<div id="example"></div>This example uses the downloadable @bluui/web package. Your application handles persistence and authentication through its typed callbacks. The starter ZIP includes this same example.
This reference documents the published Block’s parameters, events, and types. The web examples adapt those inputs to browser callbacks. Open native showcase ↗
- Web examples
- Supported4 states checked · no automated failures
- TypeScript
- Supported2 states checked · no automated failures
- OutSystems
- Needs work2 states checked · 2 rule failures
Minimum requirement: WCAG 2.1 AA. Supported means the listed checks passed; full conformance is not yet declared.
Evidence and remaining verification →Purpose and use
Use a command palette for fast access to frequently used actions. Group commands and provide a visible trigger alongside a shortcut.
Keyboard design guidance
Open with the trigger or Command/Ctrl K when enabled. Up and Down change the active command; Enter runs it. Escape closes and returns focus.
This describes the intended interaction. The dated audit above identifies verified behavior and current gaps.
In your application
Provide useful labels, preserve visible focus, and test the component with your actual content. Use text alongside status colors and check contrast in each state.
Events0No events yet.
Interact with an example to see its events.