Cmdk

Theme by Pacocoursey

|

Updated: 14 Mar 2025

|

11155 Stars

Fast, unstyled command menu React component.

Categories

Overview:

⌘K cmdk is a React component that functions as a command menu and an accessible combobox. It automatically filters and sorts rendered items and supports a fully composable API, allowing customization through wrapping items in other components or static JSX.

Features:

• Composable API: Easily wrap items in other components or static JSX.
• Automatic Filtering and Sorting: Items are filtered and sorted automatically.
• Support for Accessibility: Can be used as an accessible combobox.
• Custom Filter Function: Ability to provide a custom filter function for ranking items.
• Interactive Interface: Arrow keys can be set to wrap around the list.
• Dialog Component: Composes Radix UI’s Dialog component for an elevated context.
• Item Grouping: Items can be grouped together with customizable headings.
• Loading Indicator: Provides a loading indicator component for conditional rendering.

Installation:

To install the ⌘K cmdk package, you can use npm or yarn. Here is an example using npm:

npm install cmdk

For yarn, you can use:

yarn add cmdk

Summary:

The ⌘K cmdk React component is a versatile tool that serves as a command menu and combobox with features like automatic filtering, sorting, and support for accessibility. Its composable API allows for flexibility in customization, making it a valuable addition for interactive interfaces and applications requiring dynamic lists and dropdowns.