v0.3.0
Note: This documentation is in active development — content may be incomplete

Image

View as Markdown

Overview

Images display visual content such as photos, illustrations, logos, or previews. They help users recognize content quickly while preserving a reliable experience when loading is delayed or a source fails.

Example
<Image source="https://..." description="..." width={1920} height={1280} />

Usage Guidelines

  • Write a clear descriptions: Use description to convey the image's meaning in an accessible way. Keep it concise and focused on the image's content or purpose.
  • Keep image dimensions stable: Provide width and height when possible, so the page layout remains stable as images load.
  • Use fallback intentionally: Use fallbackSource when a reliable backup image exists, and fallback for intentional replacement UI such as an empty state or placeholder.

API Reference

Image

PropTypeDefault
sourcestring-
fallbackSourcestring-
fallbackReactNode-
onStatusChange(status: "empty" | "loading" | "loaded" | "error") => void-
descriptionstring-
draggablebooleanfalse
onLoad(event: SyntheticEvent<HTMLImageElement>) => void-
onError(event: SyntheticEvent<HTMLImageElement>) => void-

Examples

Fallback

If an image fails to load, <Image /> can display a fallback source or even an entire fallback component in place of the browser's default broken image icon.

broken
broken
<Image source="..." fallback={<CustomComponent />} />

On this page

(Top)OverviewUsage GuidelinesAPI ReferenceImageExamplesFallback
v0.3.0

Overview

AboutGetting started

Components

AvatarBadgeBannerButtonCalloutCheckboxChipCodeCode InputColor InputData TableDialogDividerDisclosureDrawerEditable TextEmbedEmphasisError BoundaryFieldFile InputFlexFormFrameGridImageInlineInputMarqueeMenuPortalRootRadio GroupRich Text EditorSelectSkeletonSlotSortableSpacerSpinnerStackStatus IconStepperSwitchTab SwitchTextText AreaToggleUrlIcon