# leaflet.marker.highlight
Highlight effects for L.marker.

## Demo

[DEMO](https://brandonxiang.github.io/leaflet.marker.highlight/examples/)


## Installation

```
npm install leaflet.marker.highlight --save
```

## Usage

### Temporarily Highlight

Highlight effects will occur in the situation that you put your mouse over the marker.

You can set it when initializing a marker. 

```
var marker1 = L.marker([51.5, -0.09], {highlight: 'temporary'}).addTo(map);
```

Or you can use a method to enable the highlight effects.

```
marker1.enableTemporaryHighlight();
```

```
marker1.disableTemporaryHighlight();
```


### Permanently Highlight

Highlight effects are always on.

```
var marker1 = L.marker([51.5, -0.09], {highlight: true}).addTo(map);
```

or

```
marker1.enableHighlight();
```

Cancel the marker highlight effects by 

```
marker1.disableHighlight();
```

## License

[MIT](LICENSE)


## Chinese Version

[README](README_CN.md)