# Panel

Titled bordered panel



<ComponentPreview base="ink" name="panel-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/panel
    ```
  </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 src="registry/bases/ink/hooks/use-unicode.ts" title="hooks/use-unicode.ts" />

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

      <ComponentSource base="ink" name="panel" title="components/ui/panel.tsx" />

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

Usage [#usage]

```tsx
import { Panel } from "@/components/ui/panel";
```

```tsx
<Panel title="System Status" borderStyle="round" width={40}>
  <Text>All services operational</Text>
</Panel>
```

API Reference [#api-reference]

Panel [#panel]

| Prop          | Type                                                                                         | Default |
| ------------- | -------------------------------------------------------------------------------------------- | ------- |
| `title`       | `string`                                                                                     | -       |
| `titleColor`  | `string`                                                                                     | -       |
| `borderColor` | `string`                                                                                     | -       |
| `borderStyle` | `"single" \| "double" \| "round" \| "bold" \| "singleDouble" \| "doubleSingle" \| "classic"` | -       |
| `bordered`    | `boolean`                                                                                    | `true`  |
| `width`       | `number`                                                                                     | -       |
| `height`      | `number`                                                                                     | -       |
| `paddingX`    | `number`                                                                                     | `1`     |
| `paddingY`    | `number`                                                                                     | `0`     |
| `children`    | `ReactNode`                                                                                  | -       |

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:** Screen-reader mode removes decorative output while preserving meaningful labels and state.