Skip to content

Basemaps for MapLibre

The protomaps-themes-base NPM module contains basemap layer definitions compatible with OpenStreetMap downloads from Protomaps.

bash
npm install protomaps-themes-base
npm install protomaps-themes-base
js
import layers from 'protomaps-themes-base';
import layers from 'protomaps-themes-base';
js
style: {
    version:8,
    glyphs:'https://protomaps.github.io/basemaps-assets/fonts/{fontstack}/{range}.pbf',
    sources: {
        "protomaps": {
            type: "vector",
            url: "pmtiles://https://example.com/example.pmtiles",
            //       ^-- Remember to prefix the URL with pmtiles://
            attribution: '<a href="https://protomaps.com">Protomaps</a> © <a href="https://openstreetmap.org">OpenStreetMap</a>'
        }
    },
    layers: layers("protomaps","light")
}
style: {
    version:8,
    glyphs:'https://protomaps.github.io/basemaps-assets/fonts/{fontstack}/{range}.pbf',
    sources: {
        "protomaps": {
            type: "vector",
            url: "pmtiles://https://example.com/example.pmtiles",
            //       ^-- Remember to prefix the URL with pmtiles://
            attribution: '<a href="https://protomaps.com">Protomaps</a> © <a href="https://openstreetmap.org">OpenStreetMap</a>'
        }
    },
    layers: layers("protomaps","light")
}

the default export from protomaps-themes-base is a function that takes 2 arguments:

  • the source name of the basemap.

  • the theme, one of light, dark, white, black, grayscale or debug.

Fonts

The fonts referenced by the glyphs style key can be downloaded as a ZIP at the basemaps-assets GitHub repository.

Valid font names are: Noto Sans Regular, Noto Sans Medium, Noto Sans Italic

Prior to version 2.0.0-alpha.3, the Glyphs URL was https://cdn.protomaps.com/fonts/pbf/{fontstack}/{range}.pbf.

An open source mapping system released under the BSD and ODbL licenses.