# osagai-map

> Google maps web component with Osagai

Latest version **0.3.0** (published 2019-03-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install osagai-map
pnpm add osagai-map
yarn add osagai-map
bun add osagai-map
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2019-03-17 |
| First published | 2019-03-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 197.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | henriquelimas |
| Keywords | webcomponents, osagai, google-maps, maps |

## Links

- npm: https://www.npmjs.com/package/osagai-map
- Repository: https://github.com/HenriqueLimas/osagai-map
- Issues: https://github.com/HenriqueLimas/osagai-map/issues
- npm.io page: https://npm.io/package/osagai-map

## Dependencies (1)

- [osagai](https://npm.io/package/osagai.md) ^0.3.2

## Recent versions

- 0.3.0 (latest) — 2019-03-17
- 0.2.0 — 2019-03-10
- 0.1.1 — 2019-03-10
- 0.1.0 — 2019-03-09

## README

# osagai-map

🀄️🌎Google maps web component with Osagai

Web component for using google maps implemented with Osagai

## Install

```sh
npm install osagai-map
```

Or import from unpkg

```html
<script type="module" src="https://unpkg.com/osagai-map/dist/osagai-map.mjs"></script>
```

## Usage

```html
<osagai-map
  api-key="<GOOGLE_MAPS_API_KEY>"
  latitude="37.4029937"
  longitude="-122.1811813"
  zoom="13">
    <osagai-map-marker latitude="37.4029937" longitude="-122.1811813">
      Hello, I am a marker
    </osagai-map-marker>
</osagai-map>
```

* * *

## API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

#### Table of Contents

-   [osagai-map](#osagai-map)
    -   [Parameters](#parameters)
-   [osagai-map-marker](#osagai-map-marker)
    -   [Parameters](#parameters-1)

### osagai-map

Custom element for rendering a map using [Google Maps API](https://developers.google.com/maps/documentation/)

#### Parameters

-   `api-key` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** API key to be used on Google Maps. [Get API Key docs](https://developers.google.com/maps/documentation/javascript/get-api-key)
-   `version` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the Google Maps API (optional, default `3.34`)
-   `libraries` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Libraries to use on the Google Maps API, separated by "," (optional, default `drawing,geometry,places,visualization`)
-   `latitude` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Latitude to show in the map
-   `longitude` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Longitude to show in the map
-   `zoom` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Zoom to use in the map (optional, default `undefined`)
-   `no-auto-tilt` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Don't use a tilt (optional, default `false`)
-   `map-type` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Type of the map to use (roadmap|satellite|hybrid|terrain). [mapTypes docs](https://developers.google.com/maps/documentation/javascript/maptypes)
-   `disable-default-ui` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Disable default UIs (optional, default `false`)
-   `disable-map-type-control` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Disable the map type controls (optional, default `false`)
-   `disable-street-view-control` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Disable the street-view controls (optional, default `false`)
-   `disable-zoom` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Disable zoom capabilities (Double click and scroll whell) (optional, default `false`)
-   `max-zoom` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Max zoom allowed (optional, default `undefined`)
-   `min-zoom` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Min zoom allowed (optional, default `undefined`)

### osagai-map-marker

Custom element for rendering a marker in a Google map. [Marker documentation](https://developers.google.com/maps/documentation/javascript/markers)

#### Parameters

-   `latitude` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Latitude to show in the map
-   `longitude` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Longitude to show in the map
-   `title` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Title of the marker that will appear as a tooltip (optional, default `undefined`)
-   `animation` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Animation to exhibit dynamic movement to the marker. Values supported from google maps api. [Animate marker docs](https://developers.google.com/maps/documentation/javascript/markers#animate) (optional, default `undefined`)
-   `hidden` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Hide the marker (optional, default `false`)
-   `label` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** A marker label that appear inside a marker (optional, default `undefined`)

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