BannerProps

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

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

The props type for Banner.

Extended by

BannerElement

Properties

allowInappRedirect?

optional allowInappRedirect?: boolean | "true" | "false"

Defined in: vendor/wallet/sdk/components/src/components/Banner/types.ts:76

When true (default false), the banner is allowed to switch to in-app browser mode (Instagram / Facebook WebView) and prompt the user to escape to the system browser.

Most flows now work inside in-app browsers via the anonymous-id flow, so the redirect is opt-in. Enable it only on surfaces that actually drive users into a WebAuthn-bound action (login, sendTransaction, SIWE authenticate).

Accepts the boolean true (TS/JSX) or the string "true" (HTML attribute). Any other value — including false, "false", the empty string, or attribute absence — keeps the redirect disabled.

classname?

optional classname?: string

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

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

imageUrl?

optional imageUrl?: string

Defined in: vendor/wallet/sdk/components/src/components/Banner/types.ts:51

Override the image displayed on the left of the referral banner. Accepts an image URL. Falls back to the built-in gift icon when omitted. The image is constrained to the icon slot via object-fit: contain, so any aspect ratio renders correctly.

inappCta?

optional inappCta?: string

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

Override the in-app browser banner CTA button text.

inappDescription?

optional inappDescription?: string

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

Override the in-app browser banner description.

inappTitle?

optional inappTitle?: string

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

Override the in-app browser banner title.

interaction?

optional interaction?: InteractionTypeKey

Defined in: vendor/wallet/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: vendor/wallet/sdk/components/src/components/Banner/types.ts:11

Placement ID for backend-driven CSS customization.

preview?

optional preview?: string

Defined in: vendor/wallet/sdk/components/src/components/Banner/types.ts:56

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.