@heycar/heycars-map 0.1.2 → 0.1.4

package/README.md

@@ -1,18 +1,129 @@
-# Vue 3 + TypeScript + Vite
+### 说明
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+时间关系，先写个简要文档，之后会补一个全面的文档。
 
-## Recommended IDE Setup
+### 特性
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+- 集成 高德 和 谷歌 两个地图
+- 支持 vue 2.7 和 vue 3
+- 统一的接口，不需要写两套
 
-## Type Support For `.vue` Imports in TS
+### 安装
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+```bash
+# 安装依赖包
+npm install @heycar/heycars-map --save
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+```
 
-1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+### 使用
+
+#### 在 入口文件添加 `MapProvider`
+
+- 对于 jsx/tsx 文件的例子
+
+```jsx
+<MapProvider
+  // 高德地图 api key
+  amapKey={amapApiKey}
+  // 高德地图 secret
+  amapSecret={amapApiSecret}
+  // 谷歌地图 id
+  gmapId={gmapId}
+  // 谷歌地图 api key
+  gmapKey={gmapApiKey}
+  // 使用哪个地图供应商，目前两个供应商： amap 高德 / gmap 谷歌
+  supplier={"amap"}
+>
+  ...
+</MapProvider>
+```
+
+- 对于 vue 文件的例子
+
+```vue
+<MapProvider
+  :gmap-id="gmapId"
+  :gmap-key="gmapApiKey"
+  :amap-key="amapApiKey"
+  :amap-secret="amapApiSecret"
+  supplier="amap"
+>
+   ...
+</MapProvider>
+```
+
+#### 在需要用到地图的地方添加 `HeycarMap`
+
+- 对于 jsx/tsx 文件的例子
+
+```jsx
+<HeycarMap
+  class="any class name"
+  // 地图加载失败要显示的内容
+  fallback={() => <div>error</div>}
+  // 地图还没有加载完成时要显示的内容
+  loading={() => <div>loading</div>}
+  // 地图中心点
+  center={[0, 0]}
+  // 地图放缩
+  zoom={3}
+>
+  ...
+</HeycarMap>
+```
+
+- 对于 vue 文件的例子
+
+```vue
+<HeycarMap :center="[0, 0]" class="any class name" :zoom="3">
+   <template #fallback>error</template>
+   <template #loading>loading</template>
+   ...
+</HeycarMap>
+```
+
+#### 在地图里可以使用的组件
+
+目前有下列组件可以使用
+
+- `AddressBox`
+- `AddressLocator`
+- `DrivingLine`
+- `PassengerCircle`
+- `PlaceCircle`
+- `StartEndPoint`
+- `TaxiCar`
+- `WalkingLine`
+- `WaveCircle`
+- `DrivingRoute`
+
+目前有下列组件可以使用下列 hooks
+
+- `useHeycarMap`
+- `useMapDrag`
+- `useMapAngle`
+- `useDrivingRoute`
+
+#### 在地图里使用 `AddressBox` ，需要放在 `HeycarMap` 内部
+
+```jsx
+<HeycarMap center={[0, 0]} zoom={3}>
+  ...
+  <AddressBox position={[0, 0]} title={"Martyrs Lawn"} description={"您将在此处上车"} />
+  ...
+</HeycarMap>
+```
+
+- 对于 vue 文件的例子
+
+```vue
+<HeycarMap :center="[0, 0]" class="any class name" :zoom="3">
+   <template #fallback>error</template>
+   <template #loading>loading</template>
+   ...
+   <AddressBox title="Martyrs Lawn" :position="[0, 0]" description="您将在此处上车" >
+   </AddressBox>
+   ...
+</HeycarMap>
+```

package/dist/api/geometry.d.ts

@@ -1,7 +1,7 @@
+import type { Point } from "../types/interface";
 export interface ApiMapMeta {
     isGoogle: boolean;
 }
-type Point = [number, number];
 export interface DistanceOfLineProps extends ApiMapMeta {
     path: Point[];
 }
@@ -17,4 +17,3 @@ export interface IsPointInLineProps extends ApiMapMeta {
     tolerance: number;
 }
 export declare function apiIsPointInLine(props: IsPointInLineProps): boolean;
-export {};

package/dist/business-components/DrivingLine/DrivingLine.d.ts

