# leaflet.infobutton

> A button for display information in the leaflet map

Latest version **1.2.0** (published 2020-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install leaflet.infobutton
pnpm add leaflet.infobutton
yarn add leaflet.infobutton
bun add leaflet.infobutton
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-04-22 |
| First published | 2020-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Abel Delgado |
| Maintainers | abeldf_94 |

## Links

- npm: https://www.npmjs.com/package/leaflet.infobutton
- npm.io page: https://npm.io/package/leaflet.infobutton

## Recent versions

- 1.2.0 (latest) — 2020-04-22
- 1.1.0 — 2020-04-21
- 1.0.1 — 2020-04-20
- 1.0.0 — 2020-04-20

## README

# Leaflet.infoButton
Leaflet.infoButton is a [Leaflet](https://github.com/Leaflet/Leaflet) plugin that provides a highly css-customizable popup box on the map.

The code is a modified version of the [Leaflet.infoButton](https://github.com/Eclipse1979/Leaflet.infoButton) made by [Eclipse1979](https://github.com/Eclipse1979)

## Usage: 
You can install this plugin via npm:
```
npm i leaflet.infobutton
```
After install, you can import and use:
```
import 'leaflet.infoButton/dist/leaflet.infoButton';
...
L.control.infoButton({
  buttonTittle: "I'm a button, press me!",
  title: "<h1>This text is customizable</h1>",
  position: "bottomleft",
  html: "This text is customizable too. <p>I'm a paragraph inside HTML &lt;p&gt; tag</p>"
}).addTo(map);
```

## Options:
- `title:` title of the popup box, default is `About`
- `buttonTittle:` title of the popup box, default is `<h1>Title</h1>`
- `html:` html content of the popup, default is `<p>This map was generated by Leaflet.</p>`
- `show:` wether the popup should activate at the beginning, default is `false`
- `minWidth:` allows you to hide the map interface on mobile devices by setting a minimum screen size, default is `500`
- It also support the same options as those of [Control](http://leafletjs.com/reference.html#control) such as position.

## License:
This project is under the MIT license

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