# @types/react-nepal-map

> TypeScript definitions for react-nepal-map

Latest version **1.0.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-nepal-map
pnpm add @types/react-nepal-map
yarn add @types/react-nepal-map
bun add @types/react-nepal-map
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-11-07 |
| First published | 2020-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51371 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-nepal-map
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-nepal-map
- npm.io page: https://npm.io/package/@types/react-nepal-map

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 1.0.4 (latest) — 2023-11-07
- 1.0.1 (ts3.6) — 2021-07-08
- 1.0.0 (ts3.0) — 2020-07-12
- 1.0.3 — 2023-10-18
- 1.0.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-nepal-map`

# Summary
This package contains type definitions for react-nepal-map (https://github.com/keyrunpay/react-nepal-map#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-nepal-map.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-nepal-map/index.d.ts)
````ts
import * as React from "react";

export as namespace ReactNepalMap;

/**
 * Returns random color string
 */
export function getRandomColor(): string;

/**
 * Metadata types for Map
 */
export interface MapMetaDataTypes {
    name: string;
    shape: string;
}

export interface DistrictMapTypes extends MapMetaDataTypes {
    zip: number;
    province: number;
}

export interface ProvinceMapTypes extends MapMetaDataTypes {
    zip: number;
}

export interface ZonalMapTypes extends MapMetaDataTypes {
    code: string;
}

/**
 * Map data
 */
export const districtMapData: DistrictMapTypes[];

export const provinceMapData: ProvinceMapTypes[];

export const zonalMapData: ZonalMapTypes[];

/**
 * Items props for onMapClick method
 */

export interface itemProps {
    name: string;
    zip: number;
    province: number;
    code: string;
}

/**
 * Map component props
 */

export interface MapPropsTypes {
    onMapClick?: ((item: itemProps) => void) | undefined;
    randomSectorColor?: boolean | undefined;
    sectorClassName?: string | undefined;
    containerClassName?: string | undefined;
    color?: string | undefined;
    hoverColor?: string | undefined;
    stroke?: string | undefined;
    strokeWidth?: number | undefined;
}

export interface ProvinceMapPropsTypes extends MapPropsTypes {
    provinceColor?: string[] | undefined;
}

// Components
export const DistrictMap: React.FC<MapPropsTypes>;
export const ProvinceMap: React.FC<ProvinceMapPropsTypes>;
export const ZonalMap: React.FC<MapPropsTypes>;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Ashish Yadav](https://github.com/ashiishme).

---
_Source: https://npm.io/package/@types/react-nepal-map · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
