How to change the default map labels language

This tutorial shows how to change the default map labels language.

It explains the steps to change the language setting for the labels displayed on maps. By following these instructions, users can customize the language of map labels according to their preferences. This tutorial aims to assist users in personalizing their map experience by adjusting the language used for map labels.

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: [11.78, 43.35], // starting position [lng, lat]
   zoom: 3.51, // 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.

Change the map language to Japanese. By default, if nothing is specified, the SDK uses the language defined in the browser. This corresponds to maptilersdk.Language.AUTO. If we want to change the default language of the map we must indicate the language in the sdk config.


 maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
 maptilersdk.config.primaryLanguage = maptilersdk.Language.JAPANESE;
 const map = new maptilersdk.Map({
   container: 'map', // container's id or the HTML element in which MapLibre GL JS will render the map
   style: maptilersdk.MapStyle.STREETS,
   center: [11.78, 43.35], // starting position [lng, lat]
   zoom: 3.51, // starting zoom
 });

Reload the page. Now you should see the map with the Japanese labels.
Add event handler for map load event. You will add code to change the map language in this handler.
```
 map.on('load', async function() {
    
 });
```
Change the map language to French. The language generally depends on the style but we made it possible to easily update it with a single function and from a built-in list of languages.
```
 map.on('load', async function() {
   map.setLanguage(maptilersdk.Language.FRENCH); 
 });
```
Reload the page. Now you should see the map with the Frech labels.
Change the map language to Arabic. Languages that are written right-to-left such as arabic and hebrew are fully supported by default. No need to install any plugin!.
```
 map.on('load', async function() {
   map.setLanguage(maptilersdk.Language.ARABIC); 
 });
```
Reload the page. Now you should see the map with the Arabic labels.

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</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: [11.78, 43.35], // starting position [lng, lat]
         zoom: 3.51, // 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.


 maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
 maptilersdk.config.primaryLanguage = maptilersdk.Language.JAPANESE;
 const map = new maptilersdk.Map({
   container: 'map', // container's id or the HTML element in which MapLibre GL JS will render the map
   style: maptilersdk.MapStyle.STREETS,
   center: [11.78, 43.35], // starting position [lng, lat]
   zoom: 3.51, // starting zoom
 });

Reload the page. Now you should see the map with the Japanese labels.
Add event handler for map load event. You will add code to change the map language in this handler.
```
 map.on('load', async function() {
    
 });
```
Change the map language to French. The language generally depends on the style but we made it possible to easily update it with a single function and from a built-in list of languages.
```
 map.on('load', async function() {
   map.setLanguage(maptilersdk.Language.FRENCH); 
 });
```
Reload the page. Now you should see the map with the Frech labels.
Change the map language to Arabic. Languages that are written right-to-left such as arabic and hebrew are fully supported by default. No need to install any plugin!.
```
 map.on('load', async function() {
   map.setLanguage(maptilersdk.Language.ARABIC); 
 });
```
Reload the page. Now you should see the map with the Arabic labels.

Complete source code

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8" />
  <title>Change the map labels language</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';
    maptilersdk.config.primaryLanguage = maptilersdk.Language.JAPANESE;
    const map = new maptilersdk.Map({
      container: 'map', // container's id or the HTML element to render the map
      style: maptilersdk.MapStyle.STREETS,
      center: [11.78, 43.35], // starting position [lng, lat]
      zoom: 3.51, // starting zoom
    });
    map.on('load', async function() {
      map.setLanguage(maptilersdk.Language.ARABIC);   
    });
  </script>
</body>

</html>

Learn more

Check out the tutorials How to change the map labels language based on visitor’s location and Display and style rich text labels to learn how to change the map labels language.

How to change the default map labels language

NPM module setup

Basic JavaScript setup

Complete source code

Learn more

Map language by IP

Geocoding language

Display and style rich text labels

Change a map's language

How to change the default map labels language

NPM module setup

Basic JavaScript setup

Complete source code

Learn more

Related examples

Map language by IP

Geocoding language

Display and style rich text labels

Change a map's language