Crossmint SDK v0.2.x Migration Guide

v0.2.x introduces a breaking change with respect to the way collectionTitle, collectionPhoto, and collectionDescription are handled by Crossmint.

Main changes

Previously, collectionTitle, collectionPhoto, and collectionDescription were passed to Crossmint through the CrossmintPayButton parameters. These parameters have been moved into the developer console, accessible at https://crossmint.com/console.

Installing the new version

Let’s take a look at our package.json file first:

Remove @crossmint/client-sdk-react-ui from your package.json

Then install the latest version by running:

yarn add @crossmint/client-sdk-react-ui 

or

npm install @crossmint/client-sdk-react-ui

What to change in your application to use the latest version

You have installed a previous version of our package before and now you would like to get the latest version. Here’s what we’ll need to do to get it working exactly as it did before:

Remove old parameters from CrossmintPayButton

Wherever you use CrossmintPayButton in your code, go to it and delete the following parameters being passed to the button

Update your collection title, image, and description in Crossmint Console

Go to https://crossmint.com/console, select Collections, then select the individual Collection you would like to edit:

Edit the following fields, which will be reflected and seen by users when they buy from your collection:

You’re done! 🎉

Questions? Feedback? Ping us in Discord!