# vue-cmdk

> A small, accessible command palette for Vue 3.

## Docs

- [Introduction](https://vue-cmdk-docs.vercel.app/): A small command palette for Vue 3 that works well from the keyboard and with screen readers.
- [Getting started](https://vue-cmdk-docs.vercel.app/getting-started): Install vue-cmdk-palette, import the optional theme, and render a palette.
- [Examples](https://vue-cmdk-docs.vercel.app/examples): Live palettes from minimal to fully featured, each next to the exact file that runs it.
- [Changelog](https://vue-cmdk-docs.vercel.app/changelog): Every release of vue-cmdk, newest first.

## Guides

- [Opening the palette](https://vue-cmdk-docs.vercel.app/guides/opening-the-palette): Change the shortcut, add more of them, open on slash, or open the palette from your own code.
- [Commands](https://vue-cmdk-docs.vercel.app/guides/commands): The three kinds of command, and every optional field they share.
- [Nested pages](https://vue-cmdk-docs.vercel.app/guides/nested-pages): Commands that open a second list, loaded up front or on demand.
- [Search](https://vue-cmdk-docs.vercel.app/guides/search): How the query matches and ranks rows, and how to swap in your own matcher.
- [Scopes](https://vue-cmdk-docs.vercel.app/guides/scopes): Chips that narrow the list to one kind of command, with optional typed prefixes.
- [Recents](https://vue-cmdk-docs.vercel.app/guides/recents): Pin the commands people use most, and store them wherever you like.
- [Custom rows and slots](https://vue-cmdk-docs.vercel.app/guides/custom-rows): Replace parts of the palette's markup without losing keyboard support.
- [Headless composable](https://vue-cmdk-docs.vercel.app/guides/headless): Use the palette's state and ARIA wiring with your own markup.
- [Styling](https://vue-cmdk-docs.vercel.app/guides/styling): Theme the palette with CSS variables, restyle it with data attributes, or write every rule yourself.
- [Keyboard and accessibility](https://vue-cmdk-docs.vercel.app/guides/keyboard-and-accessibility): Every key the palette handles, and how it works with screen readers.

## Reference

- [Components](https://vue-cmdk-docs.vercel.app/reference/components): Props, events, slots and labels for CommandPalette and CommandPaletteDialog.
- [Composable](https://vue-cmdk-docs.vercel.app/reference/composable): Options and return values of useCommandPalette, plus the smaller composables it is built from.
- [Utilities and types](https://vue-cmdk-docs.vercel.app/reference/utilities): The framework-free helpers and TypeScript types the package exports.

## Agent skills

- [vue-cmdk](https://vue-cmdk-docs.vercel.app/.well-known/agent-skills/vue-cmdk/SKILL.md): Read the vue-cmdk docs instead of answering from memory. A small, accessible command palette for Vue 3. Use when a task involves vue-cmdk: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://vue-cmdk-docs.vercel.app/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://vue-cmdk-docs.vercel.app/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://vue-cmdk-docs.vercel.app/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://vue-cmdk-docs.vercel.app/openapi.json.
- [Agent skills](https://vue-cmdk-docs.vercel.app/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://vue-cmdk-docs.vercel.app/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://vue-cmdk-docs.vercel.app/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://vue-cmdk-docs.vercel.app/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://vue-cmdk-docs.vercel.app/sitemap.xml): Every indexable page URL with its last-modified date.