svelte-maplibre logo

Svelte wrapper for the maplibre mapping library.

--- This library is functional, but I'm still experimenting with extra features to make advanced functionality easier to use. It also needs proper documentation. In the meantime, the [demo site](https://svelte-maplibre.vercel.app) includes code for all the examples, and is a good place to start. [Changelog](./CHANGELOG.md) ## Installation ``` npm install svelte-maplibre ``` ## Usage If you use Vite, import the MapLibre worker URL and set it before you create the first map: ```js import * as maplibregl from 'maplibre-gl'; import maplibreWorkerUrl from 'maplibre-gl/dist/maplibre-gl-worker.mjs?worker&url'; maplibregl.setWorkerUrl(maplibreWorkerUrl); ``` The `?worker&url` import tells Vite to emit the worker as an asset. Call `setWorkerUrl` in the page component that creates the map or anything else that loads before the map. ```svelte ``` ### Other bundlers If using other bundlers, see [the MapLibre installation instructions](https://maplibre.org/maplibre-gl-js/docs/#installation) for details on configuring the worker. ## Developing You should create a `.env` file to configure the environment. See the `.env.example` file for the necessary settings. Currently the only environment variable is a MapTiler API key, required for the 3D Buildings example. If you don't have one, you can set this to a blank value to use the other examples. ## Credits Logo created by [Bruce Wayyn](https://github.com/brucewayyn) [Release instructions](https://github.com/dimfeld/svelte-maplibre/blob/master/RELEASING.md)