nigerianstates-map

This is a React Map library for Nigerian States

Intro

This React library provides a visualization to various individual States in the Country of Nigeria

Note

You can check the src/examples from the project directory for assistance.

Install

npm install --save nigerianstates-map

yarn add nigerianstates-map

Sample Usage

import React from "react";
import {Lagos, Nigeria, State} from 'nigerianstates-map'; 

/**
 * You can import any state you need.
 * Or Import Nigeria and specify the state name.
 */

class App extends React.Component {
  
  render() {
    /**
    * You can import any state you need.
    */
    
    /**
    * @param hoverColor=>string color to be used when the map is hovered on.
    * @param defaultColor=> the default color for the map
    * @param state=> the state to Render 
    * @param id=> A unique id for the map 
    */
    return(
      <div>
        <Nigeria
          state={State.LAGOS}
          hoverColor="purple"
          defaultColor="blue"
          className="my-map"
          />

        <Lagos
          hoverColor="purple"
          defaultColor="blue"
        />
     
    </div>

    );
  }
}

ReactDOM.render(<App />, document.querySelector("#root"));

The maps scale to the width of their container. The styles are bundled and injected by the library, so importing a separate CSS file is not required. className is applied to the map container for custom layout and styling.

Unit Test

To run the tests, run npm test. The suite checks every individual state map and every state selection supported by Nigeria.

See the test files in src/lib/tests for an example of a component test.

Code Quality

Run yarn format to format the project with Biome, yarn lint to lint and type-check it, or yarn validate to run all Biome checks and the TypeScript compiler. A Husky pre-commit hook runs the TypeScript check and formats/lints staged JavaScript, TypeScript, CSS, JSON, and HTML files with lint-staged.

Contributing

1. Create your feature branch: git checkout -b feature-name
2. Commit your changes: git commit -m 'Some commit message'
3. Push to the branch: git push origin feature-name
4. Submit a pull request 😉😎

How can I thank you?

Why not star the github repo? Share to Others too.