Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

react-vector-maps

🗺️ A React component for interactive vector maps of the world and 100+ countries

npm CI Status Coveralls Status Dependencies Dev Dependencies


Features

  • Simple and easy to implement React component for rendering interactive vector maps
  • 100+ vector maps included out of the box, free from MapSVG
  • Convert your own vector map for the component to use with the online converter
  • Quick and straight forward to style your map however you want to

Basic Usage

import React from 'react';
import { VectorMap } from '@south-paw/react-vector-maps';

// You'll need to download the json file from the docs site or you can create your own.
import world from './world.json';

export const Map = () => <VectorMap {...world} />;

See the documentation for more examples and advanced usage of the component.

Issues and Bugs

If you manage to find any, please report them here so they can be squashed.

Development and Contributing

Grab the repo and then install dependencies with yarn.

# run tests
yarn test

# lint source
yarn lint

# build source
yarn build

# clean up build folders
yarn clean

# start docs for development
yarn docs:develop

# clean up docs folders
yarn docs:clean

# yarn install for the docs
yarn docs:install

# build docs for deployment
yarn docs:build

# serve docs from /public after build
yarn docs:serve

License

MIT, see the LICENSE file.

You can’t perform that action at this time.