@@ -1,4 +1,5 @@
 export interface DrivingLineProps {
+    done?: boolean;
     path: [number, number][];
 }
 export declare const ADrivingLine: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<DrivingLineProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<DrivingLineProps, Required<DrivingLineProps>>, never, DrivingLineProps, {}>;

package/dist/business-components/DrivingRoute/DrivingRoute.d.ts

@@ -0,0 +1,13 @@
+import type { Ref, ShallowRef } from "vue-demi";
+import { UseDrivingRouteProps } from "../../hooks/useDrivingRoute";
+import { VNodeChild } from "../../types/helper";
+import type { Point } from "../../types/interface";
+export interface DrivingRouteProps extends UseDrivingRouteProps {
+    render?: (props: {
+        pathRef: ShallowRef<Point[]>;
+        angleRef: Ref<number | undefined>;
+    }) => VNodeChild;
+}
+export declare const ADrivingRoute: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<DrivingRouteProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<DrivingRouteProps, Required<DrivingRouteProps>>, never, DrivingRouteProps, {}>;
+export declare const GDrivingRoute: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<DrivingRouteProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<DrivingRouteProps, Required<DrivingRouteProps>>, never, DrivingRouteProps, {}>;
+export declare const DrivingRoute: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<DrivingRouteProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<DrivingRouteProps, Required<DrivingRouteProps>>, never, DrivingRouteProps, {}>;

package/dist/business-components/DrivingRoute/index.d.ts

@@ -0,0 +1 @@
+export * from "./DrivingRoute";

package/dist/business-components/PickupPoints/PickupPoints.d.ts

@@ -0,0 +1,5 @@
+export interface PickupPointsProps {
+    positions: [number, number][];
+    labels: string[];
+}
+export declare const PickupPoints: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<PickupPointsProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<PickupPointsProps, Required<PickupPointsProps>>, never, PickupPointsProps, {}>;

package/dist/business-components/PickupPoints/index.d.ts

@@ -0,0 +1 @@
+export * from "./PickupPoints";

package/dist/business-components/PlaceCircle/PlaceCircle.css.d.ts

@@ -1,5 +1,30 @@
-export declare const placeCircleLayout: string;
-export declare const amapPlaceIconLayout: string;
-export declare const gmapPlaceIconLayout: string;
+export declare const placeCircleLayout: import("@vanilla-extract/recipes").RuntimeFn<{
+    textAlign: {
+        left: {
+            flexDirection: "row-reverse";
+        };
+        right: {};
+    };
+}>;
+export declare const amapPlaceIconLayout: import("@vanilla-extract/recipes").RuntimeFn<{
+    textAlign: {
+        left: {
+            marginRight: "-2.265vw";
+        };
+        right: {
+            marginLeft: "-2.265vw";
+        };
+    };
+}>;
+export declare const gmapPlaceIconLayout: import("@vanilla-extract/recipes").RuntimeFn<{
+    textAlign: {
+        left: {
+            marginRight: "calc(50% - 2.265vw)";
+        };
+        right: {
+            marginLeft: "calc(50% - 2.265vw)";
+        };
+    };
+}>;
 export declare const placeIcon: string;
 export declare const label: string;

package/dist/business-components/PlaceCircle/PlaceCircle.d.ts

