@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/map/Map.vue.d.ts

@@ -0,0 +1,370 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Starting latitude for map view
+     */
+    overviewMapLatitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Starting longitude for map view
+     */
+    overviewMapLongitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Starting zoom level for map view
+     */
+    overviewMapZoom: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Unique ID for the map
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether or not the map is visible
+     * used for triggering resize
+     */
+    isVisible: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * Place data for markers
+     */
+    places: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Category filters array
+     */
+    filters: {
+        type: ArrayConstructor;
+        default(): any[];
+    };
+    /**
+     * Whether the map should fit to marker bounds
+     */
+    fitToMarkers: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether the map should show regions polygons
+     */
+    showPolygons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The current selectdd item
+     */
+    selectedItem: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+     * Data to set map bounds
+     */
+    boundsData: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /** If the map should show an info message defined
+     * a slot
+     */
+    showInfoMessage: {
+        type: BooleanConstructor;
+        default: any;
+    };
+    /**
+     * Allows parent component to fire a reset zoom event
+    */
+    resetZoom: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Turn popups off on map markers
+     */
+    showMarkerPopups: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, void, {
+    isDesktop: boolean;
+    geojsonData: {
+        type: string;
+        features: any[];
+    };
+    polygons: {
+        type: string;
+        features: any[];
+    };
+    multiPolygons: any[];
+    mapbox: {
+        map: any;
+        bounds: any;
+        rotation: number;
+        config: {
+            container: unknown;
+            style: string;
+            pitchWithRotate: boolean;
+            dragRotate: boolean;
+        };
+    };
+    markers: any[];
+    popup: any;
+    hoveredStateId: any;
+    activeStateId: any;
+    showMapMessage: boolean;
+    isLoading: boolean;
+    showZoomMessage: any;
+}, {
+    activeMarkerPostion: () => any;
+    highlightedPlace: () => any;
+    activePlace: () => any;
+    getZoom(): any;
+}, {
+    /**
+     * Adds a mapbox map to the page
+     */
+    addMap(): void;
+    /**
+     * Adds mapbox map controls
+     */
+    addMapControls(): void;
+    /**
+     * Initialise features array for points & polygons
+     */
+    initialiseMapFeatures(): void;
+    /**
+     * Returns correct coordinates for points & polygons
+     */
+    getCoordinateArray(place: any): any[];
+    /**
+     * Returns object for a map feature
+     * including points, polygons or multi-polygons
+     */
+    getMapFeatures(place: any, coordinateArray: any): number;
+    /**
+     * Returns object for itinerary points
+     */
+    getItineraryMapFeatures(place: any): number;
+    /**
+     * Initialise add map markers
+     */
+    initialiseMapMarkers(): void;
+    /**
+     * Creates a map marker component instance for a point
+     * and appends it to the map
+     */
+    createMapMarker(feature: any): void;
+    /**
+     * Hide all polygons
+     */
+    hideMapPolygons(): void;
+    /**
+     * Show all polygons
+     */
+    showMapPolygons(): void;
+    /**
+     * Add polygons from data into map
+     */
+    addMapPolygons(): void;
+    /**
+     * Remove the current active polygon
+     */
+    removeActivePolygon(): void;
+    /**
+     * Add a new active polygon
+     */
+    addActivePolygon(feature: any): void;
+    /**
+     * Remove the current hovered polygon
+     */
+    removeHoveredPolygon(): void;
+    /**
+     * Add a hovered polygon
+     */
+    addHoveredPolygon(feature: any): void;
+    /**
+     * Add a map popup when feature is hovered
+     */
+    addMapPopup(feature: any): void;
+    /**
+     * Remove the popup from the map
+     */
+    removeMapPopup(marker: any): void;
+    /**
+     * Get coordinates to decide where to show popup
+     */
+    getCoordinates(feature: any): any;
+    /**
+     * Find the centre of a polygon to display popup
+     */
+    findFeatureCentre(markers: any): {
+        lat: number;
+        lng: number;
+    };
+    /**
+     * Get correct popup html based on map feature type
+     */
+    getPopupHtml(feature: any): string;
+    /**
+     * Detect keyboard nav to toggle popup
+     */
+    setupMarkerListeners(marker: any): void;
+    /**
+     * Ensures map fits to bounds
+     */
+    fitToBounds(): void;
+    /**
+     * Initialises the map component
+     */
+    initialiseMapComponent(): void;
+    /**
+     * Initialises lazy loading
+     */
+    lazyloadMapComponent(): void;
+    /**
+     * Checks for window size on resize
+     */
+    onResize(): void;
+    /**
+     * Creates a map bounding object from polygon data
+     */
+    getBoundsFromPolygon(): any;
+    /**
+     * Check a marker is visible on the map
+     */
+    checkPointIsVisible(): any;
+    /**
+     * Reposition map to centre on point
+     */
+    centreMapOnPoint(coords: any): void;
+    /**
+     * Calculate bounding box depending on data provided
+    */
+    calculateBoundingBox(): any;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Starting latitude for map view
+     */
+    overviewMapLatitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Starting longitude for map view
+     */
+    overviewMapLongitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Starting zoom level for map view
+     */
+    overviewMapZoom: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Unique ID for the map
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether or not the map is visible
+     * used for triggering resize
+     */
+    isVisible: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * Place data for markers
+     */
+    places: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Category filters array
+     */
+    filters: {
+        type: ArrayConstructor;
+        default(): any[];
+    };
+    /**
+     * Whether the map should fit to marker bounds
+     */
+    fitToMarkers: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether the map should show regions polygons
+     */
+    showPolygons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The current selectdd item
+     */
+    selectedItem: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+     * Data to set map bounds
+     */
+    boundsData: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /** If the map should show an info message defined
+     * a slot
+     */
+    showInfoMessage: {
+        type: BooleanConstructor;
+        default: any;
+    };
+    /**
+     * Allows parent component to fire a reset zoom event
+    */
+    resetZoom: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Turn popups off on map markers
+     */
+    showMarkerPopups: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    filters: unknown[];
+    overviewMapLatitude: string;
+    overviewMapLongitude: string;
+    overviewMapZoom: string;
+    fitToMarkers: boolean;
+    showPolygons: boolean;
+    selectedItem: Record<string, any>;
+    boundsData: Record<string, any>;
+    showInfoMessage: boolean;
+    resetZoom: boolean;
+    showMarkerPopups: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/map/components/MapMarker.vue.d.ts

@@ -0,0 +1,87 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Details for the marker
+     */
+    feature: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Id for the map - to be used with
+     * the map store
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * If the map has enabled popups for markers
+     */
+    hasPopups: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * Selected place ID
+     */
+    selectedPlace: {
+        type: StringConstructor;
+        default: any;
+    };
+}, void, any, {
+    getMarkerIcon(): any;
+    highlightedPlace: () => any;
+    activePlace: () => any;
+    activeSubcat: () => any;
+    isActive(): boolean;
+}, {
+    /**
+     * Fires on click of the marker
+     */
+    markerClick(): void;
+    /**
+     * Fires on hover over the maker
+     */
+    handleHover(feature: any): void;
+    /**
+     * Sets up event listener to remove active
+     * marker on map click
+     */
+    handleClickEvent(e: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("showDetail" | "setCategory")[], "showDetail" | "setCategory", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Details for the marker
+     */
+    feature: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Id for the map - to be used with
+     * the map store
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * If the map has enabled popups for markers
+     */
+    hasPopups: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * Selected place ID
+     */
+    selectedPlace: {
+        type: StringConstructor;
+        default: any;
+    };
+}>> & {
+    onShowDetail?: (...args: any[]) => any;
+    onSetCategory?: (...args: any[]) => any;
+}, {
+    selectedPlace: string;
+}, {}>;
+export default _default;

package/dist/components/components/map/index.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    export { VsMap };
+    export { VsMapMarker };
+}
+export default _default;
+import VsMap from './Map.vue';
+import VsMapMarker from './components/MapMarker.vue';

package/dist/components/components/map-marker-icon/MapMarkerIcon.vue.d.ts

@@ -0,0 +1,50 @@
+declare const _default: import("vue").DefineComponent<{
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    isHovered: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    number: {
+        type: StringConstructor;
+        default: string;
+    };
+    isMapMarker: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {
+    mapMarkerType(): string;
+    parentClasses(): "" | "vs-map-marker-icon--map-marker";
+    markerClasses(): string[];
+}, {}, {
+    methods: {
+        getIconDetails(name: any): {
+            name: string;
+        };
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    isHovered: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    number: {
+        type: StringConstructor;
+        default: string;
+    };
+    isMapMarker: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    number: string;
+    isMapMarker: boolean;
+    isHovered: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/map-marker-icon/index.d.ts

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsMapMarkerIcon };
+}
+export default _default;
+import VsMapMarkerIcon from './MapMarkerIcon.vue';