Choose a version:

MediaFile
component

The MediaFile component renders the media for the Storefront API's Media object. It renders an Image, Video, an ExternalVideo, or a ModelViewer depending on the __typename of the data prop.

Anchor to propsProps

MediaFile renders an Image, Video, ExternalVideo, or ModelViewer component. Use the mediaOptions prop to customize the props sent to each of these components.

Anchor to data data PartialDeep<MediaEdgeType['node'], {recurseIntoArrays: true}> required: An object with fields that correspond to the Storefront API's Media object.
Anchor to about about string | undefined
Anchor to accessKey accessKey string | undefined
Anchor to aria-activedescendant aria-activedescendant string | undefined: Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Anchor to aria-atomic aria-atomic Booleanish | undefined: Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Anchor to aria-autocomplete aria-autocomplete 'none' | 'inline' | 'list' | 'both' | undefined: Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
Anchor to aria-braillelabel aria-braillelabel string | undefined: Defines a string value that labels the current element, which is intended to be converted into Braille.
Anchor to aria-brailleroledescription aria-brailleroledescription string | undefined: Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Anchor to aria-busy aria-busy Booleanish | undefined
Anchor to aria-checked aria-checked boolean | 'false' | 'mixed' | 'true' | undefined: Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Anchor to aria-colcount aria-colcount number | undefined: Defines the total number of columns in a table, grid, or treegrid.
Anchor to aria-colindex aria-colindex number | undefined: Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Anchor to aria-colindextext aria-colindextext string | undefined: Defines a human readable text alternative of aria-colindex.
Anchor to aria-colspan aria-colspan number | undefined: Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Anchor to aria-controls aria-controls string | undefined: Identifies the element (or elements) whose contents or presence are controlled by the current element.
Anchor to aria-current aria-current boolean | 'false' | 'true' | 'page' | 'step' | 'location' | 'date' | 'time' | undefined: Indicates the element that represents the current item within a container or set of related elements.
Anchor to aria-describedby aria-describedby string | undefined: Identifies the element (or elements) that describes the object.
Anchor to aria-description aria-description string | undefined: Defines a string value that describes or annotates the current element.
Anchor to aria-details aria-details string | undefined: Identifies the element that provides a detailed, extended description for the object.
Anchor to aria-disabled aria-disabled Booleanish | undefined: Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Anchor to aria-errormessage aria-errormessage string | undefined: Identifies the element that provides an error message for the object.
Anchor to aria-expanded aria-expanded Booleanish | undefined: Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Anchor to aria-flowto aria-flowto string | undefined: Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
Anchor to aria-haspopup aria-haspopup boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog' | undefined: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Anchor to aria-hidden aria-hidden Booleanish | undefined: Indicates whether the element is exposed to an accessibility API.
Anchor to aria-invalid aria-invalid boolean | 'false' | 'true' | 'grammar' | 'spelling' | undefined: Indicates the entered value does not conform to the format expected by the application.
Anchor to aria-keyshortcuts aria-keyshortcuts string | undefined: Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Anchor to aria-label aria-label string | undefined: Defines a string value that labels the current element.
Anchor to aria-labelledby aria-labelledby string | undefined: Identifies the element (or elements) that labels the current element.
Anchor to aria-level aria-level number | undefined: Defines the hierarchical level of an element within a structure.
Anchor to aria-live aria-live 'off' | 'assertive' | 'polite' | undefined: Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Anchor to aria-modal aria-modal Booleanish | undefined: Indicates whether an element is modal when displayed.
Anchor to aria-multiline aria-multiline Booleanish | undefined: Indicates whether a text box accepts multiple lines of input or only a single line.
Anchor to aria-multiselectable aria-multiselectable Booleanish | undefined: Indicates that the user may select more than one item from the current selectable descendants.
Anchor to aria-orientation aria-orientation 'horizontal' | 'vertical' | undefined: Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Anchor to aria-owns aria-owns string | undefined: Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
Anchor to aria-placeholder aria-placeholder string | undefined: Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
Anchor to aria-posinset aria-posinset number | undefined: Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Anchor to aria-pressed aria-pressed boolean | 'false' | 'mixed' | 'true' | undefined: Indicates the current "pressed" state of toggle buttons.
Anchor to aria-readonly aria-readonly Booleanish | undefined: Indicates that the element is not editable, but is otherwise operable.
Anchor to aria-relevant aria-relevant 'additions' | 'additions removals' | 'additions text' | 'all' | 'removals' | 'removals additions' | 'removals text' | 'text' | 'text additions' | 'text removals' | undefined: Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Anchor to aria-required aria-required Booleanish | undefined: Indicates that user input is required on the element before a form may be submitted.
Anchor to aria-roledescription aria-roledescription string | undefined: Defines a human-readable, author-localized description for the role of an element.
Anchor to aria-rowcount aria-rowcount number | undefined: Defines the total number of rows in a table, grid, or treegrid.
Anchor to aria-rowindex aria-rowindex number | undefined: Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Anchor to aria-rowindextext aria-rowindextext string | undefined: Defines a human readable text alternative of aria-rowindex.
Anchor to aria-rowspan aria-rowspan number | undefined: Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Anchor to aria-selected aria-selected Booleanish | undefined: Indicates the current "selected" state of various widgets.
Anchor to aria-setsize aria-setsize number | undefined: Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Anchor to aria-sort aria-sort 'none' | 'ascending' | 'descending' | 'other' | undefined: Indicates if items in a table or grid are sorted in ascending or descending order.
Anchor to aria-valuemax aria-valuemax number | undefined: Defines the maximum allowed value for a range widget.
Anchor to aria-valuemin aria-valuemin number | undefined: Defines the minimum allowed value for a range widget.
Anchor to aria-valuenow aria-valuenow number | undefined: Defines the current value for a range widget.
Anchor to aria-valuetext aria-valuetext string | undefined: Defines the human readable text alternative of aria-valuenow for a range widget.
Anchor to autoCapitalize autoCapitalize string | undefined
Anchor to autoCorrect autoCorrect string | undefined
Anchor to autoFocus autoFocus boolean | undefined
Anchor to autoSave autoSave string | undefined
Anchor to children children ReactNode | undefined
Anchor to className className string | undefined
Anchor to color color string | undefined
Anchor to content content string | undefined
Anchor to contentEditable contentEditable Booleanish | "inherit" | undefined
Anchor to contextMenu contextMenu string | undefined
Anchor to dangerouslySetInnerHTML dangerouslySetInnerHTML { // Should be InnerHTML['innerHTML']. // But unfortunately we're mixing renderer-specific type declarations. __html: string | TrustedHTML; } | undefined
Anchor to datatype datatype string | undefined
Anchor to defaultChecked defaultChecked boolean | undefined
Anchor to defaultValue defaultValue string | number | ReadonlyArray<string> | undefined
Anchor to dir dir string | undefined
Anchor to draggable draggable Booleanish | undefined
Anchor to hidden hidden boolean | undefined
Anchor to id id string | undefined
Anchor to inlist inlist any
Anchor to inputMode inputMode 'none' | 'text' | 'tel' | 'url' | 'email' | 'numeric' | 'decimal' | 'search' | undefined: Hints at the type of data that might be entered by the user while editing the element or its contents
Anchor to is is string | undefined: Specify that a standard HTML element should behave like a defined custom built-in element
Anchor to itemID itemID string | undefined
Anchor to itemProp itemProp string | undefined
Anchor to itemRef itemRef string | undefined
Anchor to itemScope itemScope boolean | undefined
Anchor to itemType itemType string | undefined
Anchor to lang lang string | undefined
Anchor to mediaOptions mediaOptions: The options for the Image, Video, ExternalVideo, or ModelViewer components.
Anchor to nonce nonce string | undefined
Anchor to onAbort onAbort ReactEventHandler<T> | undefined
Anchor to onAbortCapture onAbortCapture ReactEventHandler<T> | undefined
Anchor to onAnimationEnd onAnimationEnd AnimationEventHandler<T> | undefined
Anchor to onAnimationEndCapture onAnimationEndCapture AnimationEventHandler<T> | undefined
Anchor to onAnimationIteration onAnimationIteration AnimationEventHandler<T> | undefined
Anchor to onAnimationIterationCapture onAnimationIterationCapture AnimationEventHandler<T> | undefined
Anchor to onAnimationStart onAnimationStart AnimationEventHandler<T> | undefined
Anchor to onAnimationStartCapture onAnimationStartCapture AnimationEventHandler<T> | undefined
Anchor to onAuxClick onAuxClick MouseEventHandler<T> | undefined
Anchor to onAuxClickCapture onAuxClickCapture MouseEventHandler<T> | undefined
Anchor to onBeforeInput onBeforeInput FormEventHandler<T> | undefined
Anchor to onBeforeInputCapture onBeforeInputCapture FormEventHandler<T> | undefined
Anchor to onBlur onBlur FocusEventHandler<T> | undefined
Anchor to onBlurCapture onBlurCapture FocusEventHandler<T> | undefined
Anchor to onCanPlay onCanPlay ReactEventHandler<T> | undefined
Anchor to onCanPlayCapture onCanPlayCapture ReactEventHandler<T> | undefined
Anchor to onCanPlayThrough onCanPlayThrough ReactEventHandler<T> | undefined
Anchor to onCanPlayThroughCapture onCanPlayThroughCapture ReactEventHandler<T> | undefined
Anchor to onChange onChange FormEventHandler<T> | undefined
Anchor to onChangeCapture onChangeCapture FormEventHandler<T> | undefined
Anchor to onClick onClick MouseEventHandler<T> | undefined
Anchor to onClickCapture onClickCapture MouseEventHandler<T> | undefined
Anchor to onCompositionEnd onCompositionEnd CompositionEventHandler<T> | undefined
Anchor to onCompositionEndCapture onCompositionEndCapture CompositionEventHandler<T> | undefined
Anchor to onCompositionStart onCompositionStart CompositionEventHandler<T> | undefined
Anchor to onCompositionStartCapture onCompositionStartCapture CompositionEventHandler<T> | undefined
Anchor to onCompositionUpdate onCompositionUpdate CompositionEventHandler<T> | undefined
Anchor to onCompositionUpdateCapture onCompositionUpdateCapture CompositionEventHandler<T> | undefined
Anchor to onContextMenu onContextMenu MouseEventHandler<T> | undefined
Anchor to onContextMenuCapture onContextMenuCapture MouseEventHandler<T> | undefined
Anchor to onCopy onCopy ClipboardEventHandler<T> | undefined
Anchor to onCopyCapture onCopyCapture ClipboardEventHandler<T> | undefined
Anchor to onCut onCut ClipboardEventHandler<T> | undefined
Anchor to onCutCapture onCutCapture ClipboardEventHandler<T> | undefined
Anchor to onDoubleClick onDoubleClick MouseEventHandler<T> | undefined
Anchor to onDoubleClickCapture onDoubleClickCapture MouseEventHandler<T> | undefined
Anchor to onDrag onDrag DragEventHandler<T> | undefined
Anchor to onDragCapture onDragCapture DragEventHandler<T> | undefined
Anchor to onDragEnd onDragEnd DragEventHandler<T> | undefined
Anchor to onDragEndCapture onDragEndCapture DragEventHandler<T> | undefined
Anchor to onDragEnter onDragEnter DragEventHandler<T> | undefined
Anchor to onDragEnterCapture onDragEnterCapture DragEventHandler<T> | undefined
Anchor to onDragExit onDragExit DragEventHandler<T> | undefined
Anchor to onDragExitCapture onDragExitCapture DragEventHandler<T> | undefined
Anchor to onDragLeave onDragLeave DragEventHandler<T> | undefined
Anchor to onDragLeaveCapture onDragLeaveCapture DragEventHandler<T> | undefined
Anchor to onDragOver onDragOver DragEventHandler<T> | undefined
Anchor to onDragOverCapture onDragOverCapture DragEventHandler<T> | undefined
Anchor to onDragStart onDragStart DragEventHandler<T> | undefined
Anchor to onDragStartCapture onDragStartCapture DragEventHandler<T> | undefined
Anchor to onDrop onDrop DragEventHandler<T> | undefined
Anchor to onDropCapture onDropCapture DragEventHandler<T> | undefined
Anchor to onDurationChange onDurationChange ReactEventHandler<T> | undefined
Anchor to onDurationChangeCapture onDurationChangeCapture ReactEventHandler<T> | undefined
Anchor to onEmptied onEmptied ReactEventHandler<T> | undefined
Anchor to onEmptiedCapture onEmptiedCapture ReactEventHandler<T> | undefined
Anchor to onEncrypted onEncrypted ReactEventHandler<T> | undefined
Anchor to onEncryptedCapture onEncryptedCapture ReactEventHandler<T> | undefined
Anchor to onEnded onEnded ReactEventHandler<T> | undefined
Anchor to onEndedCapture onEndedCapture ReactEventHandler<T> | undefined
Anchor to onError onError ReactEventHandler<T> | undefined
Anchor to onErrorCapture onErrorCapture ReactEventHandler<T> | undefined
Anchor to onFocus onFocus FocusEventHandler<T> | undefined
Anchor to onFocusCapture onFocusCapture FocusEventHandler<T> | undefined
Anchor to onGotPointerCapture onGotPointerCapture PointerEventHandler<T> | undefined
Anchor to onGotPointerCaptureCapture onGotPointerCaptureCapture PointerEventHandler<T> | undefined
Anchor to onInput onInput FormEventHandler<T> | undefined
Anchor to onInputCapture onInputCapture FormEventHandler<T> | undefined
Anchor to onInvalid onInvalid FormEventHandler<T> | undefined
Anchor to onInvalidCapture onInvalidCapture FormEventHandler<T> | undefined
Anchor to onKeyDown onKeyDown KeyboardEventHandler<T> | undefined
Anchor to onKeyDownCapture onKeyDownCapture KeyboardEventHandler<T> | undefined
Anchor to onKeyUp onKeyUp KeyboardEventHandler<T> | undefined
Anchor to onKeyUpCapture onKeyUpCapture KeyboardEventHandler<T> | undefined
Anchor to onLoad onLoad ReactEventHandler<T> | undefined
Anchor to onLoadCapture onLoadCapture ReactEventHandler<T> | undefined
Anchor to onLoadedData onLoadedData ReactEventHandler<T> | undefined
Anchor to onLoadedDataCapture onLoadedDataCapture ReactEventHandler<T> | undefined
Anchor to onLoadedMetadata onLoadedMetadata ReactEventHandler<T> | undefined
Anchor to onLoadedMetadataCapture onLoadedMetadataCapture ReactEventHandler<T> | undefined
Anchor to onLoadStart onLoadStart ReactEventHandler<T> | undefined
Anchor to onLoadStartCapture onLoadStartCapture ReactEventHandler<T> | undefined
Anchor to onLostPointerCapture onLostPointerCapture PointerEventHandler<T> | undefined
Anchor to onLostPointerCaptureCapture onLostPointerCaptureCapture PointerEventHandler<T> | undefined
Anchor to onMouseDown onMouseDown MouseEventHandler<T> | undefined
Anchor to onMouseDownCapture onMouseDownCapture MouseEventHandler<T> | undefined
Anchor to onMouseEnter onMouseEnter MouseEventHandler<T> | undefined
Anchor to onMouseLeave onMouseLeave MouseEventHandler<T> | undefined
Anchor to onMouseMove onMouseMove MouseEventHandler<T> | undefined
Anchor to onMouseMoveCapture onMouseMoveCapture MouseEventHandler<T> | undefined
Anchor to onMouseOut onMouseOut MouseEventHandler<T> | undefined
Anchor to onMouseOutCapture onMouseOutCapture MouseEventHandler<T> | undefined
Anchor to onMouseOver onMouseOver MouseEventHandler<T> | undefined
Anchor to onMouseOverCapture onMouseOverCapture MouseEventHandler<T> | undefined
Anchor to onMouseUp onMouseUp MouseEventHandler<T> | undefined
Anchor to onMouseUpCapture onMouseUpCapture MouseEventHandler<T> | undefined
Anchor to onPaste onPaste ClipboardEventHandler<T> | undefined
Anchor to onPasteCapture onPasteCapture ClipboardEventHandler<T> | undefined
Anchor to onPause onPause ReactEventHandler<T> | undefined
Anchor to onPauseCapture onPauseCapture ReactEventHandler<T> | undefined
Anchor to onPlay onPlay ReactEventHandler<T> | undefined
Anchor to onPlayCapture onPlayCapture ReactEventHandler<T> | undefined
Anchor to onPlaying onPlaying ReactEventHandler<T> | undefined
Anchor to onPlayingCapture onPlayingCapture ReactEventHandler<T> | undefined
Anchor to onPointerCancel onPointerCancel PointerEventHandler<T> | undefined
Anchor to onPointerCancelCapture onPointerCancelCapture PointerEventHandler<T> | undefined
Anchor to onPointerDown onPointerDown PointerEventHandler<T> | undefined
Anchor to onPointerDownCapture onPointerDownCapture PointerEventHandler<T> | undefined
Anchor to onPointerEnter onPointerEnter PointerEventHandler<T> | undefined
Anchor to onPointerEnterCapture onPointerEnterCapture PointerEventHandler<T> | undefined
Anchor to onPointerLeave onPointerLeave PointerEventHandler<T> | undefined
Anchor to onPointerLeaveCapture onPointerLeaveCapture PointerEventHandler<T> | undefined
Anchor to onPointerMove onPointerMove PointerEventHandler<T> | undefined
Anchor to onPointerMoveCapture onPointerMoveCapture PointerEventHandler<T> | undefined
Anchor to onPointerOut onPointerOut PointerEventHandler<T> | undefined
Anchor to onPointerOutCapture onPointerOutCapture PointerEventHandler<T> | undefined
Anchor to onPointerOver onPointerOver PointerEventHandler<T> | undefined
Anchor to onPointerOverCapture onPointerOverCapture PointerEventHandler<T> | undefined
Anchor to onPointerUp onPointerUp PointerEventHandler<T> | undefined
Anchor to onPointerUpCapture onPointerUpCapture PointerEventHandler<T> | undefined
Anchor to onProgress onProgress ReactEventHandler<T> | undefined
Anchor to onProgressCapture onProgressCapture ReactEventHandler<T> | undefined
Anchor to onRateChange onRateChange ReactEventHandler<T> | undefined
Anchor to onRateChangeCapture onRateChangeCapture ReactEventHandler<T> | undefined
Anchor to onReset onReset FormEventHandler<T> | undefined
Anchor to onResetCapture onResetCapture FormEventHandler<T> | undefined
Anchor to onResize onResize ReactEventHandler<T> | undefined
Anchor to onResizeCapture onResizeCapture ReactEventHandler<T> | undefined
Anchor to onScroll onScroll UIEventHandler<T> | undefined
Anchor to onScrollCapture onScrollCapture UIEventHandler<T> | undefined
Anchor to onSeeked onSeeked ReactEventHandler<T> | undefined
Anchor to onSeekedCapture onSeekedCapture ReactEventHandler<T> | undefined
Anchor to onSeeking onSeeking ReactEventHandler<T> | undefined
Anchor to onSeekingCapture onSeekingCapture ReactEventHandler<T> | undefined
Anchor to onSelect onSelect ReactEventHandler<T> | undefined
Anchor to onSelectCapture onSelectCapture ReactEventHandler<T> | undefined
Anchor to onStalled onStalled ReactEventHandler<T> | undefined
Anchor to onStalledCapture onStalledCapture ReactEventHandler<T> | undefined
Anchor to onSubmit onSubmit FormEventHandler<T> | undefined
Anchor to onSubmitCapture onSubmitCapture FormEventHandler<T> | undefined
Anchor to onSuspend onSuspend ReactEventHandler<T> | undefined
Anchor to onSuspendCapture onSuspendCapture ReactEventHandler<T> | undefined
Anchor to onTimeUpdate onTimeUpdate ReactEventHandler<T> | undefined
Anchor to onTimeUpdateCapture onTimeUpdateCapture ReactEventHandler<T> | undefined
Anchor to onTouchCancel onTouchCancel TouchEventHandler<T> | undefined
Anchor to onTouchCancelCapture onTouchCancelCapture TouchEventHandler<T> | undefined
Anchor to onTouchEnd onTouchEnd TouchEventHandler<T> | undefined
Anchor to onTouchEndCapture onTouchEndCapture TouchEventHandler<T> | undefined
Anchor to onTouchMove onTouchMove TouchEventHandler<T> | undefined
Anchor to onTouchMoveCapture onTouchMoveCapture TouchEventHandler<T> | undefined
Anchor to onTouchStart onTouchStart TouchEventHandler<T> | undefined
Anchor to onTouchStartCapture onTouchStartCapture TouchEventHandler<T> | undefined
Anchor to onTransitionEnd onTransitionEnd TransitionEventHandler<T> | undefined
Anchor to onTransitionEndCapture onTransitionEndCapture TransitionEventHandler<T> | undefined
Anchor to onVolumeChange onVolumeChange ReactEventHandler<T> | undefined
Anchor to onVolumeChangeCapture onVolumeChangeCapture ReactEventHandler<T> | undefined
Anchor to onWaiting onWaiting ReactEventHandler<T> | undefined
Anchor to onWaitingCapture onWaitingCapture ReactEventHandler<T> | undefined
Anchor to onWheel onWheel WheelEventHandler<T> | undefined
Anchor to onWheelCapture onWheelCapture WheelEventHandler<T> | undefined
Anchor to placeholder placeholder string | undefined
Anchor to prefix prefix string | undefined
Anchor to property property string | undefined
Anchor to radioGroup radioGroup string | undefined
Anchor to rel rel string | undefined
Anchor to resource resource string | undefined
Anchor to results results number | undefined
Anchor to rev rev string | undefined
Anchor to role role AriaRole | undefined
Anchor to security security string | undefined
Anchor to slot slot string | undefined
Anchor to spellCheck spellCheck Booleanish | undefined
Anchor to style style CSSProperties | undefined
Anchor to suppressContentEditableWarning suppressContentEditableWarning boolean | undefined
Anchor to suppressHydrationWarning suppressHydrationWarning boolean | undefined
Anchor to tabIndex tabIndex number | undefined
Anchor to title title string | undefined
Anchor to translate translate 'yes' | 'no' | undefined
Anchor to typeof typeof string | undefined
Anchor to unselectable unselectable 'on' | 'off' | undefined
Anchor to vocab vocab string | undefined
Anchor to aria-dropeffect aria-dropeffect 'none' | 'copy' | 'execute' | 'link' | 'move' | 'popup' | undefined: Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated
in ARIA 1.1
Anchor to aria-grabbed aria-grabbed Booleanish | undefined: Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated
in ARIA 1.1
Anchor to onKeyPress onKeyPress KeyboardEventHandler<T> | undefined: Deprecated
Deprecated
Anchor to onKeyPressCapture onKeyPressCapture KeyboardEventHandler<T> | undefined: Deprecated
Deprecated

MediaOptions

externalVideo

Props that will only apply when an `<ExternalVideo />` is rendered

Omit<
    React.ComponentProps<typeof ExternalVideo>['options'],
    'data'
  >

image
Props that will only apply when an `<Image />` is rendered
```
Omit<HydrogenImageProps, 'data'>
```
modelViewer
Props that will only apply when a `<ModelViewer />` is rendered
```
Omit<typeof ModelViewer, 'data'>
```
video
Props that will only apply when a `<Video />` is rendered
```
Omit<React.ComponentProps<typeof Video>, 'data'>
```

{
  /** Props that will only apply when an `<Image />` is rendered */
  image?: Omit<HydrogenImageProps, 'data'>;
  /** Props that will only apply when a `<Video />` is rendered */
  video?: Omit<React.ComponentProps<typeof Video>, 'data'>;
  /** Props that will only apply when an `<ExternalVideo />` is rendered */
  externalVideo?: Omit<
    React.ComponentProps<typeof ExternalVideo>['options'],
    'data'
  >;
  /** Props that will only apply when a `<ModelViewer />` is rendered */
  modelViewer?: Omit<typeof ModelViewer, 'data'>;
}

HydrogenImageProps

React.ComponentPropsWithRef<'img'> & HydrogenImageBaseProps

HydrogenImageBaseProps

aspectRatio
The aspect ratio of the image, in the format of `width/height`.
```
string
```
crop
The crop position of the image.
```
Crop
```
data
Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2025-04/objects/Image) object. Must be an Image object.
```
PartialDeep<ImageType, {recurseIntoArrays: true}>
```
loader
A function that returns a URL string for an image.
```
Loader
```
srcSetOptions
An optional prop you can use to change the default srcSet generation behaviour
```
SrcSetOptions
```

