react-denmark-map

Customizable plug-and-play map of Denmark for visual presentation 🗺️

✨ Demo ✨

Table of contents

• Installation
• Usage
  • Basic usage
  • Customizing areas
  • Customizing the tooltip
  • Click and hover events
  • Zooming
  • Styling
• Typescript
• Performance
• API
  • Components
  • Props
  • Types
• License
• Contributing

Installation

npm install react-denmark-map

yarn add react-denmark-map

Usage

Examples use the Municipalities component, although the props are the same for every component. See "API" for all available components.

Basic usage

import { Municipalities } from 'react-denmark-map'

const App = () => {
  return <Municipalities />
}

Customizing areas

The customizeAreas prop is invoked for each area and applies a className and/or style object.

import { Municipalities } from 'react-denmark-map'

const App = () => {
  const customizeMunicipalities = (municipality) => {
    if (municipality.name === 'københavn') {
      return {
        className: 'københavn',
        style: {
          fill: 'red'
        }
      }
    }
  }

  return <Municipalities customizeAreas={customizeMunicipalities} />
}

Below is an example of how you can conditionally style each area with external data. Here, id is the name of the municipality and population is data about the area. We can make municipalities with a population less than 40.000 people a light blue color and municipalities with a higher population a darker blue color.

import { Municipalities } from 'react-denmark-map'

const data = [
  {
    id: 'assens',
    population: 40972
  }
  // ...
]

const App = () => {
  const customizeMunicipalities = (municipality) => {
    const result = data.find((item) => item.id === municipality.name)

    if (!result) return

    if (result.population < 40000) {
      return {
        style: {
          fill: 'skyblue'
        }
      }
    }
    return {
      style: {
        fill: 'royalblue'
      }
    }
  }

  return <Municipalities customizeAreas={customizeMunicipalities} />
}

Instead of municipalities, these areas could also be each region or island, depending on the component used. See "API" for full reference.

Customizing the tooltip

customTooltip is a prop that takes a function and returns a JSX element. The tooltip is displayed when hovering an area.

import { Municipalities } from 'react-denmark-map'

const CustomTooltip = ({ area }) => {
  return (
    <div className="tooltip">
      <p>Name: {area.displayName}</p>
      <p>Municipality code: {area.code}</p>
    </div>
  )
}

const App = () => <Municipalities customTooltip={CustomTooltip} />

You can easily display external data about the area on the tooltip. In this example, id is the name of the municipality and population is data about the area, where we want to display data about the population of the area in the tooltip.

import { Municipalities } from 'react-denmark-map'

const data = [
  {
    id: 'assens',
    population: 40972
  }
  // ...
]

const CustomTooltip = ({ area }) => {
  const result = data.find((item) => item.id === area.name)

  return (
    <div>
      <p>{area.displayName}</p>
      <p>Population: {result?.population ? result.population : 'N/A'}</p>
    </div>
  )
}

const App = () => <Municipalities customTooltip={CustomTooltip} />

The area prop of the customTooltip component contains several fields that can be used to identify the correct area. See "API" for full reference.

Disable the tooltip by passing showTooltip={false} as a prop.

Click and hover events

onClick event handler

An event handler that is called when an area is clicked.

import { Municipalities } from 'react-denmark-map'

const App = () => {
  return (
    <Municipalities
      onClick={(municipality) => console.log(`Clicked: ${municipality.displayName}`)}
    />
  )
}

onHover event handler

An event handler that is called when an area is hovered on.

import { Municipalities } from 'react-denmark-map'

const App = () => {
  return (
    <Municipalities
      onHover={(municipality) => console.log(`Hovered: ${municipality.displayName}`)}
    />
  )
}

onMouseEnter and onMouseLeave event handlers

Event handlers that are called when areas are entered and left by the cursor, respectively. onHover is the same as onMouseEnter.

import { Municipalities } from 'react-denmark-map'

const App = () => {
  return (
    <Municipalities
      onMouseEnter={(municipality) => console.log(`Mouse entered: ${municipality.displayName}`)}
      onMouseLeave={(municipality) => console.log(`Mouse left: ${municipality.displayName}`)}
    />
  )
}

Zooming

The customZoomControls prop allows you to pass your own zoom controls.

import { Municipalities } from 'react-denmark-map'

const CustomZoomControls = ({ onZoomIn, onZoomOut }) => (
  <div style={{ display: 'flex', flexDirection: 'column' }}>
    <button onClick={onZoomIn}>+</button>
    <button onClick={onZoomOut}>–</button>
  </div>
)

const App = () => <Municipalities customZoomControls={CustomZoomControls} />

Pass the prop zoomable={false} to disable zooming (and thus not render zoom controls).

Styling

Positioning

It's strongly recommended that you wrap the map in an element and position that according to your needs. Applying a max width and a margin will center the map and preserve it's dimensions across screen sizes.

<div style={{ maxWidth: '600px', margin: '0 auto' }}>
  <Municipalities />
</div>

Appearance

The exported components also support a number of different ways of styling the map.

import { Municipalities } from 'react-denmark-map'

const App = () => {
  return <Municipalities className="denmark" style={{ marginTop: '20px' }} color="lightgray" />
}

• className is a string which is applied directly to the SVG element.
• style is an object of CSS properties which is applied directly to the SVG element.
• color is the default color applied to each area of the map.
• clickable specifies whether cursor: pointer should be applied when hovering. True if onClick is passed.
• hoverable specifies whether hover styles should be applied when hovering. True by default.

Alternatively, you can apply styles via CSS selectors. Some tags are available through their HTML id attribute.

