https://github.com/nuxt-modules/leaflet
A Nuxt module to use Leaflet
https://github.com/nuxt-modules/leaflet
Last synced: 5 months ago
JSON representation
A Nuxt module to use Leaflet
- Host: GitHub
- URL: https://github.com/nuxt-modules/leaflet
- Owner: nuxt-modules
- License: apache-2.0
- Created: 2023-06-24T15:31:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T23:26:18.000Z (5 months ago)
- Last Synced: 2024-12-01T07:05:33.243Z (5 months ago)
- Language: Vue
- Homepage: https://leaflet.nuxtjs.org/
- Size: 2.21 MB
- Stars: 125
- Watchers: 1
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://leaflet.nuxtjs.org)
# Nuxt Leaflet
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
A Nuxt module to use Leaflet.
It was made using [Vue Leaflet](https://github.com/vue-leaflet/vue-leaflet) which is a Vue 3 wrapper for Leaflet, that exposes the original Leaflet API as Vue components.
This module is really just about making it work with Nuxt without the need to configure anything.
- [✨ Release Notes](/CHANGELOG.md)
- [📖 Documentation](https://leaflet.nuxtjs.org)
## Features
- ⚡ No configuration needed
- 🦺 Typescript support
- 🚠 Auto import
## Quick Setup
```bash
npx nuxi@latest module add @nuxtjs/leaflet
```
That's it! You can now use Leaflet in your Nuxt app ✨
## Usage
For a complete list of the components available, check out the [official documentation](https://leaflet.nuxtjs.org/components/introduction.html) library.
### Basic
```vue
import { ref } from 'vue'
const zoom = ref(6)
```
## Development
```bash
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Release new version
npm run release
```
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/leaflet/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://www.npmjs.com/package/@nuxtjs/leaflet
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/leaflet.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://www.npmjs.com/package/@nuxtjs/leaflet
[license-src]: https://img.shields.io/npm/l/@nuxtjs/leaflet.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://www.npmjs.com/package/@nuxtjs/leaflet
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com