docs/components/frame
Sections
Components
Utilities
Forms
Hooks
Copy Markdown
Bordered box for grouping related content.
PreviewCode
Section description
CLIManual
pnpmbunnpmyarn
pnpm dlx shadcn@latest add @shark/frame
Frame
├── FramePanel
└── FrameHeader
├── FrameTitle
├── FrameDescription
└── FrameFooter
import {
Frame,
FrameHeader,
FrameTitle,
FrameDescription,
FramePanel,
FrameFooter,
} from "@/components/ui/frame";
<Frame>
<FrameHeader>
<FrameTitle>Title</FrameTitle>
<FrameDescription>Description</FrameDescription>
</FrameHeader>
<FramePanel>Content</FramePanel>
<FrameFooter>Footer</FrameFooter>
</Frame>
FrameHeader supports two usage patterns:
Pass title and description props directly to FrameHeader.
<FrameHeader title="Frame Title" description="Frame description" />
This approach does not require
FrameTitleorFrameDescriptioncomponents.
Use FrameTitle and FrameDescription as children for more control.
<FrameHeader>
<FrameTitle>Frame Title</FrameTitle>
<FrameDescription>Frame description</FrameDescription>
</FrameHeader>
By default, multiple panels are separated with spacing between them.
PreviewCode
Section description
Section description
Main container for grouping related content into panels.
| Prop | Type | Default |
|---|---|---|
className | string | - |
asChild | boolean | false |
A single panel with optional header and footer.
| Prop | Type | Default |
|---|---|---|
className | string | - |
asChild | boolean | false |
Header area for the panel. Often contains title and description.
| Prop | Type | Default |
|---|---|---|
className | string | - |
asChild | boolean | false |
Panel title or heading.
| Prop | Type | Default |
|---|---|---|
className | string | - |
asChild | boolean | false |
Panel description or subtitle.
| Prop | Type | Default |
|---|---|---|
className | string | - |
asChild | boolean | false |
Footer area for the panel. Often contains actions.
| Prop | Type | Default |
|---|---|---|
className | string | - |
asChild | boolean | false |
[
Previous page
Floating Panel ](/docs/components/floating-panel)[
Next page
Hint ](/docs/components/hint)
On This Page
InstallationAnatomyUsageTitle & DescriptionUsing propsUsing componentsExamplesSeparated PanelsAPI ReferenceFrameFramePanelFrameHeaderFrameTitleFrameDescriptionFrameFooter