Skip to content

Update docs for protomaps-leaflet #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdon merged 1 commit into from
Apr 4, 2025
Merged

Update docs for protomaps-leaflet #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions basemaps/leaflet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,23 @@ outline: deep
The simplest way to include a map in your application via script includes tag:

```js
<script src="https://unpkg.com/protomaps-leaflet@latest/dist/protomaps-leaflet.js"></script>
<script src="https://unpkg.com/protomaps-leaflet@5.0.0/dist/protomaps-leaflet.js"></script>
<script>
const map = L.map('map')
var layer = protomapsL.leafletLayer({url:'FILE.pmtiles OR ENDPOINT/{z}/{x}/{y}.mvt', theme: 'light'})
var layer = protomapsL.leafletLayer({url:'FILE.pmtiles OR ENDPOINT/{z}/{x}/{y}.mvt', flavor: 'light', lang: 'en'})
layer.addTo(map)
</script>
```

## Themes
To use with a bundler:

The `theme` option must be one of `light`, `dark`, `white`, `grayscale`, `black`.
```
npm add protomaps-leaflet
```

## Customization

The `flavor` option must be one of `light`, `dark`, `white`, `grayscale`, `black`.

This will assume the set of basemap layers described at [Basemap Layers](/basemaps/layers).
The `lang` option can be one of the [supported languages](/basemaps/localization).