Mapbox GL JS plugin for switching map language to the browser language.
npm install @mapbox/mapbox-gl-languageAdds support for switching the language of your map style in Mapbox GL JS maps.
Requires mapbox-gl-js. For other platforms, such as Android and iOS, see this help document.
!Multiple language supported with style transforms
Automatic style transformations for different languages
!Switch language based on user agent
Switch language based on user agent
mapbox-gl-language is a Mapbox GL JS plugin that you can easily add on top of your map.
When using a CDN
When using modules
Check how to use Mapbox GL JS in a module bundler.
``bash`
npm install --save mapbox-gl @mapbox/mapbox-gl-language
`javascript`
import mapboxgl from 'mapbox-gl';
import MapboxLanguage from '@mapbox/mapbox-gl-language';
Example
`javascript
mapboxgl.accessToken = 'YOUR_ACCESS_TOKEN';
const map = new mapboxgl.Map({
container: 'map',
style: 'mapbox://styles/mapbox/streets-v10',
center: [-77.0259, 38.9010],
zoom: 9
});
// Add RTL support if you want to support Arabic
// mapboxgl.setRTLTextPlugin('https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-rtl-text/v0.10.1/mapbox-gl-rtl-text.js');
const language = new MapboxLanguage();
map.addControl(language);
`
Check examples/ for more usage examples.
#### Table of Contents
* MapboxLanguage
* Parameters
* setLanguage
* Parameters
Create a new Mapbox GL JS plugin that
modifies the layers of the map style to use the text-field that matches the browser language.{name}
As of Mapbox GL Language v1.0.0, this plugin no longer supports token values (e.g. ). v1.0+ expects the text-field
property of a style to use an expression of the form or ['get', 'name']; these expressions can be nested. Note that get expressions used as inputs to other expressions may not be handled by this plugin. For example:
["match",
["get", "name"],
"California",
"Golden State",
["coalesce",
["get", "name_en"],
["get", "name"]
]
]
Only styles based on Mapbox v8 styles are supported.
#### Parameters
* options object Options to configure the plugin.
* options.supportedLanguages Array<string>? List of supported languagesoptions.languageTransform
* Function? Custom style transformation to applyoptions.languageField
* RegExp RegExp to match if a text-field is a language field (optional, default /^name_/)options.getLanguageField
* Function? Given a language choose the field in the vector tilesoptions.languageSource
* string? Name of the source that contains the different languages.options.defaultLanguage
* string? Name of the default language to initialize style after loading.options.excludedLayerIds
* Array<string>? Name of the layers that should be excluded from translation.
#### setLanguage
Explicitly change the language for a style.
##### Parameters
* style object Mapbox GL style to modifylanguage
* string The language iso code
Returns object the modified style
Run the linter and watch for changes to rebuild with browserify.
npm install
npm run test
Showcasing the languages supported by Mapbox Streets.
* Your Browser language
* Arabic
* Chinese Simplified
* Chinese Traditional
* English
* French
* German
* Italian
* Japanese
* Korean
* Multilingual
* Portuguese
* Russian
* Spanish
* Vietnamese
You can configure the plugin to support your own custom style using style transforms and custom language fields.
By default, this plugin works best with official Mapbox styles or styles derived from official Mapbox styles.
The styles must be based on Mapbox v8 styles:
* mapbox://styles/mapbox/streets-v11
*
*
*
*
*
*