From 3a79aa417a90fba76e32457323878219d5f12fbd Mon Sep 17 00:00:00 2001 From: grunghi Date: Fri, 15 Apr 2022 10:18:44 +0200 Subject: [PATCH] Add Nuxt 3 section to README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 863ffbf..8aa52c3 100644 --- a/README.md +++ b/README.md @@ -238,5 +238,33 @@ See [MapOptions](https://developers.google.com/maps/documentation/javascript/ref Many other components are also supported. Checkout [docs](https://vue-map.netlify.app) for more. +### Nuxt 3 usage + +First add `@fawmi/vue-google-maps` to `build.transpile` property in your `nuxt.config.ts`. + + ```ts +export default defineNuxtConfig({ + build: { + transpile: ['@fawmi/vue-google-maps'] + }, +}) + ``` + +Then create a plugin `~/plugin/vueGoogleMaps.ts`, you can store the API key in publicRuntimeConfig, checkout [nuxt docs](https://nuxtjs.org/docs/directory-structure/nuxt-config#runtimeconfig). + +```ts +import { defineNuxtPlugin } from '#app' +import VueGoogleMaps from '@fawmi/vue-google-maps' + +export default defineNuxtPlugin((nuxtApp) => { + nuxtApp.vueApp.use(VueGoogleMaps, { + load: { + key: nuxtApp.$config.googleApiKey, + }, + }) +}) +``` + + ## 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.