statusgenerating
"queued" | "generating" | "refining" | "complete" | "error"Where the generation is. The dots are faint while queued, full strength while generating, grow and take the image's colors while refining, and fade into the image when complete.
src-
stringURL of the generated image. Shown when complete, and its colors tint the dots while refining. From another domain, set crossOrigin for the colors.
children-
ReactNodeYour own media (Next Image, video) shown instead of an img of src. Pass tintSrc or src as well to keep the tinted dots.
tintSrcsrc
stringImage the dots take their colors from, such as a small thumbnail, so the full image isn't downloaded just for its colors.
crossOrigin-
"anonymous" | "use-credentials"CORS mode of the img of src and of the color read, kept the same so the image is fetched once. Set "anonymous" for an image on another domain served with CORS headers.
prompt-
stringThe prompt, shown in small text under the status line.
labelstatus text and prompt
stringAccessible name of the image frame, read by screen readers.
aspectRatio1 / 1
stringShape of the frame, as a CSS aspect-ratio such as "16 / 9".
focus{ x: 50, y: 50 }
{ x: number; y: number }The point of the image kept in view when the frame crops it, in percent like object-position. The tinted dots follow the same crop.
interactivetrue
booleanLets a mouse swell and gently part the dots around it, and a click send a small ripple through them, while the image is in progress.
statusText-
Partial<Record<status, string>>Replaces the built-in status text per status, such as { generating: "Drawing" }. Statuses left out keep the English default.
showStatustrue
booleanShows the status line with its icon under the frame.
onRetry-
() => voidShows a Try again button under the frame when status is "error", and is called when it is pressed.
retryLabelTry again
stringText of the retry button.
download-
boolean | stringShows a download icon button in the frame's top-right corner when status is "complete" and src is set. A string is the saved file's name; true takes the name from the end of src.
downloadLabelDownload
stringAccessible name and tooltip of the download button.
classNames-
ImageGenerationClassNamesSlot classes: frame, media and status.