components/generation-frame

Import

Import

import * as api from "@fungi.computer/caps/components/generation-frame";

Exports

Kind	Export	Description
Ttype alias	GenerationStatus	Where one generated piece of media is in its life.
Ttype alias	GenerationFrameProps	Props accepted by GenerationFrame.
constconstant	GenerationFrame	One fixed frame for a generation, from queued to done: the frame keeps its size the whole time, so nothing around it moves. The finished media develops inside it (it sharpens out of a soft blur), and a failure dims the frame behind its message. Reduced motion keeps short fades only.

GenerationStatusTtype alias

Signature

type GenerationStatus =
  "queued" | "generating" | "refining" | "done" | "failed";

Where one generated piece of media is in its life.

---

GenerationFramePropsTtype alias

Signature

type GenerationFrameProps = object &
  Omit<HTMLAttributes<HTMLDivElement>, "children">;

Props accepted by GenerationFrame.

Type Declaration

Name	Type	Description
status	GenerationStatus	-
children?	ReactNode	The finished media (or, while refining, a rough preview of it).
aspectRatio?	number	Width over height. Omit when the parent already sizes the frame.
label?	ReactNode	What is happening, for people using a screen reader.
indicator?	ReactNode	The working indicator; Caps’ bloom loader by default.
failure?	ReactNode	Shown over the dimmed frame when generation fails.

GenerationFrameconstconstant

Signature

const GenerationFrame: ForwardRefExoticComponent<
  object &
    Omit<HTMLAttributes<HTMLDivElement>, "children"> &
    RefAttributes<HTMLDivElement>
>;

One fixed frame for a generation, from queued to done: the frame keeps its size the whole time, so nothing around it moves. The finished media develops inside it (it sharpens out of a soft blur), and a failure dims the frame behind its message. Reduced motion keeps short fades only.