import * as React from "react"; import { Link } from "react-router-dom"; import Code from "./Code"; export default function Home() { return ( <>
kbar {" "} is a fully extensible command+k interface for your site.
Try it out – press cmd+k (macOS) or{" "} ctrl+k (Linux/Windows), or click the logo above.
Command+k interfaces are used to create a web experience where any type of action users would be able to do via clicking can be done through a command menu.
With macOS's Spotlight and Linear's command+k experience in mind, kbar aims to be a simple abstraction to add a fast and extensible command+k menu to your site.
Have a fully functioning command menu for your site in minutes. First, install kbar.
There is a single provider which you will wrap your app around; you do not have to wrap your entire app; however, there are no performance implications by doing so.
// ...
);
}
`}
/>
Let's add a few default actions. Actions are the core of kbar – an
action define what to execute when a user selects it.
(window.location.pathname = "blog"),
},
{
id: "contact",
name: "Contact",
shortcut: ["c"],
keywords: "email",
perform: () => (window.location.pathname = "contact"),
},
]
return (
// ...
);
}
`}
/>
Next, we will pull in the provided UI components from kbar:
// Renders the content outside the root node
// Centers the content
// Handles the show/hide and height animations
// Search input
;
);
}
`}
/>
At this point hitting cmd+k (macOS) or ctrl+k (Linux/Windows) will
animate in a search input and nothing more.
kbar provides a few utilities to render a performant list of search
results.
-
useMatches at its core returns a flattened list of
results and group name based on the current search query; i.e.{" "}
["Section name", Action, Action, "Another section name", Action,
Action]
-
KBarResults renders a performant virtualized list of these results
Combine the two utilities to create a powerful search interface:
//
// ...
function RenderResults() {
const { results } = useMatches();
return (
typeof item === "string" ? (
{item}
) : (
{item.name}
)
}
/>
);
}
`}
/>
Hit cmd+k (macOS) or ctrl+k (Linux/Windows)
and you should see a primitive command menu. kbar allows you to have
full control over all aspects of your command menu – refer to the{" "}
docs to get an understanding of further
capabilities. Looking forward to see what you build.
>
);
}