@kizmann/pico-js 2.0.13 → 2.1.0

package/types/wip/Element.d.ts

@@ -0,0 +1,119 @@
+export declare class PicoElement {
+    /**
+     * Prefix for attribute selector.
+     */
+    static prefix: string;
+    /**
+     * Mounted identifier.
+     */
+    static mount: string;
+    /**
+     * Instance storage.
+     */
+    static inis: {};
+    /**
+     * Runtime storage.
+     */
+    static runs: any[];
+    /**
+     * Instance storage.
+     */
+    static invi: any[];
+    /**
+     * Listen to scroll events
+     *
+     * @example PicoElement.listen()
+     *
+     * @returns {void} No return value
+     */
+    static listen(): void;
+    /**
+     * Handle scroll visibility
+     *
+     * @example PicoElement.scroll()
+     *
+     * @returns {void} No return value
+     */
+    static scroll(): void;
+    /**
+     * Register element alias
+     *
+     * @example PicoElement.alias("tab", Tab)
+     *
+     * @param {string} key Alias key
+     * @param {any} instance Class instance
+     * @returns {PicoElement} Current class
+     */
+    static alias(key: any, instance: any): typeof PicoElement;
+    /**
+     * Bind element to selector
+     *
+     * @example PicoElement.bind("tab", ".tabs")
+     *
+     * @param {string} key Alias key
+     * @param {any} selector Dom selector
+     * @param {any} [options] Init options
+     * @returns {PicoElement} Current class
+     */
+    static bind(key: any, selector: any, options?: {}): void | typeof PicoElement;
+    /**
+     * Unbind element from selector
+     *
+     * @example PicoElement.unbind("tab", ".tabs")
+     *
+     * @param {string} key Alias key
+     * @param {any} selector Dom selector
+     * @param {any} [options] Init options
+     * @returns {PicoElement} Current class
+     */
+    static unbind(key: any, selector: any, options?: {}): void | typeof PicoElement;
+    /**
+     * Observe DOM changes
+     *
+     * @example PicoElement.observe("tab")
+     *
+     * @param {string} key Alias key
+     * @param {boolean} [plain] Plain options
+     * @returns {PicoElement} Current class
+     */
+    static observe(key: any, plain?: boolean): typeof PicoElement;
+    /**
+     * Bind element on inview
+     *
+     * @example PicoElement.bindInview(el, cb)
+     *
+     * @param {Element} el Target element
+     * @param {function} cb Callback fn
+     * @returns {void} No return value
+     */
+    static bindInview(el: any, cb: any): void;
+    /**
+     * Unbind element on inview
+     *
+     * @example PicoElement.unbindInview(el, cb)
+     *
+     * @param {Element} el Target element
+     * @param {function} cb Callback fn
+     * @returns {void} No return value
+     */
+    static unbindInview(el: any, cb: any): void;
+    /**
+     * Get attribute prefix
+     *
+     * @example PicoElement.getPrefix("tab") // => "js-tab"
+     *
+     * @param {string} [key] Alias key
+     * @returns {string} Attribute prefix
+     */
+    static getPrefix(key: any): string;
+    /**
+     * Set attribute prefix
+     *
+     * @example PicoElement.setPrefix("pi")
+     *
+     * @param {string} prefix New prefix
+     * @returns {void} No return value
+     */
+    static setPrefix(prefix: any): void;
+}
+export default PicoElement;

package/types/wip/Map.d.ts

