# sleipner-map-ye5

> This is a Map component of React

Latest version **0.0.3** (published 2018-07-03) · sleipner-maritime license · 0 weekly downloads

## Install

```sh
npm install sleipner-map-ye5
pnpm add sleipner-map-ye5
yarn add sleipner-map-ye5
bun add sleipner-map-ye5
```

## 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.3 |
| Published | 2018-07-03 |
| First published | 2018-07-03 |
| Weekly downloads | 0 |
| License | sleipner-maritime |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 57.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ye Song |
| Maintainers | yesong |

## Links

- npm: https://www.npmjs.com/package/sleipner-map-ye5
- Repository: https://nara007@bitbucket.org/sleipner/sleipner-map
- Homepage: https://bitbucket.org/sleipner/sleipner-map#readme
- npm.io page: https://npm.io/package/sleipner-map-ye5

## Dependencies (11)

- [react](https://npm.io/package/react.md) ^16.3.2
- [deck.gl](https://npm.io/package/deck.gl.md) ^5.3.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.3.2
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.1
- [react-map-gl](https://npm.io/package/react-map-gl.md) ^3.2.7
- [mdi-material-ui](https://npm.io/package/mdi-material-ui.md) ^5.1.1
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^1.3.1
- [react-window-size](https://npm.io/package/react-window-size.md) ^1.2.0
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^1.1.0
- [react-country-flag](https://npm.io/package/react-country-flag.md) ^0.2.0
- [@sleipner/sleipner-country-code](https://npm.io/package/@sleipner/sleipner-country-code.md) latest

## Recent versions

- 0.0.3 (latest) — 2018-07-03

## README

### @sleipner/sleipner-map
Map Component of React


### Publish the Map Component to NPM Repository @sleipner
```sh
$ cd PROJECT_FOLDER
$ npm run build
$ npm publish 
```
**Tip**: make sure the component is not published yet, otherwise it must be unpublished, so that it can be republished. User who publishes the component must be a member from organization '@sleipner' and log in first.
**npm unpublish @sleipner/sleipner-map -f**


### Installation
```sh
$ npm install @sleipner/sleipner-map
```
**Tip**: make sure that you have already logged in NPM and must be a member of '@sleipner' or the private package can't be installed.

### Usage
```sh
import Map from '@sleipner/sleipner-map';
                
<Map width={100}
     height={200}
     vessels={vessels} 
     mapStyle={style}
     hasNavigationCtrl={false}
     subComponents={subComponents}
     marginBottom={20}
/>   
```
**width, height, longitude, latitude, zoom** can be passed to Map component as properties, or they will have a default value.
Property **vessel** receives an array which contains GeoJSON features of vessels.
Property **mapStyle** receives a style from outsides, e.g.:
```sh
import ms1 from './mda-map-style.json';
import {fromJS} from 'immutable';
const style = fromJS(ms1);
```

Property **hasNavigationCtrl** receives an boolean which indicates whether a navigation control will be created on the map. By default, this flag is **true**

Property **subComponents** receives an array which contains subcomponents,e.g. :
```sh
const headerComponent = (<div>header</div>);
const basePanelComponent = (<BasePanel>basePanel</BasePanel>);
const subComponents = [headerComponent, basePanelComponent];
```

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