Code Monkey home page Code Monkey logo

nuxt-leaflet-more's Introduction

Nuxt Leaflet

npm version npm downloads License Nuxt

A Nuxt 3 module to use Leaflet of https://www.npmjs.com/package/vue-leaflet-more. It was made using 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 3 without the need to configure anything.

Features

  • ⚡  No configuration needed
  • 🦺  Typescript support
  • 🚠  Auto import

Quick Setup

  1. Add nuxt3-leaflet dependency to your project
# Using pnpm
pnpm add -D nuxt3-leaflet

# Using yarn
yarn add --dev nuxt3-leaflet

# Using npm
npm install --save-dev nuxt3-leaflet
  1. Add nuxt3-leaflet to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["nuxt3-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 original Vue Leaflet library.

Please note that components are exported in PascalCase, so for example, write <LMap> instead of <l-map>.

Basic

<template>
  <div style="height:100vh; width:100vw">
    <LMap ref="map" :zoom="zoom" :center="[47.21322, -1.559482]">
      <LTileLayer
        url="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
        attribution='&amp;copy; <a href="https://www.openstreetmap.org/">OpenStreetMap</a> contributors'
        layer-type="base"
        name="OpenStreetMap"
      />
    </LMap>
  </div>
</template>

<script setup>
import { ref } from "vue";
const zoom = ref(6);
</script>

<style>
body {
  margin: 0;
}
</style>

Development

# 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

nuxt-leaflet-more's People

Contributors

luismanolo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.