# yardmapper

> Yardmapper is a react module that allows users to map lawn area polygons or enter lawn size manually. uses google maps api, react-google-maps, material-ui with a lottie as an instructional dialog.

Latest version **1.2.4** (published 2020-03-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install yardmapper
pnpm add yardmapper
yarn add yardmapper
bun add yardmapper
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2020-03-19 |
| First published | 2019-12-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Paige |
| Maintainers | guyinthehat, jaycholland, smuller |

## Links

- npm: https://www.npmjs.com/package/yardmapper
- Repository: https://github.com/rachio/yardmapper
- Homepage: https://github.com/rachio/yardmapper#readme
- Issues: https://github.com/rachio/yardmapper/issues
- npm.io page: https://npm.io/package/yardmapper

## Dependencies (6)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [react-lottie](https://npm.io/package/react-lottie.md) ^1.2.3
- [convert-units](https://npm.io/package/convert-units.md) ^2.3.4
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^3.3.2
- [react-google-maps](https://npm.io/package/react-google-maps.md) ^9.4.5
- [@material-ui/styles](https://npm.io/package/@material-ui/styles.md) ^4.3.0

## Recent versions

- 1.2.4 (latest) — 2020-03-19
- 1.2.3 — 2020-03-19
- 1.2.2 — 2020-03-19
- 1.2.1 — 2020-03-19
- 1.2.0 — 2020-03-18
- 1.1.1 — 2020-03-02
- 1.1.0 — 2019-12-22
- 1.0.15 — 2019-12-22
- 1.0.14 — 2019-12-22
- 1.0.13 — 2019-12-22
- 1.0.12 — 2019-12-22
- 1.0.11 — 2019-12-22
- 1.0.10 — 2019-12-20
- 1.0.9 — 2019-12-20
- 1.0.8 — 2019-12-20
- … 8 more at https://npm.io/package/yardmapper/versions

## README

# yardmapper

Yardmapper is a react module that allows users to map lawn area polygons or enter lawn size manually. uses google maps api, react-google-maps, material-ui with a lottie as an instructional dialog.

## How to use
You can install this directly in your project with npm
`npm i yardmapper`

### Repo
This project can also be found / forked on [github](https://github.com/Rachio/yardmapper)


## Props

Yardmapper component props

|PROP                |REQ                          |TYPE   |  DESCRIPTION                    |
|----------------|--------------------|-----------------------------|-----------|
|`center`|yes |*Object* |``` {lat: number, lng: number}``` - Map initial center geo point
|`isMetric` |no  |*boolean* |To use metric units - default *false*
|`maxSize`|yes |*number*| in square feet, unless isMetric is true
|`googleMapsApiKey`|yes|*string*|Google Maps API key
|`onComplete`|yes|*function* | callback function called upon successful completion of mapping process. Will be called with `onCompleteEvent` object (see below)


### onCompleteEvent

Upon successful completion of yard mapping process the onComplete function will be called with the resulting object:
```
{
	isMetric: boolean,
	size: number,
	polygons: Array<features>,
	manuallyEntered: boolean
}
```
> **Note:** it is possible that the user will draw polygons and then manually enter their yard size, in this case the polygons drawn will still be included in the event and the `manuallyEntered` value will be true.

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