Use this when you want to display an image.
import {render, Image} from '@shopify/ui-extensions-react/admin';
render('Playground', () => <App />);
function App() {
return (
<Image alt="Pickaxe" source="https://shopify.dev/assets/icons/64/pickaxe-1.png" />
);
}
import {extend, Image} from '@shopify/ui-extensions/admin';
extend('Playground', (root) => {
const image = root.createComponent(Image, {
alt: 'Pickaxe',
source: 'https://shopify.dev/assets/icons/64/pickaxe-1.png',
});
root.appendChild(image);
});
(ImageAccessibilityLabelProp | ImageAltProp) & (ImageSourceProp | ImageSrcProp) & ImageBaseProps
An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written `description` provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `Image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `description` is displayed on screen instead. This has the benefit of letting a sighted user know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://ux.shopify.com/considerations-when-writing-alt-text-a9c1985a8204) to learn more. An `alt` property is available as an alias for this for compatibility with the HTML specification. When both are specified, `accessibilityLabel` takes precedence.
An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written `description` provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `Image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `description` is displayed on screen instead. This has the benefit of letting a sighted user know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://ux.shopify.com/considerations-when-writing-alt-text-a9c1985a8204) to learn more. This property is an alias for `accessibilityLabel` for compatibility with the HTML specification. When both are specified `accessibilityLabel` takes precedence.
The image source (either a remote URL or a local file resource; blob URLs are not currently supported). A `src` property is available as an alias for this for compatibility with the HTML specification. When both are specified, `source` takes precedence.
The image source (either a remote URL or a local file resource; blob URLs are not currently supported). This property is available as an alias for `source` for compatibility with the HTML specification. When both are specified, `source` takes precedence.
Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.
Defines a unique identifier which must be unique in the whole document.
Determines the loading behavior of the image: - `eager`: Immediately loads the image, irrespective of its position within the visible viewport. - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
Invoked when load completes successfully.
Invoked on load error.
'main' | 'header' | 'footer' | 'section' | 'aside' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'status' | 'alert' | 'generic'