# @talixo/maps

> UI Component which represents Map

Latest version **0.1.0** (published 2018-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @talixo/maps
pnpm add @talixo/maps
yarn add @talixo/maps
bun add @talixo/maps
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-05-02 |
| First published | 2018-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 37.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Public in Motion GmbH |
| Maintainers | michalochman, rangoo |

## Links

- npm: https://www.npmjs.com/package/@talixo/maps
- Repository: https://github.com/PublicInMotionGmbH/ui-kit
- Homepage: https://github.com/PublicInMotionGmbH/ui-kit#readme
- Issues: https://github.com/PublicInMotionGmbH/ui-kit/issues
- npm.io page: https://npm.io/package/@talixo/maps

## Recent versions

- 0.1.0 (latest) — 2018-05-02
- 1.0.0-alpha.35 (alpha) — 2018-12-09
- 1.0.0-alpha.31 — 2018-10-19
- 1.0.0-alpha.30 — 2018-10-02
- 1.0.0-alpha.27 — 2018-08-20
- 1.0.0-alpha.24 — 2018-08-13
- 1.0.0-alpha.20 — 2018-07-26
- 1.0.0-alpha.19 — 2018-07-26
- 1.0.0-alpha.16 — 2018-07-24
- 1.0.0-alpha.15 — 2018-07-16
- 1.0.0-alpha.14 — 2018-07-15
- 1.0.0-alpha.13 — 2018-07-15
- 1.0.0-alpha.12 — 2018-07-13
- 1.0.0-alpha.7 — 2018-07-10
- 1.0.0-alpha.6 — 2018-07-10
- … 3 more at https://npm.io/package/@talixo/maps/versions

## README

# Talixo map

UI Component which represents map

## How to install

Package is available as `@talixo/map` in NPM registry, so you can use it in your project
using `npm install @talixo/map --save` or `yarn add @talixo/map`.

## Requirements

Your package should additionally have some extra dependencies:

- `classnames: ^2.2.5`
- `prop-types: ^15.6.1`
- `react: ^16.2.0`
- `lodash: ^4.17.5`
- `react-google-maps: ^9.4.5`
- `recompose: ^0.26.0`
- `@talixo/shared: ^0.1.0`

These packages are required by `@talixo/map`, but you have to install them manually,
to avoid having different versions of these in your application.

## Supported props

### Maps

Property name | Type      | Required | Default | Description
--------------|-----------|----------|:-------:|----------------------------------------
className     | string    | no       | n/a     | additional class name passed to wrapper
apiKey        | string    | yes      | n/a     | your Api Key from GoogleMaps
zoom          | number    | no       | `6`     | zoom
center        | Location  | no       | n/a     | centered position
interactive   | boolean   | no       | `true`  | enable to move and zoom map

### Directions

Property name | Type                | Required | Default | Description
--------------|---------------------|----------|:-------:|------------------------------------------------
startPoint    | Location            | yes      | n/a     | start point of directions
endPoint      | Location            | yes      | n/a     | end point of directions
via           | Location|Location[] | no       | n/a     | either single waypoint or list of waypoints
onLoad        | function            | no       | n/a     | handler after successfully loaded directions
onError       | function            | no       | n/a     | handler after error while loading new directions

### Marker

Property name | Type      | Required | Default       | Description
--------------|-----------|----------|:-------------:|------------------------------------------------
position      | Location  | yes      | n/a           | start point of directions
info          | nodes     | no       | n/a           | info window content
open          | boolean   | no       | is controlled | should the info window be opened?
onClick       | function  | no       | n/a           | handler on click on marker
onClose       | function  | no       | n/a           | handler on click on close button in info window

## Property shapes

### Location

Property name | Type      | Required | Default       | Description
--------------|-----------|----------|:-------------:|------------------------------------------------
lat           | number    | yes      | n/a           | geo-point latitude
lng           | number    | yes      | n/a           | geo-point longitude

## Changelog

- **0.1.0** - initial version

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