templates_ShoppableVideos_types.ShoppableVideosCustomisationProps

@shopify/shop-minis-platform-sdk / templates/ShoppableVideos/types / ShoppableVideosCustomisationProps

Interface: ShoppableVideosCustomisationProps<ItemType>

templates/ShoppableVideos/types.ShoppableVideosCustomisationProps

Type parameters

Name
ItemType

Hierarchy

• ShoppableVideoCustomisationProps<ItemType>

  ↳ ShoppableVideosCustomisationProps

Table of contents

Properties

• onShopLoaded
• renderItem
• renderMedia
• renderMediaFooter
• renderMediaHeader

Properties

onShopLoaded

• Optional onShopLoaded: (shop: null | Shop) => void

Type declaration

▸ (shop): void

Parameters

Name	Type
shop	null | Shop

Returns

void

---

renderItem

• Optional renderItem: (params: { currentIndex: number ; index: number ; item: ItemType }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (params): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
params	Object
params.currentIndex	number
params.index	number
params.item	ItemType

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

---

renderMedia

• Optional renderMedia: (params: { isPlaying: boolean ; item: ItemType }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (params): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
params	Object
params.isPlaying	boolean
params.item	ItemType

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

ShoppableVideoCustomisationProps.renderMedia

---

renderMediaFooter

• Optional renderMediaFooter: (params: { item: ItemType }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (params): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
params	Object
params.item	ItemType

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

ShoppableVideoCustomisationProps.renderMediaFooter

---

renderMediaHeader

• Optional renderMediaHeader: (params: { isMuted: boolean ; item: ItemType ; onMutePress: () => void ; storeInfo?: null | BaseShopFragmentData }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (params): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
params	Object
params.isMuted	boolean
params.item	ItemType
params.onMutePress	() => void
params.storeInfo?	null | BaseShopFragmentData

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

ShoppableVideoCustomisationProps.renderMediaHeader