JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 470
  • Score
    100M100P100Q99173F
  • License MIT

Vue 3 plugin for maplibre-gl

Package Exports

  • vue-maplibre-gl

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-maplibre-gl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vue-maplibre-gl

npm TypeScript vue2

A vue plugin for maplibre-gl-js. Only additional dependency is mitt.

Size: 36 KB

Features

  • Typescript support
  • Components for map, controls, sources, marker and layers
  • Support for custom controls
  • Customizable style switch which reloads sources and layers automatically
  • Frame rate control included
  • Support for multiple instances and global access by useMap(key: string | symbol)

Table of contents

Installation

yarn add vue-maplibre-gl maplibre-gl

Default import

Global Install:

import VueMaplibreGl from 'vue-maplibre-gl'

app.use(VueMaplibreGl)

Add SCSS:

@import "~vue-maplibre-gl/src/css/maplibre";

Use specific components:

import { MglMap } from 'vue-maplibre-gl'

app.component('MglMap', MglMap)

or in a parent components .vue file

<script>
    import { MglMap } from 'vue-maplibre-gl'

    export default {
        components: {
            MglMap
        },
        // ...
    }
</script>

Usage

See /dev/serve.vue for a real world example.

Demo

git clone https://github.com/razorness/vue-maplibre-gl.git
cd vue-maplibre-gl
yarn
yarn serve

PRs welcome ♥

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

Todos

  • Generate separate css file to be included (currently, you have to use scss)
  • Usage examples
  • Demo
  • API documentation
  • Support v-model:... for some basic props
  • Add layer events
  • Add Web-types
  • Add frame rate control

License

MIT