Skip to main content

ProductLink

@shopify/shop-minis-platform-sdk / components/ProductLink

CustomProductLinkNode

Extends

  • VariantsNodes

Properties

__typename

__typename: "ProductVariant"

Inherited from

ProductLinkFragmentData.VariantsNodes.__typename

compareAtPrice?

optional compareAtPrice: null | VariantsNodesCompareAtPrice

Inherited from

ProductLinkFragmentData.VariantsNodes.compareAtPrice

id

id: string

Inherited from

ProductLinkFragmentData.VariantsNodes.id

image?

optional image: null | VariantsNodesImage

Inherited from

ProductLinkFragmentData.VariantsNodes.image

isFavorited?

optional isFavorited: boolean

price

price: VariantsNodesPrice

Inherited from

ProductLinkFragmentData.VariantsNodes.price

title

title: string

Inherited from

ProductLinkFragmentData.VariantsNodes.title


CustomProductLinkProps

Extends

  • ProductLinkFragmentData

Properties

__typename

__typename: "Product"

Inherited from

ProductLinkFragmentData.__typename

featuredImage?

optional featuredImage: null | FeaturedImage

Inherited from

ProductLinkFragmentData.featuredImage

id

id: string

Inherited from

ProductLinkFragmentData.id

reviewsAverageRating?

optional reviewsAverageRating: null | number

Inherited from

ProductLinkFragmentData.reviewsAverageRating

reviewsCount?

optional reviewsCount: null | number

Inherited from

ProductLinkFragmentData.reviewsCount

title

title: string

Inherited from

ProductLinkFragmentData.title

variants

variants: Variants & object

Type declaration
nodes

nodes: CustomProductLinkNode[]

Overrides

ProductLinkFragmentData.variants


ProductLinkProps

Properties

attribution?

optional attribution: LineItemAttribution

Attribution used for user actions in the product details screen triggered by this component

onFavoriteToggled()?

optional onFavoriteToggled: (isFavorited) => void

Optional callback triggered when favorite state is toggled.

Parameters
ParameterType
isFavoritedboolean
Returns

void

onPress()?

optional onPress: () => void

Optional callback triggered when the component is pressed

Returns

void

product

product: CustomProductLinkProps

productVariantId?

optional productVariantId: string

sectionId?

optional sectionId: string

Used for impression tracking

shopId?

optional shopId: string

trackingDisabled?

optional trackingDisabled: boolean

Disables impression tracking


ProductLink(__namedParameters): null | Element

Parameters

ParameterType
__namedParametersProductLinkProps

Returns

null | Element