Component Properties
Understand the properties available on the NFT checkout
If you are using our previous version of embedded checkout, please refer to the old component properties guide
Common Properties
Specifies the NFTs to purchase. Can be a single item or array of items.
Configuration for payment methods.
Delivery details for the NFTs. You must specify either email OR wallet address, not both:
When not provided, user will be prompted during checkout.
Sets the checkout interface language.
en-US
de-DE
es-ES
fr-FR
it-IT
ja-JP
ko-KR
pt-PT
ru-RU
th-TH
tr-TR
uk-UA
vi-VN
zh-CN
zh-TW
Klingon
Specific Properties & Hooks
The pay button is only available for React applications. For full customization options, please use our Headless Checkout.
The following properties are available for the CrossmintHostedCheckout
component:
Customization options for the pay button UI. See our UI Customization guide for complete details.
Notable appearance options:
- Display mode:
display: "popup" | "new-tab"
(default: “popup”) - Background overlay:
overlay.enabled: false
to disable the gray background - Button theme:
theme.button: "light" | "dark" | "crossmint"
(default: “light”) - Checkout theme:
theme.checkout: "light" | "dark"
(default: “light”)
The pay button is only available for React applications. For full customization options, please use our Headless Checkout.
The following properties are available for the CrossmintHostedCheckout
component:
Customization options for the pay button UI. See our UI Customization guide for complete details.
Notable appearance options:
- Display mode:
display: "popup" | "new-tab"
(default: “popup”) - Background overlay:
overlay.enabled: false
to disable the gray background - Button theme:
theme.button: "light" | "dark" | "crossmint"
(default: “light”) - Checkout theme:
theme.checkout: "light" | "dark"
(default: “light”)
The embedded checkout is only available for React applications. For full customization options, please use our Headless Checkout.
The following properties are available for the CrossmintEmbeddedCheckout
component:
Extends the common payment configuration with additional options.
Customization options for the checkout UI. See our UI Customization guide for complete details.
Notable appearance options:
- Hide destination input:
rules.DestinationInput.display: "hidden"
- Hide receipt email input:
rules.ReceiptEmailInput.display: "hidden"
The following React hooks are available for use with the Embedded Checkout:
The useCrossmintCheckout
hook is used to access the current order and checkout state.
All Crossmint hooks must be used within components wrapped by both CrossmintProvider
and CrossmintCheckoutProvider
:
The following properties are available from the useCrossmintCheckout
hook:
The current order object containing all order details.
Was this page helpful?