Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.75 KB

README.md

File metadata and controls

92 lines (61 loc) · 3.75 KB

amap-react-components

deploy-to-gh-pages package version npm downloads

Codecov 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/[email protected]/dist/amap-react-components.browser.js

示例及 API

各组件示例

Typescript

安装官方的 jsapi 的 ts 声明

npm install @amap/amap-jsapi-types

由于官方 ts 声明存在声明错误、缺漏,以及缺少 AMapUI 相关接口声明等问题, 本项目在官方声明上对接口声明做了改动。

因此,需要将此声明文件 复制进您的项目。 当使用了本项目暂时不支持的组件,您需要自定义组件时,可以在您的项目自行维护。

如过,有人知道如何将这部分声明文件在构建时一同打包进最终的输出中,麻烦告知我。 如果能看到您的 PR 那就更好了。

Polyfill

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

贡献指南

查看贡献指南

变更日志

查看变更日志

LICENSE

MIT LICENSE