# vue-map-card

> > An opinionated map component for Vue.

Latest version **0.0.1** (published 2023-12-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-map-card
pnpm add vue-map-card
yarn add vue-map-card
bun add vue-map-card
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-12-01 |
| First published | 2023-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 45.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | this-oliver |

## Links

- npm: https://www.npmjs.com/package/vue-map-card
- Repository: https://github.com/this-oliver/vue-map-card
- Issues: https://github.com/this-oliver/vue-map-card/issues
- npm.io page: https://npm.io/package/vue-map-card

## Recent versions

- 0.0.1 (latest) — 2023-12-01

## README

# Map-Card for Vue

> An opinionated map component for Vue.

## Preview

 > coming soon

## Introduction

`Vue Map-Card` is an opinionated map component for Vue.

## Installation

To start using the library, install it in your project:

```bash
pnpm install vue-map-card
or
yarn add vue-map-card
```

## Usage

### For Vue 3

```html
<!-- App.vue -->
<template>
  <MapCard 
    street="Andra Långgatan 5" 
    post="413 03"
    city="Gothenburg"
    country="Sweden" />
</template>

<script lang="ts" setup>
import { MapCard } from 'vue-map-card'
</script>
```

### For Nuxt 3

Define a nuxt plugin

```ts
// plugins/sonner.client.ts
import { VueMapCard } from 'vue-map-card'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.component('MapCard', MapCard)
})
```

Use `MapCard` component anywhere in the Vue SFC

```html
<!-- App.vue -->
<template>
  <MapCard 
    street="Andra Långgatan 5" 
    post="413 03"
    city="Gothenburg"
    country="Sweden" />
</template>

<script lang="ts" setup>
</script>
```

Add the build transpile for `vue-map-card`

```ts
// nuxt.config.ts
import { defineNuxtConfig } from 'nuxt/config'

export default defineNuxtConfig({
  ...
  build: {
    transpile: ['vue-map-card']
  }
})
```

### CDN Link

**EMS version**

```ts
https://cdn.jsdelivr.net/npm/vue-map-card/+esm
```

**UMD version**

```ts
https://www.unpkg.com/vue-map-card@0.0.1/lib/vue-map-card.umd.cjs
```

## Configuration

### Zoom

> it is possible to exceed the maximum zoom level of `50` but it is not recommended.

It is possible to set the zoom level of the map by passing the `zoom` prop. The default value is `15` but you can set it to any value between `1` and `50`.

```html
<!-- App.vue -->
<template>
  <MapCard 
    street="Andra Långgatan 5" 
    post="413 03"
    city="Gothenburg"
    country="Sweden"
    zoom="10"/>
</template>

<script lang="ts" setup>
import { MapCard } from 'vue-map-card'
</script>
```

## License

MIT [@this-oliver](https://github.com/this-oliver)

---
_Source: https://npm.io/package/vue-map-card · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._