Skip to content

Documentation / @frak-labs/components / BannerProps

Type Alias: BannerProps

BannerProps = { classname?: string; inappCta?: string; inappDescription?: string; inappTitle?: string; interaction?: InteractionTypeKey; placement?: string; preview?: string; previewMode?: "referral" | "inapp"; referralCta?: string; referralDescription?: string; referralTitle?: string; }

Defined in: sdk/components/src/components/Banner/types.ts:7

The props type for Banner.

Extended by

Properties

classname?

optional classname?: string

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

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

inappCta?

optional inappCta?: string

Defined in: sdk/components/src/components/Banner/types.ts:44

Override the in-app browser banner CTA button text.

inappDescription?

optional inappDescription?: string

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

Override the in-app browser banner description.

inappTitle?

optional inappTitle?: string

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

Override the in-app browser banner title.

interaction?

optional interaction?: InteractionTypeKey

Defined in: sdk/components/src/components/Banner/types.ts:20

Filter rewards by interaction type (e.g. "purchase", "referral"). When omitted, the best reward across all interaction types is shown.

placement?

optional placement?: string

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

Placement ID for backend-driven CSS customization.

preview?

optional preview?: string

Defined in: sdk/components/src/components/Banner/types.ts:49

When set, forces the banner to render in preview mode (e.g. in Shopify theme editor). Bypasses normal event/browser detection and shows static content.

previewMode?

optional previewMode?: "referral" | "inapp"

Defined in: sdk/components/src/components/Banner/types.ts:54

Which banner variant to preview: "referral" or "inapp". Only used when preview is set. Defaults to "referral".

referralCta?

optional referralCta?: string

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

Override the referral banner CTA button text.

referralDescription?

optional referralDescription?: string

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

Override the referral banner description.

referralTitle?

optional referralTitle?: string

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

Override the referral banner title.