---
title: "Bot Command Card"
description: "A card documenting a slash command, its owning bot and its typed options."
---

A card documenting a slash command, its owning bot and its typed options. Compose it from the exported registry parts so local content and behaviour stay in the application while the visual contract stays token-driven.

_Live example of Bot Command Card — see the page for the rendered demo._

## Installation

```bash
npx newtui@latest add bot-command-card
``` Registry dependencies, installed with it: badge.

Files written — React: components/ui/bot-command-card.tsx. Vue: components/ui/bot-command-card/BotCommandCard.vue, components/ui/bot-command-card/BotCommandCardHeader.vue, components/ui/bot-command-card/BotCommandCardName.vue, components/ui/bot-command-card/BotCommandCardDescription.vue, components/ui/bot-command-card/BotCommandCardOptions.vue, components/ui/bot-command-card/BotCommandCardOption.vue, components/ui/bot-command-card/index.ts.

## Usage

React:

```tsx
import { BotCommandCard } from "@/components/ui/bot-command-card"
```

Vue:

```ts
import { BotCommandCard, BotCommandCardHeader, BotCommandCardName, BotCommandCardDescription, BotCommandCardOptions, BotCommandCardOption } from "@/components/ui/bot-command-card"
```

## API reference

**`BotCommandCardName`**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `slash` | `boolean \| undefined` | — | Render the muted leading slash. Defaults to true. |

**`BotCommandCardOption`**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | `string` | — | Option name, rendered in monospace. |
| `type` | `string \| undefined` | — | Option type, e.g. `STRING`, `USER`, `INTEGER`. |
| `required` | `boolean \| undefined` | — | Marks the option as required. |
| `requiredLabel` | `string \| undefined` | — | Label used for the required marker. |
| `description` | `React.ReactNode \| undefined` | — | Human readable description. |

The registry exports `BotCommandCard`, `BotCommandCardHeader`, `BotCommandCardName`, `BotCommandCardDescription`, `BotCommandCardOptions`, `BotCommandCardOption`. Parts without a table accept the native attributes for the element they render; React uses `className`, while Vue uses `class` and fallthrough attributes.

## Accessibility

Preserve the native semantics of the rendered elements and pass through ARIA attributes when the surrounding context needs a label or description. Any interactive child needs a visible focus indicator, and meaning must not rely on colour alone.

## Tokens

Bot Command Card reads its colours, radii and motion from the `--newt-*` tokens. Override a token rather than editing the component.