Skip to content

xyy94813/amap-react-components

Repository files navigation

amap-react-components

latest version License npm downloads minimized gzipped size

GitHub Repo stars last commit (branch)

deploy-to-gh-pages Codecov workflow codecov

AMap 的 React 组件。

注意: 仅支持 AMap V2 且 React >= 16.8.

对比其他库

amap-react-components @amap/amap-react react-amap
官方 ❌ (饿了么团队)
开源
活跃度 较高
使用文档
单元测试覆盖率
基于 React Hooks
支持 amap v2
支持 amap ui
支持 TS
支持 Vite
自定义组件
UMD 模块

使用

安装

yarn add amap-react-components
// or
// npm i amap-react-components

Browser

提供 browser 后缀支持 UMD 模块

例如:

https://cdn.jsdelivr.net/npm/amap-react-components@0.0.1/dist/amap-react-components.browser.js

示例及 API

各组件示例

Typescript

安装 jsapi 的 ts 声明

npm install amap-jsapi-v2-types -D

由于官方 ts 声明存在声明错误、缺漏,以及缺少 AMapUI 相关接口声明,甚至官方文档存在错误等问题

自定义组件时,可以参考此文件 对其类型扩展

并及时给 amap-jsapi-v2-types 提 PR。

Polyfill

使用者可能需要自行处理以下兼容性

贡献指南

查看贡献指南

变更日志

查看变更日志

LICENSE

MIT LICENSE