Skip to main content

Image

Ant Design

The Image component shows a picture from a URL, such as a product photo or a scanned document, and can enlarge it when clicked.

Properties​

Property
Description
Expected Value
SrcURL of the image. When it is empty, a placeholder shows.Text. Default: https://picsum.photos/seed/tj-image/800/450
AltAlternative text for the image, read by screen readers.Text
PreviewOpens the image enlarged, with zoom and rotate controls, when the user clicks it.On or off. Default: On
FallbackURL of an image to show when Src fails to load.Text
Object fitHow the image fills its box. cover fills it and crops the edges, contain shows the whole image with space around it, and fill stretches it to the box.cover, contain, fill. Default: cover

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On clickTriggers when the user clicks the image.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.image1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.image1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.image1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
srcURL of the image. When it is empty, a placeholder shows.{{components.image1.src}}
altAlternative text for the image, read by screen readers.{{components.image1.alt}}
previewOpens the image enlarged, with zoom and rotate controls, when the user clicks it.{{components.image1.preview}}
fallbackURL of an image to show when Src fails to load.{{components.image1.fallback}}
objectFitHow the image fills its box. cover fills it and crops the edges, contain shows the whole image with space around it, and fill stretches it to the box.{{components.image1.objectFit}}
isVisibleWhether the component is visible.{{components.image1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.image1.isLoading}}
isDisabledWhether the component is disabled.{{components.image1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.