# @ansur/leaflet-pulse-icon

> A pulsing icon plugin.

Latest version **0.1.1** (published 2018-09-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ansur/leaflet-pulse-icon
pnpm add @ansur/leaflet-pulse-icon
yarn add @ansur/leaflet-pulse-icon
bun add @ansur/leaflet-pulse-icon
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-09-24 |
| First published | 2018-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Filip Zavadil |
| Maintainers | christofferthondrup |
| Keywords | icon, map, marker, leaflet |

## Links

- npm: https://www.npmjs.com/package/@ansur/leaflet-pulse-icon
- Repository: https://github.com/therealice/leaflet-icon-pulse
- Homepage: https://github.com/therealice/leaflet-icon-pulse#readme
- Issues: https://github.com/therealice/leaflet-icon-pulse/issues
- npm.io page: https://npm.io/package/@ansur/leaflet-pulse-icon

## Dependencies (1)

- [leaflet](https://npm.io/package/leaflet.md) >=0.7.3

## 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.1.1 (latest) — 2018-09-24

## README

leaflet-pulse-icon
=====================
<div style="text-align:center" align="center">
  <img src="http://mapshakers.github.io/projects/leaflet-pulse-icon/leaflet-pulsing-icon.gif" alt="leaflet-pulse-icon" />
</div>

A very simple [Leaflet](http://leafletjs.com) plugin provides pulsing icon.

*Requires Leaflet 0.7.0 or newer and modern browser*

## Demo
[Check out demo!](http://mapshakers.github.io/projects/leaflet-pulse-icon)
## Using the plugin
#### Install
`npm install @ansur/leaflet-pulse-icon` </br>
or clone repo & run `npm install` </br>
or copy files from releases 

#### Use
Include the CSS and JavaScript files located in ```\dist``` directory.
```html
<script src="../L.Icon.Pulse.js" />
<link rel="stylesheet" href="../L.Icon.Pulse.css" />
```

### Usage
Create a new L.Icon.Pulse

```javascript
var pulsingIcon = L.icon.pulse({iconSize:[20,20],color:'red'});
var marker = L.marker([50,15],{icon: pulsingIcon}).addTo(map);
```
### Options
| Property        | Description            | Default Value | Possible  values         |
| --------------- | ---------------------- | ------------- | ------------------------ |
| color           | color of icon          | 'red'         | any CSS color            |
| iconSize        | size of L.divIcon      | [12,12]       | <Point> [width,height]   |
| animate         | enable pulsing         | true          | true\|false            |
| heartbeat       | pulsing beat           | 1             | number (seconds)         |

## License
**leaflet-pulse-icon** is free software, and may be redistributed under the MIT-LICENSE.

---
_Source: https://npm.io/package/@ansur/leaflet-pulse-icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._