@tianditu/vue 0.0.3-edge.0 → 0.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Demo Macro
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Demo Macro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,21 +4,70 @@
 ![npm downloads](https://img.shields.io/npm/dw/@tianditu/vue)
 ![npm license](https://img.shields.io/npm/l/@tianditu/vue)
 
-> Vue components for tianditu, powered by Demo Macro.
+> 用 Vue 3 组件写天地图。
+> 覆盖官方 JavaScript API 的地图、覆盖物、控件、鼠标工具、图层、标绘组件与服务组合式函数：组件写在地图内部即自动挂载，props 变更经官方 setter 同步，官方事件原生转发，每个组件都 expose SDK 实例可命令式兜底。
 
-## Getting started
+## 特性
+
+- 🗺️ **`<TdtMap>` 容器** — center/zoom/交互等 props（`locate` 定位方式：`"geolocation"` 浏览器定位、`"ip"` 官方 IP 定位、`"auto"` 前者优先浏览器失败回退 IP，默认回退北京）；官方 14 个地图事件原生转发
+- 📌 **覆盖物** — Marker、Polyline、Polygon、Circle、Rectangle、Label、MarkerClusterer、CloudMarkerCollection、InfoWindow 与 ContextMenu 均为声明式组件；props 变化经官方 setter 同步
+- 🎛️ **控件** — Zoom、Scale、Copyright、OverviewMap 与 MapType
+- 🖱️ **鼠标工具** — PolylineTool、PolygonTool、CircleTool、RectangleTool、MarkTool、PaintBrushTool 与 CoordinatePickup，受控 `active` 开关
+- 🗂️ **图层** — TileLayer、TileLayer.WMS、TileLayer.TDT、GridlineLayer 与 LayerGroup
+- 🚩 **标绘** — 22 个标绘实体组件、23 个标绘工具与标绘控件
+- 📞 **服务组合式** — `useLocalSearch`、`useGeocoder`、`useGeolocation`、`useDrivingRoute`、`useTransitRoute`、`useBusLineSearch`、`useDataSources`、`useAdministrativeDivision`、`useLocalCity`，回调一律转为 Promise
+- 🛟 **逃生口** — `useMap()` 暴露响应式地图实例；每个组件都 expose 其 SDK 实例，可命令式访问
+
+## 安装
 
 ```bash
 # npm
-$ npm install -D @tianditu/wc @tianditu/vue
+$ npm install @tianditu/vue
 
 # yarn
-$ yarn add -D @tianditu/wc @tianditu/vue
+$ yarn add @tianditu/vue
 
 # pnpm
-$ pnpm add -D @tianditu/wc @tianditu/vue
+$ pnpm add @tianditu/vue
+```
+
+## 快速开始
+
+```vue
+<script setup>
+import { ref } from "vue";
+
+import { TdtMap, TdtMarker, TdtInfoWindow } from "@tianditu/vue";
+
+const open = ref(false);
+</script>
+
+<template>
+  <TdtMap
+    tk="你的浏览器端密钥"
+    :center="[116.404, 39.915]"
+    :zoom="12"
+    style="width: 100%; height: 100%"
+  >
+    <TdtMarker :lnglat="[116.404, 39.915]" draggable>
+      <TdtInfoWindow v-model:open="open">
+        <div>天安门</div>
+      </TdtInfoWindow>
+    </TdtMarker>
+  </TdtMap>
+</template>
 ```
 
-## License
+## API
+
+组件分组与官方文档类目一致——地图、覆盖物、控件、鼠标工具、图层、标绘与服务。每个组件的 props、事件与 exposes 见[文档站](https://github.com/DemoMacro/tianditu/tree/main/docs)。
+
+## 相关包
+
+- [@tianditu/core](https://www.npmjs.com/package/@tianditu/core) — 框架无关内核（自动安装）
+- [@tianditu/web-components](https://www.npmjs.com/package/@tianditu/web-components) — Web Components 适配层
+- [@tianditu/services](https://www.npmjs.com/package/@tianditu/services) — 类型化 REST 服务客户端
+
+## 许可
 
-- [MIT](LICENSE) &copy; [Demo Macro](https://imst.xyz/)
+- [MIT](LICENSE) &copy; [Demo Macro](https://www.demomacro.com/)