# Drawer

Slide-in panel from any edge



<ComponentPreview base="ink" name="drawer-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/drawer
    ```
  </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/hooks/use-interaction.tsx" title="hooks/use-interaction.tsx" />

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

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

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

Usage [#usage]

```tsx
import { Drawer } from "@/components/ui/drawer";
```

```tsx
<Drawer
  isOpen={true}
  edge="right"
  title="Details"
  width={40}
  onClose={() => close()}
>
  <Text>Name: my-project</Text>
  <Text>Status: active</Text>
</Drawer>
```

API Reference [#api-reference]

Drawer [#drawer]

| Prop       | Type                                     | Default    |
| ---------- | ---------------------------------------- | ---------- |
| `isOpen`   | `boolean`                                | `false`    |
| `edge`     | `"left" \| "right" \| "top" \| "bottom"` | `"right"`  |
| `title`    | `string`                                 | -          |
| `children` | `ReactNode`                              | `required` |
| `onClose`  | `() => void`                             | -          |
| `width`    | `number`                                 | `40`       |
| `height`   | `number`                                 | `10`       |

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.

* **Keyboard:** `Tab` / `Shift+Tab` move through enabled controls inside the active scope; `Enter` / `Space` activate the focused control; `Escape` closes only the topmost active surface and restores focus.
* **Focus and composition:** While open, the active focus scope contains traversal, gives input ownership to the topmost scope, and restores focus when it closes.
* **Screen reader:** Ink labels and semantic state expose the component without relying on visual styling alone.