Getting Started with the KendoReact Map

This guide provides information about using the KendoReact Map—you will learn how to install the package, add a Map component to your project, style the component, and activate your license.

After completing this guide, you will be able to reproduce the following example.

Setting Up Your React Project

Before you install the KendoReact Map, make sure that you have a running React project. The easiest way to set up a React project is to use the Create React App approach that is described in the Get Started with KendoReact article.

Installing the Components

All KendoReact packages are distributed through npm and offer a similar installation experience. To use any component from the Map package, start with the installation of the package and its dependencies. Use Node.js v14.0.0 or later.

Navigate to the root folder of your React project and run the following command:

Copy Codenpm install --save @progress/kendo-react-map @progress/kendo-drawing @progress/kendo-licensing

Importing the Components

After installing the Map package, import the desired components in the React App. In this guide, you will add a tile layer to the Map, and this requires you to import the MapLayers collection and the MapTileLayer configuration component.

In the App component file of your React project (for example, src/App.js), add the following code:

Copy Code// ES2015 module syntax
import { Map, MapLayers, MapTileLayer } from '@progress/kendo-react-map';

Copy Code// CommonJS format
const { Map, MapLayers, MapTileLayer } = require('@progress/kendo-react-map');

Using the Components

1. After installing the Map package and importing the components, add the Map tags to the App component file of your React project (for example, src/App.js).

   Copy Code // Set up an OpenStreetMap tile map
    const tileUrl = (e) => `https://tile.openstreetmap.org/${e.zoom}/${e.x}/${e.y}.png`;
    const attribution = '© OpenStreetMap contributors';
   
    const MapContainer = () => (
    <Map>
       <MapLayers>
       <MapTileLayer
          urlTemplate={tileUrl}
          attribution={attribution}
          />
       </MapLayers>
    </Map>
    );
   
    ReactDOM.render(<MapContainer />, document.querySelector("my-app"));

2. To style the Map, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

   2.1. Install the Default theme package.

   Copy Codenpm install --save @progress/kendo-theme-default

   2.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

   Copy Codeimport '@progress/kendo-theme-default/dist/all.css';

3. Build and run the application by typing the following command in the root folder of your project:

   Copy Codenpm start

4. Navigate to http://localhost:3000 to see the KendoReact Map component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The Map package requires you to install the following peer dependencies in your application:

The following dependencies are automatically installed:

Suggested Links

• Map Overview
• Layer Types of the Map
• API Reference of the Map

Learning Resources

• Getting Started with KendoReact
• Virtual Classroom (Introductory Course Available to Trial and Commercial License Holders)
• Explore the Finance Portfolio Sample Application
• Explore the Coffee Warehouse Sample Application
• Explore the Github Issues Grid Sample Application