/gmap-vue

A wrapper component for consuming Google Maps API built on top of Vue. Fork of the popular vue-google-maps plugin.

Primary LanguageVue

GmapVue

Publish Documentation

A Vue plugin that wraps the Google Map API into different Vue components.

Documentation

You can find the documentation following the link.

Plugin dependencies

Name Version
vue npm version
@googlemaps/markerclusterer npm version
lodash.isEqual npm version
mitt npm version

Fork of vue2-google-maps

This is a fork of the popular vue2-google-maps. As the author of the library no longer commits to maintain the project, we forked it to develop and maintain the project.

Workspaces

This project uses pnpm workspaces to manage the plugin and documentation site. You will find the version of this plugin for Vue 2 on packages/v2 folder, the version for Vue 3 on the packages/v3 folder and the documentation on packages/documentation folder.

  • Clone the repository and run

    • pnpm

      pnpm install

  • To start the documentation site locally you can run the below command, it starts the documentation page on http://localhost:8080/

    pnpm run serve:docs

CONTRIBUTORS ARE WELCOME

If you have time to contribute to a rather frequently used library, feel free to make a PR!, but first please read our contributing guide.

What's urgently needed are:

  1. Better unit tests (we use Vitest).
  2. Better integration tests (we use Cypress)