@upstream-app/cmdk
v1.1.2TypeScript
<p align="center"> <img src="./website/public/og.png" /> </p>
0/weekUpdated 7 months agoMITUnpacked: 80.7 KB
Published by Your Name
npm install @upstream-app/cmdk
⌘K  
⌘K is a command menu React component that can also be used as an accessible combobox. You render items, it filters and sorts them automatically. ⌘K supports a fully composable API How?, so you can wrap items in other components or even as static JSX.
Demo and examples: cmdk.paco.me
Install
``bash`
pnpm install cmdk
Use
`tsx
import { Command } from 'cmdk'
const CommandMenu = () => {
return (
)
}
`
Or in a dialog:
`tsx
import { Command } from 'cmdk'
const CommandMenu = () => {
const [open, setOpen] = React.useState(false)
// Toggle the menu when ⌘K is pressed
React.useEffect(() => {
const down = (e) => {
if (e.key === 'k' && (e.metaKey || e.ctrlKey)) {
e.preventDefault()
setOpen((open) => !open)
}
}
document.addEventListener('keydown', down)
return () => document.removeEventListener('keydown', down)
}, [])
return (
)
}
`
Parts and styling
All parts forward props, including ref, to an appropriate element. Each part has a specific data-attribute (starting with cmdk-) that can be used for styling.
$3
Render this to show the command menu inline, or use Dialog to render in a elevated context. Can be controlled with the value and onValueChange props.
> Note
>
> Values are always trimmed with the trim() method.
`tsx
const [value, setValue] = React.useState('apple')
return (
)
`
You can provide a custom filter function that is called to rank each item. Note that the value will be trimmed.
`tsx`
if (value.includes(search)) return 1
return 0
}}
/>
A third argument, keywords, can also be provided to the filter function. Keywords act as aliases for the item value, and can also affect the rank of the item. Keywords are trimmed.
`tsx`
const extendValue = value + ' ' + keywords.join(' ')
if (extendValue.includes(search)) return 1
return 0
}}
/>
Or disable filtering and sorting entirely:
`tsx`
{filteredItems.map((item) => {
return (
{item}
)
})}
You can make the arrow keys wrap around the list (when you reach the end, it goes back to the first item) by setting the loop prop:
`tsx`
$3
Props are forwarded to Command. Composes Radix UI's Dialog component. The overlay is always rendered. See the Radix Documentation for more information. Can be controlled with the open and onOpenChange props.
`tsx
const [open, setOpen] = React.useState(false)
return (
...
)
`
You can provide a container prop that accepts an HTML element that is forwarded to Radix UI's Dialog Portal component to specify which element the Dialog should portal into (defaults to body). See the Radix Documentation for more information.
`tsx
const containerElement = React.useRef(null)
return (
<>
)
`
$3
All props are forwarded to the underlying
element. Can be controlled with the value and onValueChange props.`tsx
const [search, setSearch] = React.useState('')return
`$3
Contains items and groups. Animate height using the
CSS variable.`css
[cmdk-list] {
min-height: 300px;
height: var(--cmdk-list-height);
max-height: 500px;
transition: height 100ms ease;
}
`To scroll item into view earlier near the edges of the viewport, use scroll-padding:
css
[cmdk-list] {
scroll-padding-block-start: 8px;
scroll-padding-block-end: 8px;
}
`$3
Item that becomes active on pointer enter. You should provide a unique
for each item, but it will be automatically inferred from the .textContent.`tsx
// Value is implicity "apple" because of the provided text content
>
Apple
`You can also provide a
prop to help with filtering. Keywords are trimmed.`tsx
Apple
`tsx
// Value is implicity "apple" because of the provided text content
>
Apple
`You can force an item to always render, regardless of filtering, by passing the
prop.$3
Groups items together with the given
heading ([cmdk-group-heading]).`tsx
Apple
`Groups will not unmount from the DOM, rather the
attribute is applied to hide it from view. This may be relevant in your styling.You can force a group to always render, regardless of filtering, by passing the
forceMount prop.$3
Visible when the search query is empty or
alwaysRender is true, hidden otherwise.$3
Automatically renders when there are no results for the search query.
$3
You should conditionally render this with
progress while loading asynchronous items.`tsx
const [loading, setLoading] = React.useState(false)return {loading && Hang on… }
`$3
. Pass a function that returns a slice of the command menu state to re-render when that slice changes. This hook is provided for advanced use cases and should not be commonly used.A good use case would be to render a more detailed empty state, like so:
`tsx
const search = useCommandState((state) => state.search)
return No results found for "{search}".
`Examples
Code snippets for common use cases.
$3
Often selecting one item should navigate deeper, with a more refined set of items. For example selecting "Change theme…" should show new items "Dark theme" and "Light theme". We call these sets of items "pages", and they can be implemented with simple state:
tsx
const ref = React.useRef(null)
const [open, setOpen] = React.useState(false)
const [search, setSearch] = React.useState('')
const [pages, setPages] = React.useState([])
const page = pages[pages.length - 1]return (
// Escape goes to previous page
// Backspace goes to previous page when search is empty
if (e.key === 'Escape' || (e.key === 'Backspace' && !search)) {
e.preventDefault()
setPages((pages) => pages.slice(0, -1))
}
}}
>
{!page && (
<>
setPages([...pages, 'projects'])}>Search projects…
setPages([...pages, 'teams'])}>Join a team…
)}
{page === 'projects' && (
<>
Project A
Project B
)}
{page === 'teams' && (
<>
Team 1
Team 2
)}
)
`$3
If your items have nested sub-items that you only want to reveal when searching, render based on the search state:
tsx
const SubItem = (props) => {
const search = useCommandState((state) => state.search)
if (!search) return null
return
}return (
Change theme…
Change theme to dark
Change theme to light
)
`$3
Render the items as they become available. Filtering and sorting will happen automatically.
tsx
const [loading, setLoading] = React.useState(false)
const [items, setItems] = React.useState([])React.useEffect(() => {
async function getItems() {
setLoading(true)
const res = await api.get('/dictionary')
setItems(res)
setLoading(false)
}
getItems()
}, [])
return (
{loading && Fetching words… }
{items.map((item) => {
return (
word-${item}} value={item}>
{item}
)
})}
)
`$3
We recommend using the Radix UI popover component. ⌘K relies on the Radix UI Dialog component, so this will reduce your bundle size a bit due to shared dependencies.
bash
$ pnpm install @radix-ui/react-popover
`Render
inside of the popover content:`tsx
import * as Popover from '@radix-ui/react-popover'return (
Toggle popover
Apple
)
`$3
You can find global stylesheets to drop in as a starting point for styling. See website/styles/cmdk for examples.
FAQ
Accessible? Yes. Labeling, aria attributes, and DOM ordering tested with Voice Over and Chrome DevTools. Dialog composes an accessible Dialog implementation.
Virtualization? No. Good performance up to 2,000-3,000 items, though. Read below to bring your own.
Filter/sort items manually? Yes. Pass
to Command. Better memory usage and performance. Bring your own virtualization this way.React 18 safe? Yes, required. Uses React 18 hooks like
useId and useSyncExternalStore.Unstyled? Yes, use the listed CSS selectors.
Hydration mismatch? No, likely a bug in your code. Ensure the
open prop to Command.Dialog is false on the server.React strict mode safe? Yes. Open an issue if you notice an issue.
Weird/wrong behavior? Make sure your
Command.Item has a key and unique value.Concurrent mode safe? Maybe, but concurrent mode is not yet real. Uses risky approaches like manual DOM ordering.
React server component? No, it's a client component.
Listen for ⌘K automatically? No, do it yourself to have full control over keybind context.
React Native? No, and no plans to support it. If you build a React Native version, let us know and we'll link your repository here.
History
Written in 2019 by Paco (@pacocoursey) to see if a composable combobox API was possible. Used for the Vercel command menu and autocomplete by Rauno (@raunofreiberg) in 2020. Re-written independently in 2022 with a simpler and more performant approach. Ideas and help from Shu (@shuding\_).
use-descendants was extracted from the 2019 version.
Testing
First, install dependencies and Playwright browsers:
`bash
pnpm install
pnpm playwright install
`Then ensure you've built the library:
bash
pnpm build
`Then run the tests using your local build against real browser engines:
bash
pnpm test
``