SaleWidgetParams: {
    amount?: string;
    environmentId?: string;
    items?: checkout.SaleItem[];
    collectionName?: string;
    walletProviderName?: checkout.WalletProviderName;
    language?: checkout.WidgetLanguage;
    excludePaymentTypes?: checkout.SalePaymentTypes[];
}

Sale Widget parameters

Type declaration

  • Optional amount?: string

    The total price to pay for the items in the sale

  • Optional environmentId?: string

    Environment id from Immutable Hub

  • Optional items?: checkout.SaleItem[]

    The list of products to be purchased

  • Optional collectionName?: string

    The name of the NFT collection on sale

  • Optional walletProviderName?: checkout.WalletProviderName

    The wallet provider name to default to if no web3Provider is passed

  • Optional language?: checkout.WidgetLanguage

    The language to use for the sales widget

  • Optional excludePaymentTypes?: checkout.SalePaymentTypes[]

    The disabled payment types

Generated using TypeDoc