This is the official "CARTO for React library". It is organized as a set of npm packages (@keys2design/carto-react-*), that work together providing widgets and utilities to build Location Intelligence applications with React, Redux & Material-UI.
The packages are:
- @keys2design/carto-react-api
- @keys2design/carto-react-auth
- @keys2design/carto-react-basemaps
- @keys2design/carto-react-core
- @keys2design/carto-react-redux
- @keys2design/carto-react-ui
- @keys2design/carto-react-widgets
- @keys2design/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 @keys2design/carto-react-api
yarn add @keys2design/carto-react-auth
yarn add @keys2design/carto-react-basemaps
yarn add @keys2design/carto-react-core
yarn add @keys2design/carto-react-redux
yarn add @keys2design/carto-react-ui
yarn add @keys2design/carto-react-widgets
yarn add @keys2design/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).