Introduction

View on Github

Note: We are reducing our investment in CARTO for React and currently we discourage users from starting new projects with it.

CARTO for React is an opinionated framework with pre-built components and templates. This greatly speeds up the process to create React-based applications, but customization options are limited.

If you need further customization in React, or you want to build geospatial applications using Vue, Angular, or any other Javascript-based framework, we recommend going directly to the main CARTO for Developers documentation, including CARTO + deck.gl, which allows for maximum flexibility and scalability.

This section contains the API reference for the CARTO for React library. It is a multi-package Javascript library built with Lerna. If you are working with Typescript, there are type declarations available bundled with each package.

We document here only the objects and functions exported from the library for each of the different packages. Click on the package name to access the corresponding API reference:

Package	Version	Description
@carto/react-api		Integration with CARTO platform APIs
@carto/react-auth		CARTO 2 authentication and authorization
@carto/react-basemaps		Integration with CARTO and Google basemaps
@carto/react-core		Basic utility functions
@carto/react-redux		Application state management
@carto/react-ui		Material-UI theme and user interface components for widgets
@carto/react-widgets		Business logic for widgets