react-bing-map 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +35 -7
  2. package/package.json +21 -10
package/README.md CHANGED
@@ -1,22 +1,50 @@
1
- ## React Rollup Boiler Plate
1
+ ## React - Bing Maps
2
2
 
3
- #### Install the dependencies
3
+
4
+ ## Prerequisites
5
+
6
+ To fully utilize this component, you need a Bing Maps API key, which can be obtained from the [Bing Maps Dev Center](https://www.bingmapsportal.com).
7
+
8
+ ## Installation
4
9
 
5
10
  ```
6
- npm install --save-dev @rollup/plugin-commonjs @rollup/plugin-node-resolve @rollup/plugin-typescript @types/react @types/react-dom react react-dom rollup rollup-plugin-peer-deps-external typescript node-sass sass postcss rollup-plugin-postcss
11
+ yarn add react-bing-map
7
12
 
13
+ OR
14
+
15
+ npm i react-bing-map
8
16
  ```
9
17
 
10
- #### Run Build
18
+ ## Usage
19
+
20
+ #### Import the BingMapsReact component.
21
+
22
+ Import the Bing Maps component
11
23
 
12
24
  ```
13
- npm run build
25
+ import MapView from "react-bing-map";
14
26
  ```
15
27
 
16
- #### Run Story Book
28
+ #### Customized Example:
17
29
 
18
30
  ```
19
- npm run storybook
31
+ <MapView
32
+ mapType = '',
33
+ bingKey = '',
34
+ centerLocation = [0, 0],
35
+ language = 'en-IN',
36
+ zoom = 0,
37
+ pushPins = [],
38
+ pushPinIcon = '',
39
+ showScalebar = true,
40
+ showCopyright = true,
41
+ showLogo = true,
42
+ disableZooming = false,
43
+ showBreadcrumb = true,
44
+ showLocateMeButton = true,
45
+ showZoomButtons = true,
46
+ showMapTypeSelector = true
47
+ />
20
48
  ```
21
49
 
22
50
  #### Output:
package/package.json CHANGED
@@ -1,9 +1,27 @@
1
1
  {
2
2
  "name": "react-bing-map",
3
- "version": "1.0.0",
4
- "author": "Mohanraj Kandasamy",
5
- "license": "ISC",
6
3
  "description": "",
4
+ "author": {
5
+ "name": "Mohanraj Kandasamy",
6
+ "email": "mohanksv.89@gmail.com",
7
+ "url": "https://github.com/kmohanraj"
8
+ },
9
+ "keywords": [
10
+ "bing",
11
+ "maps",
12
+ "bingmaps",
13
+ "bing maps",
14
+ "react bing maps",
15
+ "typescript",
16
+ "react"
17
+ ],
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "https://github.com/kmohanraj/react-bing-maps"
21
+ },
22
+ "version": "1.0.2",
23
+ "private": false,
24
+ "license": "MIT",
7
25
  "main": "./lib/cjs/index.js",
8
26
  "module": "./lib/esm/index.js",
9
27
  "types": "./lib/esm/index.d.ts",
@@ -43,13 +61,6 @@
43
61
  "tslib": "^2.6.0",
44
62
  "typescript": "^5.1.6"
45
63
  },
46
- "keywords": [
47
- "react-template",
48
- "react-library",
49
- "typescript",
50
- "react",
51
- "template"
52
- ],
53
64
  "peerDependencies": {
54
65
  "react": "^16 || ^17 || ^18",
55
66
  "react-dom": "^16 || ^17 || ^18"