{
  /** The aspect ratio of the image, in the format of `width/height`.
   *
   * @example
   * ```
   * <Image data={productImage} aspectRatio="4/5" />
   * ```
   */
  aspectRatio?: string;
  /** The crop position of the image.
   *
   * @remarks
   * In the event that AspectRatio is set, without specifying a crop,
   * the Shopify CDN won't return the expected image.
   *
   * @defaultValue `center`
   */
  crop?: Crop;
  /** Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2025-04/objects/Image) object. Must be an Image object.
   *
   * @example
   * ```
   * import {IMAGE_FRAGMENT, Image} from '@shopify/hydrogen';
   *
   * export const IMAGE_QUERY = `#graphql
   * ${IMAGE_FRAGMENT}
   * query {
   *   product {
   *     featuredImage {
   *       ...Image
   *     }
   *   }
   * }`
   *
   * <Image
   *   data={productImage}
   *   sizes="(min-width: 45em) 50vw, 100vw"
   *   aspectRatio="4/5"
   * />
   * ```
   *
   * Image: {@link https://shopify.dev/api/storefront/reference/common-objects/image}
   */
  data?: PartialDeep<ImageType, {recurseIntoArrays: true}>;
  /** A function that returns a URL string for an image.
   *
   * @remarks
   * By default, this uses Shopify’s CDN {@link https://cdn.shopify.com/} but you can provide
   * your own function to use a another provider, as long as they support URL based image transformations.
   */
  loader?: Loader;
  /** An optional prop you can use to change the default srcSet generation behaviour */
  srcSetOptions?: SrcSetOptions;
}

