Showcase frame
The shell a showcase shares: a page column, a wordmark with its sections, and a foot.
Web 0.2.0
Your work appears here.
- Defaultlight7.93 : 1AA 4.5dark9.07 : 1AA 4.5
- KeyboardTabEnterSpaceShift+Tab
- measured on 0.2.0
npx shadcn@latest add @maeso/showcase-frame- Size
- 1.8 kB gzipmeasured on 0.2.0
- First install
- Add the registry once
Usage
Frame the supplied preview and explain what it demonstrates. Keep the preview's state separate from real production results.
Accessibility
Provide a useful title or description for the preview. Keep embedded content and controls reachable at narrow widths.
When to use
Use to present an example surface. Do not treat a staged preview as evidence of a completed real-world action.
Install
Add this registry to your project's components.json once, before the first install. Keep your existing settings and other registries.
{
"registries": {
"@maeso": "http://127.0.0.1:4321/r/{name}.json"
}
}Then install the registry's default theme once, and import its sheet in the CSS entry that imports Tailwind. It paints every item from this registry.
npx shadcn@latest add @maeso/maeso@import "./styles/theme.web.css";npx shadcn@latest add @maeso/showcase-frameProps
ShowcaseFrame
| Prop | Type | Required | Description |
|---|---|---|---|
| wordmark | string | yes | The name at the head, and the page it points home to. |
| action | ReactNode | no | The one control the header carries, such as the page's next step. |
| children | ReactNode | no | |
| footer | ReactNode | no | The quiet line at the left of the foot. |
| homeHref | string | undefined | no | |
| navigation | readonly FrameLink[] | undefined | no | |
| note | string | undefined | no | The quiet line at the right of the foot, and the page it points at. |
| noteHref | string | undefined | no | |
| sticky | boolean | undefined | no | Keeps the head in view while the page scrolls. |
| style | CSSProperties | undefined | no |
Proof
Contrast
measured on 0.2.0
| State | Foreground | Background | Ratio | Floor |
|---|---|---|---|---|
| default | rgb(67 77 86) | rgb(248 245 240) | 7.93 | AA 4.5 |
| default (dark) | rgb(181 182 182) | rgb(7 21 34) | 9.07 | AA 4.5 |
Keyboard
measured on 0.2.0
| Key | Action |
|---|---|
| Tab | Traverse every enabled control in caller reading order and exit |
| Enter | Follow Review studio to #studio-home |
| Enter | Follow Studio work to #studio-work |
| Enter | Follow Studio terms to #studio-terms |
| Enter | Activate Contact studio: contact-requested |
| Space | Activate Contact studio: contact-requested |
| Enter | Follow Read studio case to #studio-case |
| Enter | Follow Studio credits to #studio-credits |
| Shift+Tab | Return through every enabled control and exit to the entry sentinel |
Size
1820 gzip bytes · measured on 0.2.0
Example
import { ShowcaseFrame } from "@/components/ui/_kit/blocks/showcase-frame/ShowcaseFrame";
export default function Example() {
return <ShowcaseFrame wordmark="Example Studio" navigation={[{ label: "Work", href: "#work" }]} footer="Example Studio"><p>Your work appears here.</p></ShowcaseFrame>;
}
not on native yet