Interface WidgetProps

Hierarchy

  • input<typeof widgetPropsSchema>
    • WidgetProps

Properties

eventListeners? networkAssets? paymentDetails productDetails? stepper? theme? tokenList? walletManager?

Properties

Optional eventListeners

eventListeners?: EventListeners = ...

A set of non-blocking callback functions that are triggered in response to the widget events.

Optional networkAssets

networkAssets?: NetworkAssets = ...

paymentDetails

paymentDetails: {
    defaultWrapAmount?: { multiplier: number; period?: "day" | "week" | "month" | "year" | undefined; };
    modifyFlowRateBehaviour?: string;
    paymentOptions: Object;
} = paymentDetailsSchema

The details of the payment options for the checkout flow.

Type declaration

  • Optional defaultWrapAmount?: { multiplier: number; period?: "day" | "week" | "month" | "year" | undefined; }
  • Optional modifyFlowRateBehaviour?: string
  • paymentOptions: Object

Optional productDetails

productDetails?: {
    description?: string;
    imageURI?: string;
    name: string;
    successText?: string;
    successURL?: string;
} = ...

The details of the checkout product.

Type declaration

  • Optional description?: string

    The description of the checkout product.

  • Optional imageURI?: string

    The image URI of the checkout product. Can be an URL, can be a data URI (e.g. inline Base64).

  • name: string

    The name of the checkout product.

  • Optional successText?: string

    Text shows on the success button in the final screen of the checkout.

  • Optional successURL?: string

    The URL to redirect to when the success button is clicked.

Optional stepper

stepper?: {
    orientation: "vertical" | "horizontal";
} = ...

Whether the stepper UI component inside the widget is vertical or horizontal. Vertical is better supported.

Type declaration

  • orientation: "vertical" | "horizontal"

Optional theme

theme?: Omit<ThemeOptions, "unstable_strictMode" | "unstable_sxConfig"> = ...

The MUI theme object to style the widget. Learn more about it from the MUI documentation: https://mui.com/material-ui/customization/default-theme/

Optional tokenList

tokenList?: SuperTokenList = ...

The token list that contains Super Tokens and their underlying tokens.

Optional walletManager

walletManager?: WalletManager = ...

An interface for interacting with a wallet management library (e.g. Web3Modal, RainbowKit, ConnectKit etc).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc