Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.51 KB

MIGRATION.md

File metadata and controls

42 lines (30 loc) · 2.51 KB
Raw

Migration guide

This is a migration guide to walk you through the process of upgrading to react-denmark-map 2.0 from version 1.

New features

  1. Zooming. Zoom controls now appear in the top-right hand corner of every rendition of the map which allows users to zoom in and out. You can disable this zooming or choose to customize it by passing a component as a prop.
  2. Memoization. All map renditions are now memoized, meaning that you may be able to get a slight performance boost if your parent component rerenders frequently and you memoize props.
  3. Better intellisense. The fields in the type of areas in each rendition of the map are now explicit constants. For example, the name property on the MunicipalityType has the type 'norddjurs' | 'syddjurs' | 'koebenhavn' ... instead of just string. Moreover, new JSDoc strings have been added for each prop.

Finally, all map SVG's are now ~30% smaller which should improve load times and rendering performance 🏎️

Breaking changes

  1. Tooltip type. Changed the type of customTooltip to be a React component instead of a regular function to allow for greater abstraction. Below is an example of how it's used now.

    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 otherwise just destructure the first parameter, area, if you want to avoid the slight hassle of converting it to a React component.

  2. Renamed area fields. Some keys in the area object have been renamed. These are specifically:

    • en_name -> asciiName
    • display_name -> displayName
    • en_term -> enTerm

  3. Positioning. If you used the className or style properties to adjust the position of the map, you should instead wrap <Map /> in a seperate element and position that. This was always the recommended approach but the ability to zoom breaks positioning using this method.

  4. Viewbox. All maps now have the same SVG viewbox dimensions of 1000 x 1215 so you should use these dimensions to customize the viewbox.

  5. Alt positions. Removed all altPosition- props. These props rendered some islands closer to the mainland.

You can find more information about the changes by reading the updated documentation. Thank you for using react-denmark-map! 🇩🇰