# Key Value

Aligned key–value pairs



<ComponentPreview base="ink" name="key-value-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/ink/key-value
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install ink
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="registry/bases/ink/ui/types.ts" title="components/ui/types.ts" />

      <ComponentSource src="registry/bases/ink/themes/default.ts" title="lib/terminal-themes/default.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-theme.ts" title="hooks/use-theme.ts" />

      <ComponentSource base="ink" name="key-value" title="components/ui/key-value.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { KeyValue } from "@/components/ui/key-value";
```

```tsx
<KeyValue
  items={[
    { key: "Name", value: "my-app" },
    { key: "Version", value: "2.1.0" },
    { key: "License", value: "MIT" },
  ]}
/>
```

API Reference [#api-reference]

KeyValue [#keyvalue]

| Prop         | Type             | Default    |
| ------------ | ---------------- | ---------- |
| `items`      | `KeyValueItem[]` | `required` |
| `keyWidth`   | `number`         | -          |
| `separator`  | `string`         | `":"`      |
| `keyColor`   | `string`         | -          |
| `valueColor` | `string`         | -          |

KeyValueItem [#keyvalueitem]

| Prop    | Type        | Default    |
| ------- | ----------- | ---------- |
| `key`   | `string`    | `required` |
| `value` | `ReactNode` | `required` |
| `color` | `string`    | -          |

Notes [#notes]

Accessibility [#accessibility]

termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.

* **Screen reader:** Ink labels and semantic state expose the component without relying on visual styling alone.