0.0.2 • Published 1 year ago

world-svg v0.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

World Map

WorldMap is an svg component for React. Renders a responsive world map. It is customizable, works great with tiny screens and can be styled to match any design.

World Map

Installation

npm install world-svg  # using npm
yarn add world-svg     # using yarn

Example

import { WorldMap } from 'world-svg';

function App() {
  return (
    <WorldMap />
  );
}

export default App;

WorldMap props

AttributeTypeDefaultDescription
tooltipstringonSpecify tooltip whether on or off
landColorstring#2db7f5Country color.
hoverColorstring#2db7f5Country color on hover.
landBorderstring#2db7f5Color for Country borders.
tooltipBgColorstring#2db7f5Tooltip background color.
tooltipTextColorstring#2db7f5Tooltip text color.
onCountryClickfunctionnullEvent function that triggered on specific country click. It can take an argument in order to receive clicked country alpha-2 code.

onCountryClick Example

import { WorldMap } from 'world-svg';

const handleCountryClick = (countryId) => {
  console.log(countryId);  // Outs: RU, TR, US, ... etc.
}

function App() {
  return (
    <WorldMap onCountryClick={handleCountryClick} />
  );
}

export default App;