---
title: Frame
description: A framed container for grouping related information.
---

<ComponentPreview name="p-frame-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>
<TabsPanel value="cli">

```bash
npx shadcn@latest add @coss/frame
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

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

<ComponentSource name="frame" title="components/ui/frame.tsx" />

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

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

```tsx
import {
  Frame,
  FrameDescription,
  FrameFooter,
  FrameHeader,
  FramePanel,
  FrameTitle,
} from "@/components/ui/frame"
```

```tsx
<Frame>
  <FrameHeader>
    <FrameTitle>Title</FrameTitle>
    <FrameDescription>Description</FrameDescription>
  </FrameHeader>
  <FramePanel>Content</FramePanel>
  <FrameFooter>Footer</FrameFooter>
</Frame>
```

## API Reference

### Frame

The main container component for grouping related information.

| Prop        | Type     | Default |
| ----------- | -------- | ------- |
| `className` | `string` |         |

### FramePanel

A panel container for frame content.

| Prop        | Type     | Default |
| ----------- | -------- | ------- |
| `className` | `string` |         |

```tsx
<FramePanel>Content</FramePanel>
```

### FrameHeader

Header section for the frame.

| Prop        | Type     | Default |
| ----------- | -------- | ------- |
| `className` | `string` |         |

```tsx
<FrameHeader>
  <FrameTitle>Title</FrameTitle>
  <FrameDescription>Description</FrameDescription>
</FrameHeader>
```

### FrameTitle

Title text for the frame header.

| Prop        | Type     | Default |
| ----------- | -------- | ------- |
| `className` | `string` |         |

```tsx
<FrameTitle>Title</FrameTitle>
```

### FrameDescription

Description text for the frame header.

| Prop        | Type     | Default |
| ----------- | -------- | ------- |
| `className` | `string` |         |

```tsx
<FrameDescription>Description</FrameDescription>
```

### FrameFooter

Footer section for the frame.

| Prop        | Type     | Default |
| ----------- | -------- | ------- |
| `className` | `string` |         |

```tsx
<FrameFooter>Footer</FrameFooter>
```

## Examples

### Separated Panels

By default, multiple panels are separated with spacing between them.

<ComponentPreview name="p-frame-3" />