Interface WidgetProps

interface WidgetProps {
    callbacks?: Callbacks;
    eventListeners?: EventListeners;
    existentialNFT?: {
        deployments: Partial<Record<1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111, null | string>>;
        image?: string;
        name: string;
        owner: string;
        symbol: string;
    };
    networkAssets?: NetworkAssets;
    paymentDetails: {
        defaultWrapAmount?: {
            multiplier: number;
            period?: "day" | "week" | "month" | "year";
        };
        modifyFlowRateBehaviour?: string;
        paymentOptions: ({
            chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
            flowRate?: {
                amountEther: string;
                period: "day" | "week" | "month" | "year";
            };
            receiverAddress: string;
            superToken: {
                address: string;
            };
            transferAmountEther?: string;
            userData?: string;
        } | {
            chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
            flowRate?: {
                amountEther: string;
                period: "day" | "week" | "month" | "year";
            };
            receiverAddress: string;
            superToken: {
                address: string;
            };
            transferAmountEther?: string;
            userData?: string;
        }[]) & (undefined | {
            chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
            flowRate?: {
                amountEther: string;
                period: "day" | "week" | "month" | "year";
            };
            receiverAddress: string;
            superToken: {
                address: string;
            };
            transferAmountEther?: string;
            userData?: string;
        } | {
            chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
            flowRate?: {
                amountEther: string;
                period: "day" | "week" | "month" | "year";
            };
            receiverAddress: string;
            superToken: {
                address: string;
            };
            transferAmountEther?: string;
            userData?: string;
        }[]);
    };
    personalData?: {
        disabled?: boolean;
        label: string;
        name: string;
        optional?: boolean;
        required?: {
            message: string;
            pattern: string;
        };
        size?: "half" | "full";
        value?: string;
    }[];
    productDetails?: {
        description?: string;
        imageURI?: string;
        name: string;
        successText?: string;
        successURL?: string;
    };
    stepper?: {
        orientation: "horizontal" | "vertical";
    };
    theme?: WidgetThemeOptions;
    tokenList?: SuperTokenList;
    walletManager?: WalletManager;
}

Hierarchy

  • input<typeof widgetPropsSchema>
    • WidgetProps

Properties

callbacks? eventListeners? existentialNFT? networkAssets? paymentDetails personalData? productDetails? stepper? theme? tokenList? walletManager?

Properties

Optional callbacks

callbacks?: Callbacks = ...

Optional eventListeners

eventListeners?: EventListeners = ...

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

Optional existentialNFT

existentialNFT?: {
    deployments: Partial<Record<1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111, null | string>>;
    image?: string;
    name: string;
    owner: string;
    symbol: string;
} = ...

The symbol, name, owner and addresses of the deployed ExistentialNFT clones.

Type declaration

  • deployments: Partial<Record<1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111, null | string>>
  • Optional image?: string
  • name: string
  • owner: string
  • symbol: string

Optional networkAssets

networkAssets?: NetworkAssets = ...

paymentDetails

paymentDetails: {
    defaultWrapAmount?: {
        multiplier: number;
        period?: "day" | "week" | "month" | "year";
    };
    modifyFlowRateBehaviour?: string;
    paymentOptions: ({
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    } | {
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    }[]) & (undefined | {
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    } | {
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    }[]);
} = paymentDetailsSchema

The details of the payment options for the checkout flow.

Type declaration

  • Optional defaultWrapAmount?: {
        multiplier: number;
        period?: "day" | "week" | "month" | "year";
    }
    • multiplier: number
    • Optional period?: "day" | "week" | "month" | "year"
  • Optional modifyFlowRateBehaviour?: string
  • paymentOptions: ({
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    } | {
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    }[]) & (undefined | {
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    } | {
        chainId: 1 | 42161 | 43114 | 43113 | 8453 | 56 | 42220 | 100 | 10 | 11155420 | 137 | 534352 | 534351 | 11155111;
        flowRate?: {
            amountEther: string;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: string;
        superToken: {
            address: string;
        };
        transferAmountEther?: string;
        userData?: string;
    }[])

Optional personalData

personalData?: {
    disabled?: boolean;
    label: string;
    name: string;
    optional?: boolean;
    required?: {
        message: string;
        pattern: string;
    };
    size?: "half" | "full";
    value?: string;
}[] = ...

Type declaration

  • Optional disabled?: boolean
  • label: string
  • name: string
  • Optional optional?: boolean
  • Optional required?: {
        message: string;
        pattern: string;
    }
    • message: string
    • pattern: string
  • Optional size?: "half" | "full"
  • Optional value?: string

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: "horizontal" | "vertical";
} = ...

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

Type declaration

  • orientation: "horizontal" | "vertical"

Optional theme

theme?: WidgetThemeOptions = ...

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