@@ -1,8 +1,8 @@
-interface PlaceCircleProps {
+export interface PlaceCircleProps {
     position: [number, number];
     label?: string;
+    textAlign?: "left" | "right";
 }
 export declare const APlaceCircle: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<PlaceCircleProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<PlaceCircleProps, Required<PlaceCircleProps>>, never, PlaceCircleProps, {}>;
 export declare const GPlaceCircle: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<PlaceCircleProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<PlaceCircleProps, Required<PlaceCircleProps>>, never, PlaceCircleProps, {}>;
 export declare const PlaceCircle: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<PlaceCircleProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<PlaceCircleProps, Required<PlaceCircleProps>>, never, PlaceCircleProps, {}>;
-export {};

package/dist/components/Amap/Amap.d.ts

@@ -1,7 +1,10 @@
-export interface AmapProps extends AMap.MapOptions {
-    onMapMove?: (e: {
-        type: "mapmove";
-        target: AMap.Map;
-    }) => void;
+import type { SetMap } from "../../hooks/useHeycarMap";
+import type { MapEventHandler } from "../../types/mapHelper";
+import type { VectorMapForeign } from "../../utils/transform";
+export interface AmapProps extends Omit<AMap.MapOptions, "vectorMapForeign"> {
+    vectorMapForeign?: VectorMapForeign;
+    mapRef?: SetMap<AMap.Map>;
+    onDragStart?: MapEventHandler<AMap.Map>;
+    onDragEnd?: MapEventHandler<AMap.Map>;
 }
-export declare const Amap: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<AmapProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<AmapProps, Required<AmapProps>>, "mapMove", AmapProps, {}>;
+export declare const Amap: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<AmapProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<AmapProps, Required<AmapProps>>, "dragStart" | "dragEnd", AmapProps, {}>;

package/dist/components/Demo/HeycarDemo.d.ts

@@ -1,2 +1,2 @@
 export declare const HeycarDemo: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<unknown>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<unknown, Required<unknown>>, never, unknown, {}>;
-export declare const Hello: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<unknown>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<unknown, Required<unknown>>, never, unknown, {}>;
+export declare const SomePage: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<unknown>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<unknown, Required<unknown>>, never, unknown, {}>;

package/dist/components/Gmap/Gmap.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="google.maps" />
-export interface GampProps extends google.maps.MapOptions {
-    onCenter_changed?: (e: {
-        target: google.maps.Map;
-    }) => void;
+import type { SetMap } from "../../hooks/useHeycarMap";
+import type { MapEventHandler } from "../../types/mapHelper";
+export interface GmapProps extends google.maps.MapOptions {
+    mapRef?: SetMap<google.maps.Map>;
+    onDragStart?: MapEventHandler<google.maps.Map>;
+    onDragEnd?: MapEventHandler<google.maps.Map>;
 }
-export declare const Gmap: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<GampProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<GampProps, Required<GampProps>>, "center_changed", GampProps, {}>;
+export declare const Gmap: import("vue-demi").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<GmapProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<GmapProps, Required<GmapProps>>, "dragStart" | "dragEnd", GmapProps, {}>;

package/dist/components/MapProvider/MapProvider.d.ts

@@ -1,9 +1,13 @@
+/// <reference types="google.maps" />
+import type { SetMap } from "../../hooks/useHeycarMap";
 import { AmapProps } from "../Amap";
 import { GmapLoaderProps } from "../GmapLoader";
 import { MapSupplierPayolad } from "./useMapSupplier";
 export type MapProviderProps = MapSupplierPayolad;
 export declare const MapProvider: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<MapSupplierPayolad>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<MapSupplierPayolad, Required<MapSupplierPayolad>>, never, MapSupplierPayolad, {}>;
 export interface HeycarMapProps extends Pick<GmapLoaderProps, "fallback" | "loading">, Pick<AmapProps, "center" | "zoom"> {
-    onChangeCenter?: (value: [number, number]) => any;
+    language?: "en" | "zh";
+    mapRef?: SetMap<AMap.Map> | SetMap<google.maps.Map>;
+    onDragEnd?: (value: [number, number]) => any;
 }
-export declare const HeycarMap: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<HeycarMapProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<HeycarMapProps, Required<HeycarMapProps>>, "changeCenter", HeycarMapProps, {}>;
+export declare const HeycarMap: import("vue").DefineComponent<import("vue/types/v3-component-props").ComponentObjectPropsOptions<HeycarMapProps>, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").Empty, import("../../types/helper").EmitByProps<HeycarMapProps, Required<HeycarMapProps>>, "dragEnd", HeycarMapProps, {}>;

package/dist/hooks/useDrivingRoute.d.ts

@@ -0,0 +1,9 @@
+import { ShallowRef } from "vue-demi";
+import type { Point } from "../types/interface";
+export interface UseDrivingRouteProps {
+    from: Point;
+    to: Point;
+}
+export declare const useADrivingRoute: (props: UseDrivingRouteProps) => ShallowRef<Point[]>;
+export declare const useGDrivingRoute: (props: UseDrivingRouteProps) => ShallowRef<Point[]>;
+export declare const useDrivingRoute: (props: UseDrivingRouteProps) => ShallowRef<Point[]>;