UI

Showcase frame

The shell a showcase shares: a page column, a wordmark with its sections, and a foot.

Read Markdown

Web 0.2.0

Your work appears here.

Example Studio

  • 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

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-frame

Props

ShowcaseFrame

PropTypeRequiredDescription
wordmarkstringyesThe name at the head, and the page it points home to.
actionReactNodenoThe one control the header carries, such as the page's next step.
childrenReactNodeno
footerReactNodenoThe quiet line at the left of the foot.
homeHrefstring | undefinedno
navigationreadonly FrameLink[] | undefinedno
notestring | undefinednoThe quiet line at the right of the foot, and the page it points at.
noteHrefstring | undefinedno
stickyboolean | undefinednoKeeps the head in view while the page scrolls.
styleCSSProperties | undefinedno

Proof

Contrast

measured on 0.2.0

StateForegroundBackgroundRatioFloor
defaultrgb(67 77 86)rgb(248 245 240)7.93AA 4.5
default (dark)rgb(181 182 182)rgb(7 21 34)9.07AA 4.5

Keyboard

measured on 0.2.0

KeyAction
TabTraverse every enabled control in caller reading order and exit
EnterFollow Review studio to #studio-home
EnterFollow Studio work to #studio-work
EnterFollow Studio terms to #studio-terms
EnterActivate Contact studio: contact-requested
SpaceActivate Contact studio: contact-requested
EnterFollow Read studio case to #studio-case
EnterFollow Studio credits to #studio-credits
Shift+TabReturn 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