ShoppablePosts

@shopify/shop-minis-platform-sdk / templates/ShoppablePosts/ShoppablePosts

ShoppablePostsProps\<ItemType>

Extends

• ShoppablePostsCustomisationProps\<ItemType>

Type Parameters

Type Parameter
ItemType

Properties

fetchMoreByProductIds()?

optional fetchMoreByProductIds: (productIds) => ItemType[]

Parameters

Parameter	Type
productIds	string[]

Returns

ItemType[]

fetchMoreByShopId()?

optional fetchMoreByShopId: (shopId) => ItemType[]

Parameters

Parameter	Type
shopId	string

Returns

ItemType[]

initialItems

initialItems: ItemType[]

onShopLoaded()?

optional onShopLoaded: (shop) => void

Callback fired once when the information of the Shop is retrieved

Parameters

Parameter	Type
shop	null | Shop

Returns

void

Inherited from

ShoppablePostsCustomisationProps.onShopLoaded

renderHeader()?

optional renderHeader: () => null | ReactElement\<any, string | JSXElementConstructor\<any>>

Render function to overwrite the top header of the template

Returns

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

Inherited from

ShoppablePostsCustomisationProps.renderHeader

renderItem()?

optional renderItem: (params) => null | ReactElement\<any, string | JSXElementConstructor\<any>>

Render function to overwrite the whole UI of each post

Parameters

Parameter	Type
params	object
params.index	number
params.item	ItemType

Returns

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

Inherited from

ShoppablePostsCustomisationProps.renderItem

renderMedia()?

optional renderMedia: (params) => null | ReactElement\<any, string | JSXElementConstructor\<any>>

Render function to overwrite the media component of each post. Useful if you want to use the template to render other kinds of media like videos.

Parameters

Parameter	Type
params	object
params.item	ItemType

Returns

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

Inherited from

ShoppablePostsCustomisationProps.renderMedia

renderMediaFooter()?

optional renderMediaFooter: (params) => null | ReactElement\<any, string | JSXElementConstructor\<any>>

Render function to overwrite the footer of each post

Parameters

Parameter	Type
params	object
params.item	ItemType

Returns

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

Inherited from

ShoppablePostsCustomisationProps.renderMediaFooter

shopId

shopId: string

---

ShoppablePostsStackParamList\<ItemType>

Extends

• ParamListBase

Type Parameters

Type Parameter	Default type
ItemType	unknown

Properties

CrossMerchantFeed

CrossMerchantFeed: undefined

MerchantFeed

MerchantFeed: object

externalID

externalID: string

initialItems?

optional initialItems: ItemType[]

shopGID?

optional shopGID: string

MerchantGrid

MerchantGrid: object

storeInfo

storeInfo: BaseShopFragmentData

---

ShoppablePosts()

ShoppablePosts\<ItemType>(__namedParameters): Element

Type Parameters

Type Parameter	Default type
ItemType extends ShoppablePostsItem	ShoppablePostsItem

Parameters

Parameter	Type
__namedParameters	ShoppablePostsProps\<ItemType>

Returns

Element