Props

a11yTitle

Custom label to be used by screen readers. When provided, an aria-label will be added to the element.

string
"a user friendly label for screen readers"

alignSelf

How to align along the cross axis when contained in a Box or along the column axis when contained in a Grid.

string
"start"
"center"
"end"
"stretch"

fallback

Specifies the URL of the fallback image used when src is failing to load

string
"https://image-url"

fill

Whether the width and/or height should fill the container.

string
"horizontal"
"vertical"
boolean
true
false

fit

How the image fills its container.

string
"cover"
"contain"

gridArea

The name of the area to place this inside a parent Grid.

string
"a parent grid area name"

margin

The amount of margin around the component.

string
"none"
"xxsmall"
"xsmall"
"small"
"medium"
"large"
"xlarge"
object

Can be specified to distinguish horizontal margin, vertical margin, and margin on a particular side.


{
    vertical: "...",
    horizontal: "...",
    top: "...",
    bottom: "...",
    left: "...",
    right: "..."
}
        

opacity

Transparency of the image.

boolean
true
false
string
"weak"
"medium"
"strong"
"string"

React/DOM Properties

At its core, the Image component is a regular <img> element. Thus, both DOM and React properties, methods, and events are accessible. To read up on all of the possible DOM attributes and types available for img elements, check out this MDN Web Documents page. To learn more about DOM events and methods, you can read more on the MDN Web Events documentation page.

Also, feel free to read about the types of React events available, or see how DOM attributes change in React. Working in tandem with Styled Components, you also have access to the as property.

Theme

global.opacity.medium

The value used when opacity is set to true.

number
0.4

image.extend

Any additional style for the Image.

string

Any CSS.

css`color: 'blue'`
function
(props) => {}