How to change the map labels language based on visitor’s location

This tutorial demonstrates the process of automatically adjusting the language of map labels based on the visitor’s location using the MapTiler Geolocation API.

By utilizing the MapTiler Geolocation API, it becomes possible to dynamically change the language of map labels to match the user’s location main language. This feature enhances the user experience by providing map information in a language that is familiar and easily understood by the visitor. With the MapTiler Geolocation API, businesses and websites can seamlessly integrate this functionality into their mapping applications, ensuring a personalized and localized experience for their users.

NPM module setup

Install the npm package.
```
 npm install --save @maptiler/sdk
```

Include the CSS file.

If you have a bundler that can handle CSS, you can import the CSS


 import "@maptiler/sdk/dist/maptiler-sdk.css";

or include it with a <link /> in the head of the document via the CDN


 <link href='https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css' rel='stylesheet' />

Include the following code in your JavaScript file (Example: app.js).


 import * as maptilersdk from '@maptiler/sdk';

 maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
 const map = new maptilersdk.Map({
   container: 'map', // container's id or the HTML element to render the map
   style: maptilersdk.MapStyle.STREETS,
      
   center: [20, 50], // starting position [lng, lat]
   zoom: 4, // starting zoom
      
 });

Replace YOUR_MAPTILER_API_KEY_HERE with your own API key. Make sure to secure the key before you publish it.
The next is up to you. You can center your map wherever you desire (modifying the starting position) and set an appropriate zoom level (modifying the starting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating the source URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application.
Add event handler for map load event. You will add code to change disputed borders according to your map visitor’s location in this handler.
```
 map.on('load', async () => {
    
 });
```

Get the user’s IP country languages codes.


 map.on('load', async () => {
   const geolocationIP = await maptilersdk.geolocation.info();
   const {country_languages} = geolocationIP;
 });

Change the language of the map. In this example we will use the first language of the language array of the visitor’s country.


 map.on('load', async () => {
   const geolocationIP = await maptilersdk.geolocation.info();
   const {country_languages} = geolocationIP;
   map.setLanguage(`name:${country_languages[0]}`);
 });

Basic JavaScript setup

Copy the following code, paste it into your favorite text editor, and save it as a .html file.


 <!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <title>Change the map labels language based on visitor's location</title>
   <script src="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.umd.min.js"></script>
   <link href="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css" rel="stylesheet" />
   <style>
     body { margin: 0; padding: 0; }
     #map { position: absolute; top: 0; bottom: 0; width: 100%; }
   </style>
 </head>
 <body>
   <div id="map"></div>
   <script>
       maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';      
       const map = new maptilersdk.Map({
         container: 'map', // container's id or the HTML element to render the map
         style: maptilersdk.MapStyle.STREETS,
            
         center: [20, 50], // starting position [lng, lat]
         zoom: 4, // starting zoom
            
       });
   </script>
 </body>
 </html>

Replace YOUR_MAPTILER_API_KEY_HERE with your own API key. Make sure to secure the key before you publish it.
The next is up to you. You can center your map wherever you desire (modifying the starting position) and set an appropriate zoom level (modifying the starting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating the source URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application.
Add event handler for map load event. You will add code to change disputed borders according to your map visitor’s location in this handler.
```
 map.on('load', async () => {
    
 });
```

Get the user’s IP country languages codes.


 map.on('load', async () => {
   const geolocationIP = await maptilersdk.geolocation.info();
   const {country_languages} = geolocationIP;
 });

Change the language of the map. In this example we will use the first language of the language array of the visitor’s country.


 map.on('load', async () => {
   const geolocationIP = await maptilersdk.geolocation.info();
   const {country_languages} = geolocationIP;
   map.setLanguage(`name:${country_languages[0]}`);
 });

Complete source code

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8" />
  <title>Change the map labels language based on visitor's location</title>
  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
  <script src="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.umd.min.js"></script>
  <link href="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css" rel="stylesheet" />
  <style>
    body { 
      margin: 0;
      padding: 0;
    }

    #map {
      position: absolute;
      top: 0;
      bottom: 0;
      width: 100%;
    }
  </style>
</head>
<body>
  <div id="map"></div>
  <script>
    maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
    const map = new maptilersdk.Map({
      container: 'map', // container's id or the HTML element to render the map
      style: maptilersdk.MapStyle.STREETS,
      center: [20, 50], // starting position [lng, lat]
      zoom: 4, // starting zoom
    });
    map.on('load', async () => {
      const geolocationIP = await maptilersdk.geolocation.info();
      const {country_languages} = geolocationIP;
      map.setLanguage(`name:${country_languages[0]}`);
    });
  </script>
</body>
</html>

Learn more

Check out the tutorials How to center map based on visitor’s location, How to display disputed borders based on visitor’s location and How to display the cookies consent bar according to the visitor’s location.

Visit the MapTiler Geolocation API reference for Geolocation response object properties. Like for example, the name of the country, the city, etc.

Visit the MapTiler Planet schema to know how it is organized into different thematic layers and which attributes and values each layer contains.

Learn more about Change language in a map

Check out the How to handle Right-to-Left Texts in Maps

Read Disputed borders on your maps

How to change the map labels language based on visitor’s location

NPM module setup

Basic JavaScript setup

Complete source code

Learn more

Set map language

Geocoding language

Change a map's language

Center map by visitor’s country IP

How to change the map labels language based on visitor’s location

NPM module setup

Basic JavaScript setup

Complete source code

Learn more

Related examples

Set map language

Geocoding language

Change a map's language

Center map by visitor’s country IP