d1a1135328
* docs: create a new UI docs project (#13233) * docs: create a new UI docs project * fix installation errors * docs: migrate UI docs content to new project (#13241) * Fix content * added examples for some components * finish adding examples * lint fix * fix build errors * delete empty files * path fixes + refactor * fix build error
58 lines
1.1 KiB
Plaintext
58 lines
1.1 KiB
Plaintext
---
|
|
generate_toc: true
|
|
---
|
|
|
|
import { ComponentExample } from "@/components/ComponentExample"
|
|
import { ComponentReference } from "@/components/ComponentReference"
|
|
|
|
export const metadata = {
|
|
title: `Command Bar`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
A component that displays a command bar with a list of commands to perform on a bulk selection of items.
|
|
|
|
In this guide, you'll learn how to use the Command Bar component.
|
|
|
|
<ComponentExample name="command-bar-demo" />
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { CommandBar } from "@medusajs/ui"
|
|
```
|
|
|
|
```tsx
|
|
<CommandBar open={open}>
|
|
<CommandBar.Bar>
|
|
<CommandBar.Value>{count} selected</CommandBar.Value>
|
|
<CommandBar.Seperator />
|
|
<CommandBar.Command
|
|
action={onDelete}
|
|
label="Delete"
|
|
shortcut="d"
|
|
/>
|
|
<CommandBar.Seperator />
|
|
<CommandBar.Command
|
|
action={onEdit}
|
|
label="Edit"
|
|
shortcut="e"
|
|
/>
|
|
</CommandBar.Bar>
|
|
</CommandBar>
|
|
```
|
|
|
|
---
|
|
|
|
## API Reference
|
|
|
|
<ComponentReference mainComponent="CommandBar" componentsToShow={[
|
|
"CommandBar",
|
|
"CommandBar.Bar",
|
|
"CommandBar.Value",
|
|
"CommandBar.Seperator",
|
|
"CommandBar.Command"
|
|
]} hideFeedback />
|
|
|