@indoorequal/vue-maplibre-gl/README.md

Vue 3 plugin for maplibre-gl

# @indoorequal/vue-maplibre-gl

[![npm](https://img.shields.io/npm/v/@indoorequal/vue-maplibre-gl.svg?style=flat-square)](https://www.npmjs.com/package/@indoorequal/vue-maplibre-gl)
[![npm](https://img.shields.io/npm/dm/@indoorequal/vue-maplibre-gl?style=flat-square)](https://www.npmjs.com/package/@indoorequal/vue-maplibre-gl)
[![size](https://img.shields.io/bundlephobia/minzip/@indoorequal/vue-maplibre-gl?label=size&style=flat-square)](https://bundlephobia.com/package/@indoorequal/vue-maplibre-gl)
[![vue3](https://img.shields.io/badge/vue-3.x-brightgreen.svg?style=flat-square)](https://vuejs.org/)
[![MaplibreGL-JS](https://img.shields.io/badge/Maplibre%20GL%20JS-5.x-brightgreen?style=flat-square)](https://maplibre.org/projects/maplibre-gl-js/)
[![TypeScript](https://img.shields.io/badge/-TypeScript-informational?style=flat-square)](https://www.typescriptlang.org/)

A small Vue 3 plugin for [maplibre-gl-js](https://github.com/maplibre/maplibre-gl-js).

This is a fork of [vue-maplibre-gl](https://github.com/razorness/vue-maplibre-gl) with new features, non-core features removed, and support for MapLibre GL JS > v3.

## Features

- Supports MapLibre GL JS v5.x
- Typescript support
- Components for map, controls, sources, markers, popup and layers
- Support for custom controls
- Support for multiple instances and global access by `useMap(key: string | symbol)`
- Automatic restart on CONTEXT_LOST_WEBGL which can happen on mobile devices when tab was in background for longer time
- Small size


## Documentation

https://indoorequal.github.io/vue-maplibre-gl/

## PRs welcome ♥

If you have ideas, improvements, suggestions etc. don't hesitate to open a pull request.

## License

[MIT](http://opensource.org/licenses/MIT)