diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..0232d6b --- /dev/null +++ b/readme.md @@ -0,0 +1,189 @@ +# Google maps Components for Vue.js 3 + +Set of mostly used Google Maps components for Vue.js. + +#### Why this library exists? +We heavily use Google Maps in our projects, so I wanted to have a well maintained Google Maps library. + +## Documentation +Checkout https://vue-map.netlify.app for a detailed documentation + +## Installation +You can install it using npm +``` +npm install -S @fawmi/vue-google-maps +``` + +## Basic usage +You need an API Key. Learn how to [get an Api key ](https://developers.google.com/maps/documentation/javascript/get-api-key). + +##Configure Vue to use the Components + +In your `main.js` or inside a Nuxt plugin: + +```js +import { createApp } from 'vue' +import * as VueGoogleMaps from '@fawmi/vue-google-maps' + +const app = createApp(App); +app.use(VueGoogleMaps, { + load: { + key: 'YOUR_API_KEY_COMES_HERE', + }, +}).mount('#app') + +``` +## Use it anywhere in your components + +```vue + + + +``` + +### Markers + +If you need to gain access to the `Map` instance (e.g. to call `panToBounds`, `panTo`): +```vue + + +``` +### Map options +You can pass Map options using options property: + +See [MapOptions](https://developers.google.com/maps/documentation/javascript/reference/map#MapOptions) for a complete list of available options. + ```vue + + +``` + +Add region and language localization: + +Example for [Localization](https://developers.google.com/maps/documentation/javascript/localization): +```vue +Vue.use(VueGoogleMaps, { + load: { + region: 'VI', + language: 'vi', + }, +}) +``` + +## Contributions +The best way to contribute is to report reproducible bugs, but feature requests and improvement suggestions are always welcome too. And definitely bug fixes and PR are welcome.