Skip to content

Documentation / @frak-labs/components / PostPurchaseProps

Type Alias: PostPurchaseProps

PostPurchaseProps = { badgeText?: string; classname?: string; ctaText?: string; customerId?: string; merchantId?: string; orderId?: string; placement?: string; refereeText?: string; referrerText?: string; sharingUrl?: string; token?: string; variant?: "referrer" | "referee"; }

Defined in: sdk/components/src/components/PostPurchase/types.ts:5

Props for the PostPurchase component.

Extended by

Properties

badgeText?

optional badgeText?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:45

Label for the pill badge displayed above the message. When omitted (and no placement config provides one), the badge is hidden.

classname?

optional classname?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:36

CSS class names passed through to the root element (Light DOM).

ctaText?

optional ctaText?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:60

Override the CTA button text. Use {REWARD} as placeholder for the reward amount.

customerId?

optional customerId?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:11

Merchant customer ID for purchase tracking fallback. All three tracking props (customerId, orderId, token) must be present for tracking to fire.

merchantId?

optional merchantId?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:28

Override the merchant ID resolved from the SDK config.

orderId?

optional orderId?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:15

Merchant order ID for purchase tracking fallback.

placement?

optional placement?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:32

Placement ID for backend-driven CSS customization.

refereeText?

optional refereeText?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:55

Override the message shown to referees. Use {REWARD} as placeholder for the reward amount.

referrerText?

optional referrerText?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:50

Override the message shown to referrers. Use {REWARD} as placeholder for the reward amount.

sharingUrl?

optional sharingUrl?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:24

Base URL to share. Falls back to the merchant domain returned by the backend when omitted.

token?

optional token?: string

Defined in: sdk/components/src/components/PostPurchase/types.ts:19

Checkout token for purchase tracking fallback.

variant?

optional variant?: "referrer" | "referee"

Defined in: sdk/components/src/components/PostPurchase/types.ts:40

Force a display variant instead of relying on the backend evaluation.