A react wrapper for jvectormap maps
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

React jvectormap

About

A simple wrapper for jvectormap

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

Gettings started

Install the library:

npm install --save react-jvectormap

Include the jvectormap.css file in your project:

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jvectormap/2.0.4/jquery-jvectormap.css" type="text/css" media="screen"/>

Example usage

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

Will result the following map:

Supported props:

All the Map properties are supported as props.

Please note that map is a required prop, and must be one of the supported 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
programmatically change the map background color
color - string -
getMapObject
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

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