https://github.com/dogchef-be/nuxt-maps
📍 NuxtJS module for Google Maps
https://github.com/dogchef-be/nuxt-maps
gmaps google-maps-api google-maps-javascript nuxt nuxt-module nuxtjs typescript-support
Last synced: 4 months ago
JSON representation
📍 NuxtJS module for Google Maps
- Host: GitHub
- URL: https://github.com/dogchef-be/nuxt-maps
- Owner: dogchef-be
- License: mit
- Created: 2020-11-16T18:41:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-26T18:11:38.000Z (almost 3 years ago)
- Last Synced: 2025-02-13T22:51:23.700Z (4 months ago)
- Topics: gmaps, google-maps-api, google-maps-javascript, nuxt, nuxt-module, nuxtjs, typescript-support
- Language: TypeScript
- Homepage:
- Size: 1.81 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
nuxt-maps
NuxtJS module for Google Maps
## Table of contents
- [Main features](#main-features)
- [Setup](#setup)
- [Options](#options)
- [Usage](#usage)
- [License](#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:
```bash
npm install nuxt-maps
```
2. Add `nuxt-maps` module and configuration to `nuxt.config.js`:
```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`:
```json
{
"compilerOptions": {
"types": ["nuxt-maps"]
}
}
```
## Options
### `apiKey`
- Type: `String`
Your Google API Key.
### `i18n`
- Type: `Boolean`
- Default: `false`
Enable [i18n-module](https://github.com/nuxt-community/i18n-module) integration.
## Usage
...
## License
See the LICENSE file for license rights and limitations (MIT).