# react-jvectormap-fr

> A jvectormap wrapper for React apps

Latest version **0.0.4** (published 2018-07-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-jvectormap-fr
pnpm add react-jvectormap-fr
yarn add react-jvectormap-fr
bun add react-jvectormap-fr
```

## 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.4 |
| Published | 2018-07-04 |
| First published | 2018-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 565.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | jbpasquier |

## Links

- npm: https://www.npmjs.com/package/react-jvectormap-fr
- Repository: https://github.com/JbPasquier/react-jvectormap-fr
- Issues: https://github.com/JbPasquier/react-jvectormap-fr/issues
- npm.io page: https://npm.io/package/react-jvectormap-fr

## Dependencies (4)

- [jquery](https://npm.io/package/jquery.md) ^3.2.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [jvectormap-next](https://npm.io/package/jvectormap-next.md) ^3.0.0
- [jquery-mousewheel](https://npm.io/package/jquery-mousewheel.md) ^3.1.13

## Recent versions

- 0.0.4 (latest) — 2018-07-04
- 0.0.3 — 2018-07-04

## README

# React jvectormap fr

## About

A simple wrapper for [jvectormap](http://jvectormap.com/)

Please feel free to contribute, open issues or just enjoy this library!

## Gettings started

Install the library:

    npm install --save react-jvectormap-fr

## Example usage
            <div style={{width: 500, height: 500}}>
                <VectorMap map={'fr_regions_2016_mill'}
                           backgroundColor="#3b96ce"
                           ref="map"
                           containerStyle={{
                               width: '100%',
                               height: '100%'
                           }}
                           containerClassName="map"
                />
            </div>

Will result the following map:

<p align="center">
  <img src="https://github.com/jbpasquier/react-jvectormap-fr/raw/master/example.png" width="500" height="500" />
</p>


## Supported props:

All the [Map](http://jvectormap.com/documentation/javascript-api/jvm-map/) properties are supported as props.

Please note that `map` is a required prop, and must be one of the [supported maps](#maps);

In addition, the plugin currently supports the following props:

| prop               | type   | required | description                                  |
|--------------------|--------|----------|----------------------------------------------|
| containerStyle     | object | no       | an inline style object for the map container |
| containerClassName | string | no       | a class name for the map container           |

## Ref methods

You can allways add a `ref` to your VectorMap and access the following methods (more will be added in the future or upon request):

| method                                                                                              | params         | return type |
|-----------------------------------------------------------------------------------------------------|----------------|-------------|
| **setBackgroundColor** <br /> programmatically change the map background color                             | color - string | -           |
| **getMapObject** <br /> get the jvectormap object for additional options and methods (see jvectormap docs) | -              | object      |

## Supported [maps]

This plugin is brand new, and currently supports only two type of maps:

* world_mill
* us_aea
* continents_mill
* fr_regions_2016_mill

**Please feel free to request new maps! just open an issue!**

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