README.md

nuxt-maps

NuxtJS module for Google Maps

Table of contents

• Main features
• Setup
• Options
• Usage
• License

Main features

• Load Google Maps JavaScript API script only when required (once $gmaps() is called)
• TypeScript support

Setup

1. Add nuxt-maps dependency to your project:

npm install nuxt-maps

2. Add nuxt-maps module and configuration to nuxt.config.js:

export default {
  // ...other config options
  modules: ["nuxt-maps"];
  maps: {
    apiKey: 'XXXXXXXXXXXXXXXXX',
  }
}

3. (Optional) TypeScript support. Add nuxt-maps to the types section of tsconfig.json:

{
  "compilerOptions": {
    "types": ["nuxt-maps"]
  }
}

Options

apiKey

• Type: String

Your Google API Key.

i18n

• Type: Boolean
• Default: false

Enable i18n-module integration.

Usage

...

License

See the LICENSE file for license rights and limitations (MIT).