@@ -0,0 +1,281 @@
+/**
+ * @const {object} google
+ */
+export declare class PicoMap {
+    /**
+     * @type {any[]}
+     */
+    static mapStyle: any[];
+    /**
+     * @type {object}
+     */
+    static markerStyles: any;
+    /**
+     * @type {boolean}
+     */
+    static hideMarkers: boolean;
+    /**
+     * @type {boolean}
+     */
+    static closeInfoWindows: boolean;
+    /**
+     * @type {any}
+     */
+    map: any;
+    /**
+     * @type {any}
+     */
+    markers: any;
+    /**
+     * @type {any}
+     */
+    cluster: any;
+    /**
+     * @type {any}
+     */
+    clusterFilter: any;
+    /**
+     * @type {any}
+     */
+    clusterOptions: any;
+    /**
+     * Create map instance
+     *
+     * @example new Map("#map", { lat: 0, lng: 0 })
+     *
+     * @param {any} el Target element
+     * @param {any} [options] Map options
+     */
+    constructor(el: any, options?: any);
+    /**
+     * Set global map style
+     *
+     * @example Map.setMapStyle(style)
+     *
+     * @param {any[]} [style] Style array
+     * @returns {PicoMap} Current class
+     */
+    static setMapStyle(style?: any[]): typeof PicoMap;
+    /**
+     * Set marker style
+     *
+     * @example Map.setMarkerStyle("default", { default: "icon.png" })
+     *
+     * @param {string} key Style key
+     * @param {any} [style] Style options
+     * @param {any} [extra] Extra options
+     * @returns {typeof PicoMap} Current class
+     */
+    static setMarkerStyle(key: string, style?: any, extra?: any): typeof PicoMap;
+    /**
+     * Cluster map markers
+     *
+     * @example map.clusterMarkers()
+     *
+     * @param {any} [options] Cluster options
+     * @param {any} [filter] Marker filter
+     * @param {boolean} [allowCreate] Create cluster
+     * @returns {void} No return value
+     */
+    clusterMarkers(options?: any, filter?: any, allowCreate?: boolean): void;
+    /**
+     * Apply style to marker
+     *
+     * @example map.styleMarker("m1", "hover")
+     *
+     * @param {string} key Marker key
+     * @param {any} [type] Style type
+     * @returns {void} No return value
+     */
+    styleMarker(key: string, type?: any): void;
+    /**
+     * Get marker by key
+     *
+     * @example map.getMarker("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {any} Marker object
+     */
+    getMarker(key: string): any;
+    /**
+     * Check if marker is visible
+     *
+     * @example map.getMarkerVisibility("m1") // => true
+     *
+     * @param {string} key Marker key
+     * @param {boolean} [fallback] Fallback value
+     * @returns {boolean} Visibility state
+     */
+    getMarkerVisibility(key: string, fallback?: boolean): boolean;
+    /**
+     * Get marker position
+     *
+     * @example map.getMarkerPositon("m1") // => LatLng
+     *
+     * @param {string} key Marker key
+     * @param {any} [fallback] Fallback value
+     * @returns {any} Position object
+     */
+    getMarkerPositon(key: string, fallback?: any): any;
+    /**
+     * Toggle marker visibility
+     *
+     * @example map.toggleMarker("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {boolean} Visibility state
+     */
+    toggleMarker(key: string): boolean;
+    /**
+     * Show marker on map
+     *
+     * @example map.showMarker("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {boolean} Previous state
+     */
+    showMarker(key: string): boolean;
+    /**
+     * Hide marker on map
+     *
+     * @example map.hideMarker("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {boolean} Previous state
+     */
+    hideMarker(key: string): boolean;
+    /**
+     * Marker hover enter
+     *
+     * @example map.enterMarker("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {PicoMap} Current instance
+     */
+    enterMarker(key: string): PicoMap;
+    /**
+     * Marker hover leave
+     *
+     * @example map.leaveMarker("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {PicoMap} Current instance
+     */
+    leaveMarker(key: string): PicoMap;
+    /**
+     * Check if info is open
+     *
+     * @example map.getInfoVisibility("m1") // => true
+     *
+     * @param {string} key Marker key
+     * @param {boolean} [fallback] Fallback value
+     * @returns {boolean} Visibility state
+     */
+    getInfoVisibility(key: string, fallback?: boolean): boolean;
+    /**
+     * Toggle info window
+     *
+     * @example map.toggleInfo("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {boolean} Visibility state
+     */
+    toggleInfo(key: string): boolean;
+    /**
+     * Open info window
+     *
+     * @example map.openInfo("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {boolean} Previous state
+     */
+    openInfo(key: string): boolean;
+    /**
+     * Close info window
+     *
+     * @example map.closeInfo("m1")
+     *
+     * @param {string} key Marker key
+     * @returns {boolean} Previous state
+     */
+    closeInfo(key: string): boolean;
+    /**
+     * Create map marker
+     *
+     * @example map.createMarker("m1", { lat: 0, lng: 0 })
+     *
+     * @param {any} [key] Marker key
+     * @param {any} [options] Marker options
+     * @returns {any} Marker object
+     */
+    createMarker(key?: any, options?: any): any;
+    /**
+     * Set marker position
+     *
+     * @example map.setMarkerPosition("m1", { lat: 0, lng: 0 })
+     *
+     * @param {string} key Marker key
+     * @param {any} [options] Position options
+     * @returns {void} No return value
+     */
+    setMarkerPosition(key: string, options?: any): void;
+    /**
+     * Set marker by address
+     *
+     * @example map.setMarkerByAddress("m1", "Address")
+     *
+     * @param {string} key Marker key
+     * @param {any} address Search address
+     * @returns {Promise<any>} Response promise
+     */
+    setMarkerByAddress(key: string, address: any): Promise<any>;
+    /**
+     * Get location by address
+     *
+     * @example map.getLocationByAddress("Address")
+     *
+     * @param {any} address Search address
+     * @param {Function} [callback] Success callback
+     * @returns {Promise<any>} Response promise
+     */
+    getLocationByAddress(address: any, callback?: Function): Promise<any>;
+    /**
+     * Show markers on map
+     *
+     * @example map.showMarkers()
+     *
+     * @param {any} [filter] Marker filter
+     * @returns {PicoMap} Current instance
+     */
+    showMarkers(filter?: any): PicoMap;
+    /**
+     * Get marker boundary
+     *
+     * @example map.getMarkerBoundry() // => LatLngBounds
+     *
+     * @param {any} [filter] Marker filter
+     * @returns {any} Boundary object
+     */
+    getMarkerBoundry(filter?: any): any;
+    /**
+     * Focus markers on map
+     *
+     * @example map.focusMarkers()
+     *
+     * @param {any} [filter] Marker filter
+     * @param {number} [maxZoom] Max zoom level
+     * @param {number} [boundSpace] Viewport space
+     * @returns {PicoMap} Current instance
+     */
+    focusMarkers(filter?: any, maxZoom?: number, boundSpace?: number): PicoMap;
+    /**
+     * Render directions on map
+     *
+     * @example map.renderDirections({ origin: "A", destination: "B" })
+     *
+     * @param {any} options Render options
+     * @returns {Promise<any>} Response promise
+     */
+    renderDirections(options: any): Promise<any>;
+}
+export default PicoMap;