# google-maps-icons

> A simple helper library that references all Google Maps Icons

Latest version **0.0.4** (published 2020-02-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install google-maps-icons
pnpm add google-maps-icons
yarn add google-maps-icons
bun add google-maps-icons
```

## 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.0.4 |
| Published | 2020-02-05 |
| First published | 2019-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 41.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Sven Gaubert |
| Maintainers | svengau |
| Keywords | google, google maps, maps, map, marker, pin, icons |

## Links

- npm: https://www.npmjs.com/package/google-maps-icons
- Repository: https://github.com/svengau/google-maps-icons
- Issues: https://github.com/svengau/google-maps-icons/issues
- npm.io page: https://npm.io/package/google-maps-icons

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2020-02-05
- 0.0.3 — 2019-12-17
- 0.0.2 — 2019-12-17
- 0.0.1 — 2019-12-17

## README

# Google Map Icons

[![npm version](https://badge.fury.io/js/google-maps-icons.svg)](https://badge.fury.io/js/google-maps-icons)

[DEMO SITE HERE](https://svengau.github.io/google-maps-icons/)

**Important note**: this project is not an official Google Project, and is provided "as is".

## Overview

This project provides all Google Map Icons, in a simple way.

### Installation

```
npm install google-maps-icons
```

or

```
yarn add google-maps-icons
```

### Usage

####Simple

```
import googleMapIcon, { CONSTELLATION_STAR } from "google-maps-icons";
const iconUrl = googleMapIcon(CONSTELLATION_STAR);
```

will return:

```
https://www.google.com/maps/vt/icon/name=assets/icons/poi/tactile/pinlet_shadow-1-small.png,assets/icons/poi/tactile/pinlet_outline_v2-1-small.png,assets/icons/poi/tactile/pinlet-1-small.png,assets/icons/poi/quantum/pinlet/constellation_star_pinlet-1-small.png&highlight=ff000000,ffffff,fbc02d,ffffff?scale=1
```

#### With options

```
import googleMapIcon from "google-maps-icons";
const options = {scale: 2, color: "800000"};
const iconUrl = googleMapIcon("parking", options);
```

will return:

```
https://www.google.com/maps/vt/icon/name=assets/icons/poi/tactile/pinlet_shadow-1-small.png,assets/icons/poi/tactile/pinlet_outline_v2-1-small.png,assets/icons/poi/tactile/pinlet-1-small.png,assets/icons/poi/quantum/pinlet/parking_pinlet-1-small.png&highlight=ff000000,ffffff,800000,ffffff?scale=2
```

### Argument & Options

Argument:

- **icon**: a valid string among the following ones:
  dot, nickname, heart, constellation_star, home, generic, gas, parking, car_rental, lodging, resort, bank_euro, bank_dollar, bank_jp, atm, bank_intl, hospital_H, hospital_shield, pharmacy, fire_jp, medical, tree, mountain, stadium, paw, camping, cemetery, golf, flower, hiking, boating, fishing, hotspring, airport, restaurant, bar, cafe, glass, shoppingbag, shoppingcart, palette, lighthouse, theater, camera, dice, dolphin, event_venue, ferriswheel, historic, historic_cn, museum, movie, monument, note, relic_jp, civic_bldg, postoffice, postoffice_jp, library, police, police_jp, school, school_cn_jp, bridge, restroom, city_office_jp, civil_office_jp, government_cn, worship_temple, worship_jewish, worship_mormon, worship_dharma, worship_buddhist, worship_hindu, worship_jain, worship_shinto, worship_sikh, worship_islam

Options:

- **scale**: Number, from 1 to 4. Default is 1.
- **color**: hexa color, without the hashtag. Default is the one provided by Google.

## Useful links

[[Blog Google] Google Maps gets a new look](https://www.blog.google/products/maps/google-maps-gets-new-look/)
[[Google Spreadsheets] Iconos de Google Maps](https://docs.google.com/spreadsheets/d/1YivKsYBr7pQ7R_VK2WPszc0CNakqlbT6zGeqCvuQRS8/edit#gid=0)

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