• react-denmark-map-svg is the svg element which contains the path of each area.
• react-denmark-map is the top-most figure element and the parent of svg.
• react-denmark-map-tooltip is the default tooltip div element.
• react-denmark-map-zoom-controls is the parent div element to the two buttons constituting the default zoom controls.

Typescript

React Denmark Map is written in Typescript.

You may also want to apply types to function arguments i.e. when writing the function to be given to the customizeAreas prop. In that case, React Denmark Map exports the type used as an argument as *Type, e.g. for the Municipalities component.

import { Municipalities, MunicipalityType } from 'react-denmark-map'

const CustomTooltip = ({ area }: { area: MunicipalityType }) => (
  // ...
)

const App = () => {
  const customizeMunicipalities = (municipality: MunicipalityType) => {
    // ...
  }

  return <Municipalities customizeAreas={customizeMunicipalities} />
}

All props that accept a function as an argument have the same type in that component, so the same type can be applied to the parameter used in onClick, onHover, as well as for the area prop in customTooltip.

Different components have different types for the area parameter. The Regions component, for example, exports a RegionsType that can be used in the same way as shown above. See "API - Types" for the full reference of area types.

Performance

If you want to make sure that each version of the map rerenders as few times as possible to improve performance, make sure to memoize the objects and functions that you pass as props with useMemo and useCallback. Each component is only shallowly memoized. Below is an example of memoizing the customizeAreas and style props.

const App = () => {
  const style = useMemo(() => ({ color: 'red' }), [])

  const customizeAreas = useCallback(() => {
    return {
      style: {
        fill: 'red'
      }
    }
  }, [])

  return <Municipalities customizeAreas={customizeAreas} style={style} />
}

API

Components

React Denmark Map exports several components, each being a map of Denmark with different areas that all support the same props as those shown above:

Component	Description
Municipalities	All 98 municipalities of Denmark.
Constituencies	The 10 constituencies of Denmark.
Regions	The five regions of Denmark.
Islands	Zealand, Fyn and Jutland (Sjælland, Fyn, Jylland).
Denmark	A map of Denmark with no subsequent areas.

Props

Prop	Description	Type	Default
className	The className applied directly to the <svg> element.	string	""
style	The style object applied directly to the <svg> element.	CSSProperties*	{}
viewbox	The viewbox applied directly to the <svg> element.	{ top?: number, left?: number, width?: number, height?: number }	{ top: 0, left: 0, width: 1000, height: 1215 }
color	The default color of each municipality.	CSSProperties["fill"]	#ccc
clickable	Whether the clickable styles should be applied to the <path> element (the area).	boolean	false
hoverable	Whether the hoverable styles should be applied to the <path> element (the area).	boolean	true
showTooltip	Whether to render the tooltip.	boolean	true
zoomable	Whether you should be able to zoom on the map.	boolean	true
customZoomControls	A functional component that returns custom zoom controls. Rendered top-right.	(props: { onZoomIn(): void; onZoomOut(): void }) => ReactNode
customTooltip	A functional component that returns a custom tooltip.	(props: { area: AreaType*** }) => ReactNode
customizeAreas	A function that is invoked for every area and returns an object to style the area.	(area: AreaType) => { className?: string, style? CSSProperties } | undefined
filterAreas	A function that is invoked for every area that avoids rendering the area if the function returns false.	(area: AreaType) => boolean
onClick	A function that is invoked when an area is clicked.	(area: AreaType) => void
onHover	A function that is invoked when an area is hovered.	(area: AreaType) => void
onMouseEnter	A function that is invoked when the mouse enters an area.	(area: AreaType) => void
onMouseLeave	A function that is invoked when the mouse leaves an area.	(area: AreaType) => void

*: CSSProperties refers to the object provided to the style attribute in React. Fields in this object are denoted as CSSProperties["property"].

**: It will be out of the viewbox when first rendered so you need to manually set the viewbox to render it. See example for use case.

***: AreaType is one of the five types corresponding to the component used (see "Types" below).

Types

Each area has at least the first 5 properties and potentially more.

type AreaType = {
  id: string // the name of the area with substitutes for Danish letters (e.g. 'fanoe')
  name: string // the name of the area with Danish letters (e.g. 'fanø')
  asciiName: string // same as 'id'
  displayName: string // the local name of the area capitalized (e.g. 'Høje Taastrup')
  d: string // the path of the area applied to the <path> element
  code: string // the municipality or region code (e.g. 482 or 1083)
  enTerm: string // the term used to describe the area in English (e.g. jyllland = jutland)
  region: RegionType // the region that a municipality is located in (e.g. fanø -> syddanmark)
}

The types corresponding to each component are:

Component	Name of exported type	Included in type
Municipalities	MunicipalityType	{ id, name, asciiName, displayName, d, code, region }
Constituencies*	ConstituencyType	{ id, name, asciiName, displayName, d }
Regions	RegionType	{ id, name, asciiName, displayName, d, code }
Islands	IslandType	{ id, name, asciiName, displayName, d, enTerm }
Denmark	DenmarkType	{ id, name, asciiName, displayName, d, enTerm }

*: When filtering using any of the strings in the ConstituencyType be aware that the constituencies (danish: "storkredse"), e.g. "sydjyllands storkreds", have the word "storkreds" omitted in the properties id, name and asciiName. Thus, "sydjyllands storkreds" is just "sydjyllands" and so on.

Using the Denmark component means that there's only one path element, so DenmarkType describes just that one area.

All entries for the areas can be found under 'packages/core/src/components/[area]/data.ts'.

License

React Denmark Map is licensed under the MIT license.

Contributing

Contributions are really appreciated! Read CONTRIBUTING.md for more information.