Skip to content

Commit

Permalink
feat(APILoader): add disableScripts props.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Mar 31, 2023
1 parent 48be871 commit 48fde4f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
19 changes: 17 additions & 2 deletions packages/api-loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,27 @@ const Demo = () => (
export default Demo;
```

### 禁用 SDK 加载

收到一个需求,希望自己在 `html` 中引入 SDK,不需要自动加载,可以使用 `disableScripts` 禁用,在 html 中自己手动添加

```jsx
<APILoader disableScripts>
<Map style={{ height: 100, marginBottom: 10 }} />
</APILoader>
```

```html
<script src="https://webapi.amap.com/maps?v=2.0&key=您申请的key值"></script>
```

### Props

| 参数 | 说明 | 类型 | 默认值 |
|--------- |-------- |--------- |-------- |
| akay | **`必填`** 您需先[申请密钥(ak)](http://lbs.baidu.com/apiconsole/key?application=key)才可使用该服务,接口无使用次数限制,请开发者放心使用。 | string | - |
| akay | **`必填`** `disableScripts=true`**选填** 您需先[申请密钥(ak)](http://lbs.baidu.com/apiconsole/key?application=key)才可使用该服务,接口无使用次数限制,请开发者放心使用。 | string | - |
| version | SDK 版本 | string | `3.0` |
| protocol | 协议,默认是根据当前网站协议的 | `http`/`https` | `window.location.protocol` |
| hostAndPath | 请求 `SDK` 的前半部分 | string | `api.map.baidu.com/api` |
| type | 可选使用百度的 `webgl` 地图 | `webgl` | - |
| type | 可选使用百度的 `webgl` 地图 | `webgl` | - |
| `disableScripts` | 禁用 `SDK` 加载 | boolean | `-` |
9 changes: 8 additions & 1 deletion packages/api-loader/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface APILoaderConfig {
* 文档说明地址:http://lbsyun.baidu.com/index.php?title=jspopular3.0/guide/getkey
* 申请秘钥地址:http://lbs.baidu.com/apiconsole/key?application=key
*/
akay: string;
akay?: string;
/**
* SDK 包版本
* @default 3.0
Expand All @@ -42,6 +42,13 @@ export interface APILoaderConfig {
* JavaScript API GL使用了WebGL对地图、覆盖物等进行渲染,支持3D视角展示地图。 GL版本接口基本向下兼容,迁移成本低。目前v1.0版本支持了基本的3D地图展示、基本地图控件和覆盖物。
*/
type?: 'webgl';
/**
* 禁用 SDK 加载,当你使用本地自己加载 SDK 可以设置为 true
* ```html
* <script type="text/javascript" src="//api.map.baidu.com/api?v=2.0&ak=您的密钥"></script>
* ```
*/
disableScripts?: boolean;
}

export function delay(time: number): Promise<undefined> {
Expand Down

0 comments on commit 48fde4f

Please sign in to comment.