@phila/phila-ui-map-core 0.0.1-beta.2 → 0.0.1-beta.3

package/dist/composables.d.ts

@@ -1,30 +1,45 @@
 import { IControl } from 'maplibre-gl';
-import { Map as Map_2 } from 'maplibre-gl';
 import { Ref } from 'vue';
 
-declare interface ButtonControl extends IControl {
-    _map?: Map_2;
-    _container?: HTMLDivElement;
-    _button?: HTMLButtonElement;
-}
+/** Common position type for map controls */
+declare type MapControlPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right";
 
 /**
- * Factory for creating standard button controls
+ * Composable for adding MapLibre controls to the map.
+ *
+ * This composable handles positioning controls in MapLibre's corner containers
+ * (top-left, top-right, etc.) and automatic cleanup on unmount.
+ *
+ * ## What is IControl?
+ *
+ * IControl is MapLibre's interface for map controls. It's not a class you extend -
+ * it's a TypeScript interface that uses "duck typing": any object with the right
+ * methods qualifies. The required methods are:
+ *
+ *   - onAdd(map): Called when control is added. Must return an HTMLElement.
+ *   - onRemove(): Called when control is removed. Handle any cleanup here.
+ *
+ * So this plain object is a valid IControl:
+ *
+ *   { onAdd() { return myDiv; }, onRemove() {} }
+ *
+ * ## Usage
+ *
+ * For Vue template-based controls (MapButton, MapSearchControl, BasemapDropdown),
+ * pass a ref to the container element. The composable creates the IControl internally,
+ * returning your Vue template's DOM element from onAdd():
+ *
+ *   const containerRef = ref<HTMLElement | null>(null);
+ *   useMapControl(props, containerRef);
+ *
+ * For MapLibre's built-in controls (like NavigationControl), pass a function that
+ * returns the control. These already implement IControl internally:
+ *
+ *   useMapControl(props, () => new maplibregl.NavigationControl());
  */
-export declare function createButtonControl(icon?: string, image?: string, title?: string, iconSize?: number, clickHandler?: (this: GlobalEventHandlers, ev: MouseEvent) => void): ButtonControl;
-
-declare interface MapControlProps {
-    position?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
-}
-
-/**
- * Composable for creating MapLibre IControl components
- * Handles the boilerplate of adding/removing controls
- */
-export declare function useMapControl(props: MapControlProps, createControlFn: (map: Map_2) => IControl | Promise<IControl>): {
-    map: Ref<Map_2 | null, Map_2 | null> | undefined;
-    control: null;
-};
+export declare function useMapControl(props: {
+    position?: MapControlPosition;
+}, controlOrContainer: Ref<HTMLElement | null> | (() => IControl)): void;
 
 export { }
 

package/dist/composables.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("./index-K0bKFr5g.cjs");exports.createButtonControl=o.createButtonControl;exports.useMapControl=o.useMapControl;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useMapControl-CGjWu6ME.cjs");exports.useMapControl=e.useMapControl;

package/dist/composables.mjs

@@ -1,5 +1,4 @@
-import { q as r, u as a } from "./index-DJPTWX6O.js";
+import { u as a } from "./useMapControl-CmoJ03wJ.js";
 export {
-  r as createButtonControl,
   a as useMapControl
 };