@maptiler/sdk 2.4.0 → 2.4.1

package/dist/src/Map.d.ts

@@ -28,11 +28,12 @@ export type MapOptions = Omit<MapOptionsML, "style" | "maplibreLogo"> & {
      */
     style?: ReferenceMapStyle | MapStyleVariant | StyleSpecification | string;
     /**
-     * Define the language of the map. This can be done directly with a language ISO code (eg. "en")
+     * Define the language of the map. This can be done directly with a language ISO code (eg. "en"),
+     * the ISO code prepended with the OSM flag (eg. "name:en" or even just "name"),
      * or with a built-in shorthand (eg. Language.ENGLISH).
      * Note that this is equivalent to setting the `config.primaryLanguage` and will overwrite it.
      */
-    language?: LanguageInfo;
+    language?: LanguageInfo | string;
     /**
      * Define the MapTiler Cloud API key to be used. This is strictly equivalent to setting
      * `config.apiKey` and will overwrite it.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "module": "dist/maptiler-sdk.mjs",
   "types": "dist/maptiler-sdk.d.ts",

package/readme.md

@@ -468,7 +468,7 @@ Whenever a label is not supported in the defined language, it falls back to `Lan
 Here is a sample of some compatible languages:
 ![](images/screenshots/multilang.gif)
 
-# Built-in support for right-to-left languages
+## Built-in support for right-to-left languages
 Languages that are written right-to-left such as Arabic and Hebrew are fully supported by default. No need to install any plugins!
 
 <p align="center">
@@ -476,6 +476,31 @@ Languages that are written right-to-left such as Arabic and Hebrew are fully sup
   <img src="images/screenshots/lang-hebrew.jpeg" width="48%"></img>
 </p>
 
+## Visitor language modes
+The *visitor* language modes are special built-in modes made to display labels in two different languages, concatenated when available:
+- `Language.VISITOR` concatenates labels in the language of your system and the *local* language
+- `Language.VISITOR_ENGLISH` concatenates labels in English and the *local* language
+
+```ts
+const map = new Map({
+  // some options...
+  language: Language.VISITOR,
+})
+
+// or
+
+const map = new Map({
+  // some options...
+  language: Language.VISITOR_ENGLISH,
+})
+```
+
+We believe these two modes can be very handy to help the end users identify places, especially when the local labels are not using a latin charset. Here is how it looks like:
+
+![](images/screenshots/visitor_athen.png)
+![](images/screenshots/visitor_osaka.png)
+
+
 # Custom Events and Map Lifecycle
 ## Events
 ### The `ready` event