GitHub

ShopifyMedia

Type

import { ShopifyMedia } from '@daffodil/driver/shopify'

A common set of fields for media content associated with products. Implementations include MediaImage for Shopify-hosted images, Video for Shopify-hosted videos, ExternalVideo for videos hosted on platforms like YouTube or Vimeo, and Model3d for 3D models.

Each implementation shares fields for alt text, content type, and preview images, while adding type-specific fields like embed URLs for external videos or source files for 3D models.

interface ShopifyMedia {
  alt: string
  id: string
  mediaContentType: ShopifyMediaContentType
  presentation: ShopifyMediaPresentation
  previewImage: ShopifyImage
}

Properties

alt
string

A word or phrase to share the nature or contents of a media.

id
string

A globally-unique ID.

mediaContentType
ShopifyMediaContentType

The media content type.

presentation
ShopifyMediaPresentation

The presentation for a media.

previewImage
ShopifyImage

The preview image for the media.