Nonvoluntary Professional Mangling
Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

react-svg-map

2.0.2 • Public • Published

react-svg-map

npm version Build Status codecov Dependency Status peerDependencies Status

A set of React.js components to display an interactive SVG map.

React SVG Map

Demo

Take a look at the live demo!

Installation

npm

npm install --save react-svg-map

yarn

yarn add react-svg-map

Usage

⚠️ Breaking change from v1

This package does not include maps anymore!

You have to install the map you need from svg-maps or you can use your own map. See maps section for more details.

If you are still using the 1.x.x version, look at the v1 documentation.

🌍 Simple SVG Map

This is the base component to display an SVG map.

  • Import SVGMap component from react-svg-map
  • Import the map you want
  • Optionally, import react-svg-map/lib/index.css if you want to apply the default styles
import React from "react";
import ReactDOM from "react-dom";
import Taiwan from "@svg-maps/taiwan";
import { SVGMap } from "react-svg-map";
import "react-svg-map/lib/index.css";
 
class App extends React.Component {
  constructor(props) {
    super(props);
  }
 
  render() {
    return <SVGMap map={Taiwan} />;
  }
}
 
ReactDOM.render(<App />, document.getElementById("app"));

API

Prop Type Default Description
map object required Describe SVG map to display. See maps section for more details.
className string 'svg-map' CSS class of <svg>.
role string 'none' ARIA role of <svg>.
locationClassName string or function 'svg-map__location' CSS class of each <path>. The function parameters are the location object and the location index.
locationTabIndex string or function '0' Tabindex each <path>. The function parameters are the location object and the location index.
locationRole string 'none' ARIA role of each <path>.
onLocationMouseOver function Invoked when the user puts the mouse over a location.
onLocationMouseOut function Invoked when the user puts the mouse out of a location.
onLocationMouseMove function Invoked when the user moves the mouse on a location.
onLocationClick function Invoked when the user clicks on a location.
onLocationKeyDown function Invoked when the user hits a keyboard key on a location.
onLocationFocus function Invoked when the user focuses a location.
onLocationBlur function Invoked when the user unfocuses a location.
isLocationSelected function Executed to determine if a location is selected. This property is used to set the aria-checked HTML attribute.

☑️ Checkbox SVG Map

This is an implementation of SVGMap that behaves like a group of checkboxes.
It is based on this WAI-ARIA example to support keyboard navigation and be accessible.

  • Import CheckboxSVGMap component from react-svg-map
  • Import the map you want
  • Optionally, import react-svg-map/lib/index.css if you want to apply the default styles
import React from "react";
import ReactDOM from "react-dom";
import Taiwan from "@svg-maps/taiwan";
import { CheckboxSVGMap } from "react-svg-map";
import "react-svg-map/lib/index.css";
 
class App extends React.Component {
  constructor(props) {
    super(props);
  }
 
  render() {
    return <CheckboxSVGMap map={Taiwan} />;
  }
}
 
ReactDOM.render(<App />, document.getElementById("app"));

API

Prop Type Default Description
map object required Describe SVG map to display. See maps section for more details.
className string 'svg-map' CSS class of <svg>.
locationClassName string or function 'svg-map__location' CSS class of each <path>. The function parameters are the location object and the location index.
onChange function Invoked when the user selects/deselects a location. The list of selected locations is passed as parameter.
onLocationMouseOver function Invoked when the user puts the mouse over a location.
onLocationMouseOut function Invoked when the user puts the mouse out of a location.
onLocationMouseMove function Invoked when the user moves the mouse on a location.
onLocationFocus function Invoked when the user focuses a location.
onLocationBlur function Invoked when the user unfocuses a location.

🔘 Radio SVG Map

This is an implementation of SVGMap that behaves like a group of radio buttons.
It is based on this WAI-ARIA example to support keyboard navigation and be accessible.

  • Import RadioSVGMap component from react-svg-map
  • Import the map you want
  • Optionally, import react-svg-map/lib/index.css if you want to apply the default styles
import React from "react";
import ReactDOM from "react-dom";
import Taiwan from "@svg-maps/taiwan";
import { RadioSVGMap } from "react-svg-map";
import "react-svg-map/lib/index.css";
 
class App extends React.Component {
  constructor(props) {
    super(props);
  }
 
  render() {
    return <RadioSVGMap map={Taiwan} />;
  }
}
 
ReactDOM.render(<App />, document.getElementById("app"));

API

Prop Type Default Description
map object required Describe SVG map to display. See maps section for more details.
className string 'svg-map' CSS class of <svg>.
locationClassName string or function 'svg-map__location' CSS class of each <path>. The function parameters are the location object and the location index.
onChange function Invoked when the user selects a location. The selected location is passed as parameter.
onLocationMouseOver function Invoked when the user puts the mouse over a location.
onLocationMouseOut function Invoked when the user puts the mouse out of a location.
onLocationMouseMove function Invoked when the user moves the mouse on a location.
onLocationFocus function Invoked when the user focuses a location.
onLocationBlur function Invoked when the user unfocuses a location.

Maps

Existing maps

Since v2.0.0 this package does not provide maps anymore. All the existing maps have been moved to the independant svg-maps project because they may be useful for other components/projects.

Custom maps

You can modify existing maps or create your own.

Modify a map

  1. Import the map to modify
  2. Create a new object from this map
  3. Pass this new object as map prop of <SVGMap /> component
import React from "react";
import Taiwan from "@svg-maps/taiwan";
import { SVGMap } from "react-svg-map";
 
class App extends React.Component {
  constructor(props) {
    super(props);
 
    // Create new map object
    this.customTaiwan = {
      ...Taiwan,
      label: "Custom map label",
      locations: Taiwan.locations.map(location => {
        // Modify each location
      })
    };
  }
 
  render() {
    return <SVGMap map={this.customTaiwan} />;
  }
}

It is recommended to not modify the SVG properties (viewBox, path), because it may break the map's display.

Create a map

If you create a new map (other country, city...), feel free to contribute to svg-maps project!

License

MIT

Install

npm i react-svg-map

DownloadsWeekly Downloads

322

Version

2.0.2

License

MIT

Unpacked Size

168 kB

Total Files

12

Last publish

Collaborators

  • avatar