# MediaFile
The `MediaFile` component renders the media for the Storefront API's
[Media object](https://shopify.dev/api/storefront/reference/products/media). It renders an `Image`, `Video`, an `ExternalVideo`, or a `ModelViewer` depending on the `__typename` of the `data` prop.
```jsx
import {MediaFile} from '@shopify/hydrogen';
export function ProductsMediaFiles({products}) {
return (
{products.nodes.map((product) => {
return ;
})}
);
}
```
```tsx
import {MediaFile} from '@shopify/hydrogen';
import type {ProductConnection} from '@shopify/hydrogen/storefront-api-types';
export function ProductsMediaFiles({products}: {products: ProductConnection}) {
return (
{products.nodes.map((product) => {
return ;
})}
);
}
```
## Props
MediaFile renders an `Image`, `Video`, `ExternalVideo`, or `ModelViewer` component. Use the `mediaOptions` prop to customize the props sent to each of these components.
### MediaFileProps
### data
value: `PartialObjectDeep | PartialObjectDeep | PartialObjectDeep | PartialObjectDeep`
An object with fields that correspond to the Storefront API's [Media object](https://shopify.dev/api/storefront/reference/products/media).
### mediaOptions
value: `MediaOptions`
- MediaOptions: {
/** Props that will only apply when an `` is rendered */
image?: Omit;
/** Props that will only apply when a `` is rendered */
video?: Omit, 'data'>;
/** Props that will only apply when an `` is rendered */
externalVideo?: Omit<
React.ComponentProps['options'],
'data'
>;
/** Props that will only apply when a `` is rendered */
modelViewer?: Omit;
}
The options for the `Image`, `Video`, `ExternalVideo`, or `ModelViewer` components.
### defaultChecked
value: `boolean`
### defaultValue
value: `string | number | readonly string[]`
### suppressContentEditableWarning
value: `boolean`
### suppressHydrationWarning
value: `boolean`
### accessKey
value: `string`
### className
value: `string`
### contentEditable
value: `Booleanish | "inherit"`
### contextMenu
value: `string`
### dir
value: `string`
### draggable
value: `Booleanish`
### hidden
value: `boolean`
### id
value: `string`
### lang
value: `string`
### nonce
value: `string`
### placeholder
value: `string`
### slot
value: `string`
### spellCheck
value: `Booleanish`
### style
value: `CSSProperties`
### tabIndex
value: `number`
### title
value: `string`
### translate
value: `"yes" | "no"`
### radioGroup
value: `string`
### role
value: `AriaRole`
### about
value: `string`
### datatype
value: `string`
### inlist
value: `any`
### prefix
value: `string`
### property
value: `string`
### resource
value: `string`
### typeof
value: `string`
### vocab
value: `string`
### autoCapitalize
value: `string`
### autoCorrect
value: `string`
### autoSave
value: `string`
### color
value: `string`
### itemProp
value: `string`
### itemScope
value: `boolean`
### itemType
value: `string`
### itemID
value: `string`
### itemRef
value: `string`
### results
value: `number`
### security
value: `string`
### unselectable
value: `"on" | "off"`
### inputMode
value: `"text" | "url" | "none" | "search" | "tel" | "email" | "numeric" | "decimal"`
Hints at the type of data that might be entered by the user while editing the element or its contents
### is
value: `string`
Specify that a standard HTML element should behave like a defined custom built-in element
### aria-activedescendant
value: `string`
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
### aria-atomic
value: `Booleanish`
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.
### aria-autocomplete
value: `"list" | "none" | "inline" | "both"`
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.
### aria-busy
value: `Booleanish`
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
### aria-checked
value: `boolean | "true" | "false" | "mixed"`
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
### aria-colcount
value: `number`
Defines the total number of columns in a table, grid, or treegrid.
### aria-colindex
value: `number`
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
### aria-colspan
value: `number`
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
### aria-controls
value: `string`
Identifies the element (or elements) whose contents or presence are controlled by the current element.
### aria-current
value: `boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date"`
Indicates the element that represents the current item within a container or set of related elements.
### aria-describedby
value: `string`
Identifies the element (or elements) that describes the object.
### aria-details
value: `string`
Identifies the element that provides a detailed, extended description for the object.
### aria-disabled
value: `Booleanish`
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
### aria-dropeffect
value: `"link" | "none" | "copy" | "execute" | "move" | "popup"`
Indicates what functions can be performed when a dragged object is released on the drop target.
### aria-errormessage
value: `string`
Identifies the element that provides an error message for the object.
### aria-expanded
value: `Booleanish`
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
### aria-flowto
value: `string`
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.
### aria-grabbed
value: `Booleanish`
Indicates an element's "grabbed" state in a drag-and-drop operation.
### aria-haspopup
value: `boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"`
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
### aria-hidden
value: `Booleanish`
Indicates whether the element is exposed to an accessibility API.
### aria-invalid
value: `boolean | "true" | "false" | "grammar" | "spelling"`
Indicates the entered value does not conform to the format expected by the application.
### aria-keyshortcuts
value: `string`
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
### aria-label
value: `string`
Defines a string value that labels the current element.
### aria-labelledby
value: `string`
Identifies the element (or elements) that labels the current element.
### aria-level
value: `number`
Defines the hierarchical level of an element within a structure.
### aria-live
value: `"off" | "assertive" | "polite"`
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.
### aria-modal
value: `Booleanish`
Indicates whether an element is modal when displayed.
### aria-multiline
value: `Booleanish`
Indicates whether a text box accepts multiple lines of input or only a single line.
### aria-multiselectable
value: `Booleanish`
Indicates that the user may select more than one item from the current selectable descendants.
### aria-orientation
value: `"horizontal" | "vertical"`
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
### aria-owns
value: `string`
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.
### aria-placeholder
value: `string`
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.
### aria-posinset
value: `number`
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.
### aria-pressed
value: `boolean | "true" | "false" | "mixed"`
Indicates the current "pressed" state of toggle buttons.
### aria-readonly
value: `Booleanish`
Indicates that the element is not editable, but is otherwise operable.
### aria-relevant
value: `"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"`
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
### aria-required
value: `Booleanish`
Indicates that user input is required on the element before a form may be submitted.
### aria-roledescription
value: `string`
Defines a human-readable, author-localized description for the role of an element.
### aria-rowcount
value: `number`
Defines the total number of rows in a table, grid, or treegrid.
### aria-rowindex
value: `number`
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
### aria-rowspan
value: `number`
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
### aria-selected
value: `Booleanish`
Indicates the current "selected" state of various widgets.
### aria-setsize
value: `number`
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.
### aria-sort
value: `"none" | "ascending" | "descending" | "other"`
Indicates if items in a table or grid are sorted in ascending or descending order.
### aria-valuemax
value: `number`
Defines the maximum allowed value for a range widget.
### aria-valuemin
value: `number`
Defines the minimum allowed value for a range widget.
### aria-valuenow
value: `number`
Defines the current value for a range widget.
### aria-valuetext
value: `string`
Defines the human readable text alternative of aria-valuenow for a range widget.
### children
value: `ReactNode`
### dangerouslySetInnerHTML
value: `{ __html: string; }`
### onCopy
value: `ClipboardEventHandler`
### onCopyCapture
value: `ClipboardEventHandler`
### onCut
value: `ClipboardEventHandler`
### onCutCapture
value: `ClipboardEventHandler`
### onPaste
value: `ClipboardEventHandler`
### onPasteCapture
value: `ClipboardEventHandler`
### onCompositionEnd
value: `CompositionEventHandler`
### onCompositionEndCapture
value: `CompositionEventHandler`
### onCompositionStart
value: `CompositionEventHandler`
### onCompositionStartCapture
value: `CompositionEventHandler`
### onCompositionUpdate
value: `CompositionEventHandler`
### onCompositionUpdateCapture
value: `CompositionEventHandler`
### onFocus
value: `FocusEventHandler`
### onFocusCapture
value: `FocusEventHandler`
### onBlur
value: `FocusEventHandler`
### onBlurCapture
value: `FocusEventHandler`
### onChange
value: `FormEventHandler`
### onChangeCapture
value: `FormEventHandler`
### onBeforeInput
value: `FormEventHandler`
### onBeforeInputCapture
value: `FormEventHandler`
### onInput
value: `FormEventHandler`
### onInputCapture
value: `FormEventHandler`
### onReset
value: `FormEventHandler`
### onResetCapture
value: `FormEventHandler`
### onSubmit
value: `FormEventHandler`
### onSubmitCapture
value: `FormEventHandler`
### onInvalid
value: `FormEventHandler`
### onInvalidCapture
value: `FormEventHandler`
### onLoad
value: `ReactEventHandler`
### onLoadCapture
value: `ReactEventHandler`
### onError
value: `ReactEventHandler`
### onErrorCapture
value: `ReactEventHandler`
### onKeyDown
value: `KeyboardEventHandler`
### onKeyDownCapture
value: `KeyboardEventHandler`
### onKeyPress
value: `KeyboardEventHandler`
### onKeyPressCapture
value: `KeyboardEventHandler`
### onKeyUp
value: `KeyboardEventHandler`
### onKeyUpCapture
value: `KeyboardEventHandler`
### onAbort
value: `ReactEventHandler`
### onAbortCapture
value: `ReactEventHandler`
### onCanPlay
value: `ReactEventHandler`
### onCanPlayCapture
value: `ReactEventHandler`
### onCanPlayThrough
value: `ReactEventHandler`
### onCanPlayThroughCapture
value: `ReactEventHandler`
### onDurationChange
value: `ReactEventHandler`
### onDurationChangeCapture
value: `ReactEventHandler`
### onEmptied
value: `ReactEventHandler`
### onEmptiedCapture
value: `ReactEventHandler`
### onEncrypted
value: `ReactEventHandler`
### onEncryptedCapture
value: `ReactEventHandler`
### onEnded
value: `ReactEventHandler`
### onEndedCapture
value: `ReactEventHandler`
### onLoadedData
value: `ReactEventHandler`
### onLoadedDataCapture
value: `ReactEventHandler`
### onLoadedMetadata
value: `ReactEventHandler`
### onLoadedMetadataCapture
value: `ReactEventHandler`
### onLoadStart
value: `ReactEventHandler`
### onLoadStartCapture
value: `ReactEventHandler`
### onPause
value: `ReactEventHandler`
### onPauseCapture
value: `ReactEventHandler`
### onPlay
value: `ReactEventHandler`
### onPlayCapture
value: `ReactEventHandler`
### onPlaying
value: `ReactEventHandler`
### onPlayingCapture
value: `ReactEventHandler`
### onProgress
value: `ReactEventHandler`
### onProgressCapture
value: `ReactEventHandler`
### onRateChange
value: `ReactEventHandler`
### onRateChangeCapture
value: `ReactEventHandler`
### onResize
value: `ReactEventHandler`
### onResizeCapture
value: `ReactEventHandler`
### onSeeked
value: `ReactEventHandler`
### onSeekedCapture
value: `ReactEventHandler`
### onSeeking
value: `ReactEventHandler`
### onSeekingCapture
value: `ReactEventHandler`
### onStalled
value: `ReactEventHandler`
### onStalledCapture
value: `ReactEventHandler`
### onSuspend
value: `ReactEventHandler`
### onSuspendCapture
value: `ReactEventHandler`
### onTimeUpdate
value: `ReactEventHandler`
### onTimeUpdateCapture
value: `ReactEventHandler`
### onVolumeChange
value: `ReactEventHandler`
### onVolumeChangeCapture
value: `ReactEventHandler`
### onWaiting
value: `ReactEventHandler`
### onWaitingCapture
value: `ReactEventHandler`
### onAuxClick
value: `MouseEventHandler`
### onAuxClickCapture
value: `MouseEventHandler`
### onClick
value: `MouseEventHandler`
### onClickCapture
value: `MouseEventHandler`
### onContextMenu
value: `MouseEventHandler`
### onContextMenuCapture
value: `MouseEventHandler`
### onDoubleClick
value: `MouseEventHandler`
### onDoubleClickCapture
value: `MouseEventHandler`
### onDrag
value: `DragEventHandler`
### onDragCapture
value: `DragEventHandler`
### onDragEnd
value: `DragEventHandler`
### onDragEndCapture
value: `DragEventHandler`
### onDragEnter
value: `DragEventHandler`
### onDragEnterCapture
value: `DragEventHandler`
### onDragExit
value: `DragEventHandler`
### onDragExitCapture
value: `DragEventHandler`
### onDragLeave
value: `DragEventHandler`
### onDragLeaveCapture
value: `DragEventHandler`
### onDragOver
value: `DragEventHandler`
### onDragOverCapture
value: `DragEventHandler`
### onDragStart
value: `DragEventHandler`
### onDragStartCapture
value: `DragEventHandler`
### onDrop
value: `DragEventHandler`
### onDropCapture
value: `DragEventHandler`
### onMouseDown
value: `MouseEventHandler`
### onMouseDownCapture
value: `MouseEventHandler`
### onMouseEnter
value: `MouseEventHandler`
### onMouseLeave
value: `MouseEventHandler`
### onMouseMove
value: `MouseEventHandler`
### onMouseMoveCapture
value: `MouseEventHandler`
### onMouseOut
value: `MouseEventHandler`
### onMouseOutCapture
value: `MouseEventHandler`
### onMouseOver
value: `MouseEventHandler`
### onMouseOverCapture
value: `MouseEventHandler`
### onMouseUp
value: `MouseEventHandler`
### onMouseUpCapture
value: `MouseEventHandler`
### onSelect
value: `ReactEventHandler`
### onSelectCapture
value: `ReactEventHandler`
### onTouchCancel
value: `TouchEventHandler`
### onTouchCancelCapture
value: `TouchEventHandler`
### onTouchEnd
value: `TouchEventHandler`
### onTouchEndCapture
value: `TouchEventHandler`
### onTouchMove
value: `TouchEventHandler`
### onTouchMoveCapture
value: `TouchEventHandler`
### onTouchStart
value: `TouchEventHandler`
### onTouchStartCapture
value: `TouchEventHandler`
### onPointerDown
value: `PointerEventHandler`
### onPointerDownCapture
value: `PointerEventHandler`
### onPointerMove
value: `PointerEventHandler`
### onPointerMoveCapture
value: `PointerEventHandler`
### onPointerUp
value: `PointerEventHandler`
### onPointerUpCapture
value: `PointerEventHandler`
### onPointerCancel
value: `PointerEventHandler`
### onPointerCancelCapture
value: `PointerEventHandler`
### onPointerEnter
value: `PointerEventHandler`
### onPointerEnterCapture
value: `PointerEventHandler`
### onPointerLeave
value: `PointerEventHandler`
### onPointerLeaveCapture
value: `PointerEventHandler`
### onPointerOver
value: `PointerEventHandler`
### onPointerOverCapture
value: `PointerEventHandler`
### onPointerOut
value: `PointerEventHandler`
### onPointerOutCapture
value: `PointerEventHandler`
### onGotPointerCapture
value: `PointerEventHandler`
### onGotPointerCaptureCapture
value: `PointerEventHandler`
### onLostPointerCapture
value: `PointerEventHandler`
### onLostPointerCaptureCapture
value: `PointerEventHandler`
### onScroll
value: `UIEventHandler`
### onScrollCapture
value: `UIEventHandler`
### onWheel
value: `WheelEventHandler`
### onWheelCapture
value: `WheelEventHandler`
### onAnimationStart
value: `AnimationEventHandler`
### onAnimationStartCapture
value: `AnimationEventHandler`
### onAnimationEnd
value: `AnimationEventHandler`
### onAnimationEndCapture
value: `AnimationEventHandler`
### onAnimationIteration
value: `AnimationEventHandler`
### onAnimationIterationCapture
value: `AnimationEventHandler`
### onTransitionEnd
value: `TransitionEventHandler`
### onTransitionEndCapture
value: `TransitionEventHandler`
### MediaOptions
### image
value: `Omit`
- HydrogenImageProps: React.ComponentPropsWithRef<'img'> & HydrogenImageBaseProps
Props that will only apply when an `` is rendered
### video
value: `Omit & VideoHTMLAttributes & VideoProps, "data">`
- VideoProps: export interface VideoProps {
/** An object with fields that correspond to the Storefront API's [Video object](https://shopify.dev/api/storefront/2023-04/objects/video). */
data: PartialDeep;
/** An object of image size options for the video's `previewImage`. Uses `shopifyImageLoader` to generate the `poster` URL. */
previewImageOptions?: Parameters[0];
/** Props that will be passed to the `video` element's `source` children elements. */
sourceProps?: HTMLAttributes & {
'data-testid'?: string;
};
}
Props that will only apply when a `` is rendered
### externalVideo
value: `Omit`
- YouTube: interface YouTube {
autoplay?: 0 | 1;
cc_lang_pref?: string;
cc_load_policy?: 1;
color?: 'red' | 'white';
controls?: 0 | 1;
disablekb?: 0 | 1;
enablejsapi?: 0 | 1;
end?: number;
fs?: 0 | 1;
hl?: string;
iv_load_policy?: 1 | 3;
list?: string;
list_type?: 'playlist' | 'user_uploads';
loop?: 0 | 1;
modest_branding?: 1;
origin?: string;
playlist?: string;
plays_inline?: 0 | 1;
rel?: 0 | 1;
start?: number;
widget_referrer?: string;
}
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
Props that will only apply when an `` is rendered
### modelViewer
value: `Omit<(props: ModelViewerProps) => Element, "data">`
- ModelViewerProps: Omit<
PartialDeep,
'src'
> & ModelViewerBaseProps
Props that will only apply when a `` is rendered
### HydrogenImageBaseProps
### aspectRatio
value: `string`
The aspect ratio of the image, in the format of `width/height`.
### crop
value: `Crop`
- Crop: 'center' | 'top' | 'bottom' | 'left' | 'right'
The crop position of the image.
### data
value: `PartialObjectDeep`
Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2023-04/objects/Image) object. Must be an Image object.
### loader
value: `Loader`
- Loader: (params: LoaderParams) => string
A function that returns a URL string for an image.
### srcSetOptions
value: `SrcSetOptions`
- SrcSetOptions: {
intervals: number;
startingWidth: number;
incrementSize: number;
placeholderWidth: number;
}
An optional prop you can use to change the default srcSet generation behaviour
### loaderOptions
value: `ShopifyLoaderOptions`
- Loader: (params: LoaderParams) => string
- ShopifyLoaderOptions: {
/** The base URL of the image */
src?: ImageType['url'];
/** The URL param that controls width */
width?: HtmlImageProps['width'] | ImageType['width'];
/** The URL param that controls height */
height?: HtmlImageProps['height'] | ImageType['height'];
/** The URL param that controls the cropping region */
crop?: Crop;
}
### widths
value: `(string | number)[]`
### LoaderParams
### src
value: `string`
The base URL of the image
### width
value: `number`
The URL param that controls width
### height
value: `number`
The URL param that controls height
### crop
value: `Crop`
- Crop: 'center' | 'top' | 'bottom' | 'left' | 'right'
The URL param that controls the cropping region
### SrcSetOptions
### intervals
value: `number`
### startingWidth
value: `number`
### incrementSize
value: `number`
### placeholderWidth
value: `number`
### ShopifyLoaderOptions
Legacy type for backwards compatibility *
### src
value: `string`
The base URL of the image
### width
value: `string | number`
The URL param that controls width
### height
value: `string | number`
The URL param that controls height
### crop
value: `Crop`
- Crop: 'center' | 'top' | 'bottom' | 'left' | 'right'
The URL param that controls the cropping region
### VideoProps
### data
value: `PartialObjectDeep`
An object with fields that correspond to the Storefront API's [Video object](https://shopify.dev/api/storefront/2023-04/objects/video).
### previewImageOptions
value: `LoaderParams`
- Loader: (params: LoaderParams) => string
- LoaderParams: {
/** 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;
}
An object of image size options for the video's `previewImage`. Uses `shopifyImageLoader` to generate the `poster` URL.
### sourceProps
value: `HTMLAttributes & { 'data-testid'?: string; }`
Props that will be passed to the `video` element's `source` children elements.
### YouTube
### autoplay
value: `0 | 1`
### cc_lang_pref
value: `string`
### cc_load_policy
value: `1`
### color
value: `"red" | "white"`
### controls
value: `0 | 1`
### disablekb
value: `0 | 1`
### enablejsapi
value: `0 | 1`
### end
value: `number`
### fs
value: `0 | 1`
### hl
value: `string`
### iv_load_policy
value: `1 | 3`
### list
value: `string`
### list_type
value: `"playlist" | "user_uploads"`
### loop
value: `0 | 1`
### modest_branding
value: `1`
### origin
value: `string`
### playlist
value: `string`
### plays_inline
value: `0 | 1`
### rel
value: `0 | 1`
### start
value: `number`
### widget_referrer
value: `string`
### Vimeo
### autopause
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### autoplay
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### background
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### byline
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### color
value: `string`
### controls
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### dnt
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### loop
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### muted
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### pip
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### playsinline
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### portrait
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### quality
value: `"240p" | "360p" | "540p" | "720p" | "1080p" | "2k" | "4k"`
### speed
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### #t
value: `string`
### texttrack
value: `string`
### title
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### transparent
value: `VimeoBoolean`
- Vimeo: interface Vimeo {
autopause?: VimeoBoolean;
autoplay?: VimeoBoolean;
background?: VimeoBoolean;
byline?: VimeoBoolean;
color?: string;
controls?: VimeoBoolean;
dnt?: VimeoBoolean;
loop?: VimeoBoolean;
muted?: VimeoBoolean;
pip?: VimeoBoolean;
playsinline?: VimeoBoolean;
portrait?: VimeoBoolean;
quality?: '240p' | '360p' | '540p' | '720p' | '1080p' | '2k' | '4k';
speed?: VimeoBoolean;
'#t'?: string;
texttrack?: string;
title?: VimeoBoolean;
transparent?: VimeoBoolean;
}
- VimeoBoolean: 0 | 1 | boolean
### ModelViewerBaseProps
### data
value: `PartialObjectDeep`
An object with fields that correspond to the Storefront API's [Model3D object](https://shopify.dev/api/storefront/2023-04/objects/model3d).
### onError
value: `(event: Event) => void`
The callback to invoke when the 'error' event is triggered. Refer to [error in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-loading-events-error).
### onLoad
value: `(event: Event) => void`
The callback to invoke when the `load` event is triggered. Refer to [load in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-loading-events-load).
### onPreload
value: `(event: Event) => void`
The callback to invoke when the 'preload' event is triggered. Refer to [preload in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-loading-events-preload).
### onModelVisibility
value: `(event: Event) => void`
The callback to invoke when the 'model-visibility' event is triggered. Refer to [model-visibility in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-loading-events-modelVisibility).
### onProgress
value: `(event: Event) => void`
The callback to invoke when the 'progress' event is triggered. Refer to [progress in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-loading-events-progress).
### onArStatus
value: `(event: Event) => void`
The callback to invoke when the 'ar-status' event is triggered. Refer to [ar-status in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-augmentedreality-events-arStatus).
### onArTracking
value: `(event: Event) => void`
The callback to invoke when the 'ar-tracking' event is triggered. Refer to [ar-tracking in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-augmentedreality-events-arTracking).
### onQuickLookButtonTapped
value: `(event: Event) => void`
The callback to invoke when the 'quick-look-button-tapped' event is triggered. Refer to [quick-look-button-tapped in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-augmentedreality-events-quickLookButtonTapped).
### onCameraChange
value: `(event: Event) => void`
The callback to invoke when the 'camera-change' event is triggered. Refer to [camera-change in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-stagingandcameras-events-cameraChange).
### onEnvironmentChange
value: `(event: Event) => void`
The callback to invoke when the 'environment-change' event is triggered. Refer to [environment-change in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-lightingandenv-events-environmentChange).
### onPlay
value: `(event: Event) => void`
The callback to invoke when the 'play' event is triggered. Refer to [play in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-animation-events-play).
### onPause
value: `(event: Event) => void`
The callback to invoke when the 'pause' event is triggered. Refer to [pause in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-animation-events-pause).
### onSceneGraphReady
value: `(event: Event) => void`
The callback to invoke when the 'scene-graph-ready' event is triggered. Refer to [scene-graph-ready in the documentation](https://modelviewer.dev/docs/index.html#entrydocs-scenegraph-events-sceneGraphReady).
## Related
- [Image](/api/hydrogen/components/image)
- [Video](/api/hydrogen/components/video)
- [ExternalVideo](/api/hydrogen/components/externalvideo)
- [ModelViewer](/api/hydrogen/components/modelviewer)