yarn upgrade @carto/react-api \
npm upgrade @carto/react-api \
itemsno longer available, use
Changed to a controlled component. So now it needs to handle
onChangefunction in the parent.
For multiple selection functionality, now use
aggregationExpare moved from
The new API is backward compatibe for rendering purposes, but improved widgets calculation needs the two parameters in
If the parameters are present in a layer and widgets are defined over the same data source, it's important that the parameters are moved to the data source definition used in both the layer and the widgets.
sxprops removed from:
styled APIinstead to wrap the affected widget in a container and apply the styles there.
There is a breaking change regarding both the underlying UI library (major upgrade from Material-UI 4 to MUI5) and the visual aspect of the components (a new & improved Design System, with new palette of colors & fonts).
For the Material UI migration there is a very detailed guide in the official Documentation, that should help to achieve a smooth migration. Regarding the second, some visual tweaks might be needed to fit into already existing apps, especially if those were using some type of theme customization.
On the React side, current 2.0 is compatible with React 17, as it still uses some makeStyles calls (API based on JSS). A migration process has already started, to dump that API, in favor of more modern and recommended options, like the styled & sx apis. Once that process is done, React 18 will be compatible.
aggregationExphave transitioned from
While the updated API maintains backward compatibility for rendering, enhanced widget calculations require these parameters to be in the
For layers with these parameters and widgets using the same data source, ensure the parameters are relocated to the data source definition employed in both the layer and widgets.
There are no major changes in v1.2 that should affect your applications when upgrading from v1.4 to v1.5
It requires bumping deck.gl to >=8.8.15 + new dependency: 'quadbin' >= 0.1.5
The main change that can have an impact when upgrading is the update of deck.gl to v8.8. In this new version of deck.gl, the
CartoLayeronly works with vector tiles and this change can affect to widgets. If we are using dynamic tiling and there are features dropped in the current zoom level, the widgets are not going to show results but a message indicating that not all the data is available. If you need the widgets to work at all zoom levels and the data source is of small/medium size, you can keep using GeoJSON but directly with the
GeoJsonLayeras explained here.
We have updated the
HistogramWidgetand now it can work in two different modes: you can keep using the
ticksproperty to specify the breaks for the bins, or you can use the new
binsproperty where you just specify the number of bins to use and the widget is going to calculate the breaks.
HistogramWidgetwas used with categorical data but it should be use to show the distribution of a numeric column. We have created a new
BarWidgetthat should be used when we want to visualize categorical data using vertical bars.
There are no major changes in v1.2 that should affect your applications when upgrading from v1.1.
If you update an application that is using v1.0 of the CARTO for React library to v1.1, there are some minor changes that might affect your existing code (we have already updated our documentation with these changes):
SourceTypesconstants have been removed from the
typeproperty in data sources now accepts a different set of values. You need to use
MAP_TYPES.QUERYif you were using
MAP_TYPES.TILESETif you were using
MAP_TYPESconstants are defined in the
In this new version 1.1, we have also renamed our existing templates and added three new templates for creating applications with the CARTO 3 platform:
base-2is the new name for the existing CARTO 2 skeleton template, previously the default
@cartotemplate$ yarn create react-app my-app --template @carto/base-2
base-3is the name for the new CARTO 3 template$ yarn create react-app my-app --template @carto/base-3
base-3-typescriptis the name for the new CARTO 3 template for TypeScript$ yarn create react-app my-app --template @carto/base-3-typescript
sample-app-2is the new name for the existing sample app template for CARTO 2, previously named
sample-app$ yarn create react-app my-app --template @carto/sample-app-2
sample-app-3is the name for the new sample app template for CARTO 3$ yarn create react-app my-app --template @carto/sample-app-3
CARTO for React v1.1 is the first version compatible with the CARTO 3 platform. CARTO 3 is the new version of the CARTO platform that provides direct connectivity to cloud data warehouses without the need for importing data first into CARTO. If you want to learn more about this new version and sign-up for a free trial, please go to this page.