Crop

'center' | 'top' | 'bottom' | 'left' | 'right'

Loader

params
```
LoaderParams
```

string

string

export type Loader = (params: LoaderParams) => string;

LoaderParams

crop
The URL param that controls the cropping region
```
Crop
```
height
The URL param that controls height
```
number
```
src
The base URL of the image
```
string
```
width
The URL param that controls width
```
number
```

{
  /** The base URL of the image */
  src?: ImageType['url'];
  /** The URL param that controls width */
  width?: number;
  /** The URL param that controls height */
  height?: number;
  /** The URL param that controls the cropping region */
  crop?: Crop;
}

SrcSetOptions

incrementSize
The increment by which to increase for each size, in pixels
```
number
```
intervals
The number of sizes to generate
```
number
```
placeholderWidth
The size used for placeholder fallback images
```
number
```
startingWidth
The smallest image size
```
number
```

{
  /** The number of sizes to generate */
  intervals: number;
  /** The smallest image size */
  startingWidth: number;
  /** The increment by which to increase for each size, in pixels */
  incrementSize: number;
  /** The size used for placeholder fallback images */
  placeholderWidth: number;
}

Was this section helpful?

Example code

import {MediaFile} from '@shopify/hydrogen';

export function ProductsMediaFiles({products}) {

return (

<ul>

{products.nodes.map((product) => {

return <MediaFile data={product.media.nodes[0]} key={product.id} />;

})}

</ul>

);

}

Examples

Example code

Description

I am the default example

JavaScript

import {MediaFile} from '@shopify/hydrogen';

export function ProductsMediaFiles({products}) {
  return (
    <ul>
      {products.nodes.map((product) => {
        return <MediaFile data={product.media.nodes[0]} key={product.id} />;
      })}
    </ul>
  );
}

TypeScript

import {MediaFile} from '@shopify/hydrogen';
import type {ProductConnection} from '@shopify/hydrogen/storefront-api-types';

export function ProductsMediaFiles({products}: {products: ProductConnection}) {
  return (
    <ul>
      {products.nodes.map((product) => {
        return <MediaFile data={product.media.nodes[0]} key={product.id} />;
      })}
    </ul>
  );
}