diff --git a/README.md b/README.md new file mode 100644 index 0000000..6538a8c --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# BMap-loader + +BMap-loader 是一个非官方的地图 jsAPI 加载器, 目标是为用户提供一个简洁易用的创建百度地图的插件。 BMap-loader 的灵感来源于 [amap-jsapi-loader](https://www.npmjs.com/package/@amap/amap-jsapi-loader), 但目前仍有部分功能待实现中, 如果您愿意贡献代码,欢迎提 PR。 + +BMap-loader 特性如下: + +- 支持以 UMD 和 ESM 两种方式使用; +- 以异步加载的方式加载百度地图; +- 支持同时加载 JSAPI JSAPI-GL 两个地图版本; +- 支持多次加载插件; +- 对于加载地图的错误用法给予报错处理; + +# 使用方式 + +## 以 npm 方式引用 + +```shell +$ npm install bmap-loader --save +``` + +```js +import BMapLoader from "bmap-loader"; + +BMapLoader({ + v: "1.0", + type: "webgl", + ak: "填写你的ak密钥", +}).then((BMapGL) => { + const map = new BMapGL.Map("map"); + map.centerAndZoom(new BMapGL.Point(116.404, 39.915), 11); + map.addControl( + new BMapGL.MapTypeControl({ + mapTypes: [BMAP_NORMAL_MAP, BMAP_HYBRID_MAP], + }) + ); + map.enableScrollWheelZoom(true); +}); +``` + +## 以 js 脚本的方式引用 + +```html + + +``` + +## RoadMap + +- [ ] 改用 typescript 重写,增强智能提示。 +- [ ] 支持加载百度地图的插件库。 + +# License + +MIT diff --git a/package.json b/package.json index ce24ff0..901ef9f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bmap-loader", - "version": "0.0.1", + "version": "0.0.2", "description": "一个易用的安装百度地图的js加载器, 灵感来源于高德地图官方的amap-jsapi-loader", "main": "./dist/bundle.es.js", "type": "module", @@ -12,6 +12,7 @@ "bmap-loader", "sdk" ], + "files": ["dist"], "author": "Wonder Dai", "license": "MIT", "bugs": {