This is the official "CARTO for React library". It is organized as a set of npm packages (@carto/react-*), that work together providing widgets and utilities to build Location Intelligence applications with React, Redux & Material-UI.

The packages are:

• @carto/react-api
• @carto/react-auth
• @carto/react-basemaps
• @carto/react-core
• @carto/react-redux
• @carto/react-ui
• @carto/react-widgets
• @carto/react-workers

To work in the code, see developers.

These packages are used by the CARTO for React templates, made with CRA (Create React App).

There is a Storybook guide with the main UI components and how to use them at CARTO for React - UI Components

If you are using the CARTO CRA templates, everything is already setup, so no further configuration is needed!

In case you want to use this set of packages in a different context, then you would need to install them as usual, with something like:

  yarn add @carto/react-api
  yarn add @carto/react-auth
  yarn add @carto/react-basemaps
  yarn add @carto/react-core
  yarn add @carto/react-redux
  yarn add @carto/react-ui
  yarn add @carto/react-widgets
  yarn add @carto/react-workers

Notice that to avoid issues within host projects, most of the base libraries are declared as peer dependencies (deck.gl, react, material-ui, reduxjs-toolkit, echarts...). That means that you would need to add them explicitly to your project, if you are still not using them (keep an eye on the console warnings on peer dependencies).