Skip to main content

<Image />

An Image is essentially syntactic sugar for a Rectangle with an image fill. Instead of the fill prop, it has a src prop, that can be either a URL string or an ImagePaint. If a URL string is passed that will be used to create an ImagePaint.

Usage Example

Usage example
// Pass a data uri directly as the image


src: string | ImagePaint

A string representing Image URL/DataURI or an ImagePaint.

SizeProps (Required)

width: Size

The width of the component. This is required.

height: Size

The height of the component. This is required.

rotation?: number

The rotation of the node in degrees. Expects values from -180 to 180.

The rotation is with respect to the top-left of the object. Therefore, it is independent from the position of the object.


cornerRadius?: CornerRadius

The number of pixels to round the corners of the object by.

This value must be non-negative and can be fractional. If an edge length is less than twice the corner radius, the corner radius for each vertex of the edge will be clamped to half the edge length.


Rectangle nodes can also have different corner radii on each of the four corners.


fill?: HexCode | Color | Paint | (SolidPaint | GradientPaint)[]

The paints used to fill the area of the node

stroke?: HexCode | Color | SolidPaint | GradientPaint | (SolidPaint | GradientPaint)[]

The paints used to fill the area of the node's stroke.

strokeWidth?: number

The thickness of the stroke, in pixels. This value must be non-negative and can be fractional.

strokeAlign?: StrokeAlign

The alignment of the stroke with respect to the boundaries of the node.

Center-aligned stroke means the center of the stroke falls exactly on the geometry. Inside-aligned stroke shifts the stroke so it lies completely inside the shape, and outside-aligned stroke is vice versa.


Inside and outside stroke are actually implemented by doubling the stroke weight and masking the stroke by the fill. This means inside-aligned stroke will never draw strokes outside the fill and outside-aligned stroke will never draw strokes inside the fill.

strokeDashPattern?: number[]

The alternating stroke dash and gap lengths, in pixels. An empty array gives a solid stroke and a single value will be applied to both the dash and gap length.


name?: string

The name of the component. This is useful to specify a data-layer attribute to make things more debuggable when you inspect the sublayers of your widget.

hidden?: boolean

Toggles whether to show the component.

onClick?: (event: WidgetClickEvent) => Promise<any> | void

Attach a click handler on the given node. If the given function is async or returns a promise, the widget is only terminated when the async function has completed and the promise has been resolved. The click handler is also passed a WidgetClickEvent object that contains additional information about the click.

See also: Handling User Events.

key?: string | number

The key of the component.

hoverStyle?: HoverStyle

The style to be applied when the mouse is hovering over the component.

tooltip?: string

The tooltip that is shown to the user when hovering over the component.

positioning?: 'auto' | 'absolute'

This value is ignored unless the node is a direct child of an AutoLayout frame.

'auto'Layout this node according to auto-layout rules.
'absolute'Take this node out of the auto-layout flow, while still nesting it inside the auto-layout frame. This allows explicitly setting x, y, width, and height.


blendMode?: BlendMode

The blendMode of the component.

opacity?: number

The opacity of the component.

effect?: Effect | Effect[]

The effect of the component.


x?: number | HorizontalConstraint

The x position of the node.

This value is ignored if the node is a child of an AutoLayout frame and has positioning set to 'auto'.

y?: number | VerticalConstraint

The y position of the node.

This value is ignored if the node is a child of an AutoLayout frame and has positioning set to 'auto'.

Default Props