React component for United States choropleth map
npm install react-usa
npm install --save react-usa
Preparation
Please perform the following steps in preparationStep 1: Include leaflet.js's CSS file link in the
section of your index.html
html
`Step 2: Obtain a free
from Mapbox. You have to create an account to obtain this token
Usage
`javascriptimport React from 'react';
import ReactUSA from 'react-usa';
class Example extends React.Component {
render() {
const mapboxAccessToken = "" // Your access token
const mapboxType = "streets";
const position = [37.0902, -95.7129];
const zoom = 4;
const data = [
{
name: "Nebraska",
values: [{label: "Capital", val: "Lincoln"}, {label: "Electoral Votes", val: 3}],
color: "#E31A1C"
}
]
const stateStyle = { weight: 1, opacity: 1, color: '#666', dashArray: '3', fillOpacity: 0.7 };
const stateHoverStyle = { weight: 5, color: '#FFF', dashArray: '1', fillOpacity: 0.7 };
const excludeStates = ["District of Columbia", "Puerto Rico"];
return (
mapHeight="800px" // Required
mapWidth="100%"
className="container"
mapboxType={mapboxType}
mapCenter={position}
mapZoom={zoom}
mapScrollZoom={false}
neighborhoodOn={true}
tooltip={true}
tooltipSticky={false}
data={data}
stateStyle={stateStyle}
stateHoverStyle={stateHoverStyle}
excludeStates={excludeStates}
/>
)
}
}export default Example;
`
Properties
The component accepts the following propsName | Type | Default | Req/Opt | Description
--- | --- | --- | --- | ---
mapboxAccessToken | string | | Required | Access Token from Mapbox
mapHeight | string | | Required | Height of the map
mapWidth | string | 100% | Optional | Width of the map. Default value is 100% of the containing element
className | string | | Optional | Class name to be applied to the map
mapboxType | string | streets | Optional | Mapbox provides many types of map themes. This component supports 5 such themes: light, dark, streets, outdoors, and satellite. Default value is streets
| array | [37.0902, -95.7129] | Optional | Geographical coordinates (latitude and longitude) where the map should be centered. Default value is [37.0902, -95.7129]
| integer | 4 | Optional | Initial zoom level for the map. Default value is 4
| boolean | false | Optional | Indicates whether the map can be zoomed by using the mouse wheel. Default value is false
| boolean | true | Optional | Indicates whether the state tiles should be displayed. Default value is true
| boolean | true | Optional | Indicates whether the tooltip should appear when hovering over a state tile. Default value is true
| boolean | false | Optional | If true, the tooltip will follow the mouse instead of being fixed at the feature center. Default value is false
| object | | Optional | Style of the state tile. This overrides the default style, which is { weight: 1, opacity: 1, color: '#666', dashArray: '3', fillOpacity: 0.7 }
| object | | Optional | Style of the state tile when hovered over. This overrides the default style, which is { weight: 5, color: '#FFF', dashArray: '1', fillOpacity: 0.7 }
| array | | Optional | To exclude any states from the map, provide the state names in an array. Default will show all 50 states
data | array | | Optional | See the Data section below for detailsNote on hover styles: To ensure that the tile style behaves as expected when hovered over and away from the tile, please include matching CSS properties in both
stateStyle and stateHoverStyle. For example, if the fillOpacity CSS property is defined in stateStyle, then please define fillOpacity in stateHoverStyle as well, and vice versa. Otherwise, some properties assigned during hover will remain even when hovered away and vice versa.
Data
The data prop is an array of objects. Each object is dedicated to a state and must have the following keys:
* name: Name of the state
* values: Array of objects with keys label and val
* : Color of the state tile. If color is unspecified, the default color for all tiles is #FFEDA0For example, if you want to highlight the below states with their data, then simply pass the below
array of objects.
`javascript
const data = [
{
name: "Nebraska",
values: [{label: "Capital", val: "Lincoln"}, {label: "Electoral Votes", val: 3}],
color: "#E31A1C"
},
{
name: "Kansas",
values: [{label: "Population", val: "1.6 Million"}],
color: "#E31A1C"
}
]
``ColorBrewer is a nice tool that helps you choose nice colors for state tiles
State | State | State | State
--- | --- | --- | ---
Alabama | Indiana | Nebraska | South Carolina
Alaska | Iowa | Nevada | South Dakota
Arizona | Kansas | New Hampshire | Tennessee
Arkansas | Kentucky | New Jersey | Texas
California | Louisiana | New Mexico | Utah
Colorado | Maine | New York | Vermont
Connecticut | Maryland | North Carolina | Virginia
Delaware | Massachusetts | North Dakota | Washington
Florida | Michigan | Ohio | West Virginia
Georgia | Minnesota | Oklahoma | Wisconsin
Hawaii | Mississippi | Oregon | Wyoming
Idaho | Missouri | Pennsylvania | District of Columbia
Illinois | Montana | Rhode Island | Puerto Rico