@south-paw/react-vector-maps
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.0 • Public • Published

    react-vector-maps

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

    npm 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 npm i.

    # run tests
    npm run test
    
    # lint source
    npm run lint
    
    # build source
    npm run build
    
    # clean up build folders
    npm run clean
    
    # start docs for development
    npm run docs:develop
    
    # clean up docs folders
    npm run docs:clean
    
    # yarn install for the docs
    npm run docs:install
    
    # build docs for deployment
    npm run docs:build
    
    # serve docs from /public after build
    npm run docs:serve

    License

    MIT, see the LICENSE file.

    Install

    npm i @south-paw/react-vector-maps

    DownloadsWeekly Downloads

    743

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    19.3 kB

    Total Files

    12

    Last publish

    Collaborators

    • south-paw