https://github.com/xyy94813/amap-react-components
基于高德 JS SDK V2 的 React 组件库
https://github.com/xyy94813/amap-react-components
amap amap-js amap-react react react-amap
Last synced: about 1 month ago
JSON representation
基于高德 JS SDK V2 的 React 组件库
- Host: GitHub
- URL: https://github.com/xyy94813/amap-react-components
- Owner: xyy94813
- License: mit
- Created: 2020-06-27T09:39:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:13:28.000Z (8 months ago)
- Last Synced: 2024-10-23T16:30:20.452Z (8 months ago)
- Topics: amap, amap-js, amap-react, react, react-amap
- Language: TypeScript
- Homepage: https://xyy94813.github.io/amap-react-components/
- Size: 22.1 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: Contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# amap-react-components
[](https://www.npmjs.org/package/amap-react-components)
[](https://www.npmjs.org/package/amap-react-components)
[](http://npmjs.com/amap-react-components)
[](http://npmjs.com/amap-react-components)[](https://github.com/xyy94813/amap-react-components)
[](https://github.com/xyy94813/amap-react-components)[](https://github.com/xyy94813/amap-react-components/actions/workflows/deploy-to-gh-pages.yml)
[](https://github.com/xyy94813/amap-react-components/actions/workflows/codecov.yml)
[](https://codecov.io/gh/xyy94813/amap-react-components)[AMap](https://lbs.amap.com/api/jsapi-v2/summary/) 的 React 组件。
> 注意: 仅支持 AMap V2 且 React >= 16.8.
## 对比其他库
| | amap-react-components | @amap/amap-react | react-amap |
| ---------------- | --------------------- | ---------------- | ----------------- |
| 官方 | ❌ | ✅ | ❌ (饿了么团队) |
| 开源 | ✅ | ❌ | ✅ |
| 活跃度 | 较高 | 低 | 低 |
| 使用文档 | ✅ | ✅ | ✅ |
| 单元测试覆盖率 | 高 | ❓ | ❌ |
| 基于 React Hooks | ✅ | ❓ | ❌ |
| 支持 amap v2 | ✅ | ✅ | ❌ |
| 支持 amap ui | ✅ | ✅ | ✅ |
| 支持 TS | ✅ | ✅ | ✅ |
| 支持 Vite | ✅ | ❓ | ❓ |
| 自定义组件 | ✅ | ✅ | ✅ |
| UMD 模块 | ✅ | ❓ | ✅ |- [@amap/amap-react](https://www.npmjs.com/package/@amap/amap-react) (高德官方 react 组件 )
- [react-amap](https://github.com/elemefe/react-amap)## 使用
### 安装
```
yarn add amap-react-components
// or
// npm i amap-react-components
```### Browser
提供 browser 后缀支持 UMD 模块
例如:
```
https://cdn.jsdelivr.net/npm/[email protected]/dist/amap-react-components.browser.js
```### 示例及 API
[各组件示例](https://xyy94813.github.io/amap-react-components)
### Typescript
安装 jsapi 的 ts 声明
```shell
npm install amap-jsapi-v2-types -D
```由于官方 ts 声明存在声明错误、缺漏,以及缺少 AMapUI 相关接口声明,甚至官方文档存在错误等问题
自定义组件时,可以参考[此文件](https://github.com/xyy94813/amap-react-components/blob/main/src/%40types/AMap.d.ts) 对其类型扩展
并及时给 `amap-jsapi-v2-types` 提 PR。
### Polyfill
使用者可能需要自行处理以下兼容性
- [Proxy](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Proxy)
--> [Proxy Polyfill](https://github.com/GoogleChrome/proxy-polyfill)## 贡献指南
查看[贡献指南](./Contributing.md)
## 变更日志
查看[变更日志](./CHANGELOG.md)
## LICENSE
[MIT LICENSE](./LICENSE)