# leaflet-focusmarker

> Focus marker for Leaflet library

Latest version **0.0.2** (published 2016-04-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install leaflet-focusmarker
pnpm add leaflet-focusmarker
yarn add leaflet-focusmarker
bun add leaflet-focusmarker
```

## 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.0.2 |
| Published | 2016-04-05 |
| First published | 2016-04-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Sasha Kavun |
| Maintainers | sashakavun |
| Keywords | leaflet, map, marker |

## Links

- npm: https://www.npmjs.com/package/leaflet-focusmarker
- Repository: https://github.com/sashakavun/leaflet-focusmarker
- Homepage: https://github.com/sashakavun/leaflet-focusmarker#readme
- Issues: https://github.com/sashakavun/leaflet-focusmarker/issues
- npm.io page: https://npm.io/package/leaflet-focusmarker

## Recent versions

- 0.0.2 (latest) — 2016-04-05

## README

L.FocusMarker
=============

Shrinking circle marker plugin for Leaflet.

A simple marker for use when you want to draw the user's attention at some place on the map.

Check out the [example](http://sashakavun.github.io/leaflet-focusmarker/example.html).

Browser Support
---------------

Plugin is tested and approved to work in the following browsers:

* Chrome 29+
* Firefox 23+
* Internet Explorer 6+
* Opera 12.16, 16+
* Safari 5.1.16 (Windows)

Usage
-----

Add marker to the map:

```js
var map = L.map("map");
var latlng = [ 45.033, 38.967 ];
L.focusMarker(latlng).addTo(map);
```

Marker will remove itself from map automatically after disappearing.

If you do not want marker to be auto-removed, set `dispose` option to `false`:

```js
var map = L.map("map");
var latlng1 = [ 51.505, -0.09 ];
var latlng2 = [ 45.033, 38.967 ];
var focus = L.focusMarker(latlng1, { "dispose": false });
focus.addTo(map);

// some lines below:
focus.setLatLng(latlng2);
```

Marker will show again when its coordinates changed or on `show()` method call.

Marker fires `animationend` event after disappearing.


Development
-----------

Project requires `npm` for development environment.

To set up, run following command in the project's directory:

```
npm install
```

To build minified file, run `build` Grunt task in the project's directory:

```
grunt build
```

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