@visitscotland/component-library 5.76.1 → 5.79.2

package/dist/components/components/google-map/GoogleMap.vue.d.ts

@@ -0,0 +1,234 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+type __VLS_WithSlots<T, S> = T & (new () => {
+    $slots: S;
+});
+declare const __VLS_base: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * API Key for Google Maps
+     */
+    apiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Initial center point for the map
+     */
+    center: {
+        type: ObjectConstructor;
+        default: () => {
+            lat: number;
+            lng: number;
+        };
+    };
+    /**
+     * Initial zoom level for the map
+     */
+    zoom: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Map ID as set in the Google Maps Cloud Console,
+     * required for shading, styling, etc.
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Object to set optional map features, otherwise
+     * sensible defaults are set.
+     */
+    googleMapsOptions: {
+        type: ObjectConstructor;
+        default: () => {
+            clickableIcons: boolean;
+            gestureHandling: string;
+            isFractionalZoomEnabled: boolean;
+            renderingTypeVector: boolean;
+        };
+    };
+    /**
+     * The bounds of the map that the user will not be
+     * able to pan past.
+     */
+    mapBounds: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /**
+     * Determines whether the map should zoom out to show
+     * all of Scotland on initial load
+     */
+    initialViewIsScotland: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Determines whether the map should zoom into the markers
+     * displayed, rather than respecting center & zoom props.
+     */
+    isViewToFitMarkers: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Enables/disables tooltips for the markers
+     */
+    isMarkerTooltipsEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Enables/disables tooltips for the polygons
+     */
+    isPolygonTooltipsEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Array of polygon brxm features.
+     */
+    polygonData: {
+        type: ArrayConstructor;
+        default: () => any[];
+    };
+    /**
+     * ISO 639 Language code for map language
+     */
+    languageCode: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Object containing labels of UI Elements
+     */
+    uiLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * API Key for Google Maps
+     */
+    apiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Initial center point for the map
+     */
+    center: {
+        type: ObjectConstructor;
+        default: () => {
+            lat: number;
+            lng: number;
+        };
+    };
+    /**
+     * Initial zoom level for the map
+     */
+    zoom: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Map ID as set in the Google Maps Cloud Console,
+     * required for shading, styling, etc.
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Object to set optional map features, otherwise
+     * sensible defaults are set.
+     */
+    googleMapsOptions: {
+        type: ObjectConstructor;
+        default: () => {
+            clickableIcons: boolean;
+            gestureHandling: string;
+            isFractionalZoomEnabled: boolean;
+            renderingTypeVector: boolean;
+        };
+    };
+    /**
+     * The bounds of the map that the user will not be
+     * able to pan past.
+     */
+    mapBounds: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /**
+     * Determines whether the map should zoom out to show
+     * all of Scotland on initial load
+     */
+    initialViewIsScotland: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Determines whether the map should zoom into the markers
+     * displayed, rather than respecting center & zoom props.
+     */
+    isViewToFitMarkers: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Enables/disables tooltips for the markers
+     */
+    isMarkerTooltipsEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Enables/disables tooltips for the polygons
+     */
+    isPolygonTooltipsEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Array of polygon brxm features.
+     */
+    polygonData: {
+        type: ArrayConstructor;
+        default: () => any[];
+    };
+    /**
+     * ISO 639 Language code for map language
+     */
+    languageCode: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Object containing labels of UI Elements
+     */
+    uiLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+}>> & Readonly<{}>, {
+    center: Record<string, any>;
+    zoom: number;
+    apiKey: string;
+    googleMapsOptions: Record<string, any>;
+    mapBounds: Record<string, any>;
+    initialViewIsScotland: boolean;
+    isViewToFitMarkers: boolean;
+    isMarkerTooltipsEnabled: boolean;
+    isPolygonTooltipsEnabled: boolean;
+    polygonData: unknown[];
+    languageCode: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+type __VLS_Slots = {
+    'vs-google-map-marker'?: (props: {}) => any;
+} & {
+    'no-js'?: (props: {}) => any;
+};

package/dist/components/components/google-map/components/GoogleMapMarker.vue.d.ts

@@ -0,0 +1,73 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+type __VLS_WithSlots<T, S> = T & (new () => {
+    $slots: S;
+});
+declare const __VLS_base: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /** Single object of BRXM Feature data */
+    featureData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /** SVG Compatible colour (Hex/String/RGB()),
+     * Defaults to #33225D (vs-color-background-accent-heather-80 token) */
+    pinColor: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Flag to turn on/off tooltips for the marker */
+    markerTooltipsEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Flag to allow for more granular control of the marker tooltip/active state */
+    handleMarkerBehaviourExternally: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    showTooltip: () => void;
+    hideTooltip: () => void;
+    resetPin: () => void;
+    handleSetMarkerActive: typeof handleSetMarkerActive;
+    handleRemoveMarkerActive: typeof handleRemoveMarkerActive;
+    markerHovered: import('vue').Ref<any, any> & import('vue').ComputedRef<any>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    markerClick: (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /** Single object of BRXM Feature data */
+    featureData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /** SVG Compatible colour (Hex/String/RGB()),
+     * Defaults to #33225D (vs-color-background-accent-heather-80 token) */
+    pinColor: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Flag to turn on/off tooltips for the marker */
+    markerTooltipsEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Flag to allow for more granular control of the marker tooltip/active state */
+    handleMarkerBehaviourExternally: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onMarkerClick?: (...args: any[]) => any;
+}>, {
+    pinColor: string;
+    markerTooltipsEnabled: boolean;
+    handleMarkerBehaviourExternally: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+type __VLS_Slots = {
+    'vs-google-map-marker-content'?: (props: {}) => any;
+} & {
+    'vs-google-map-marker-content'?: (props: {}) => any;
+};
+declare function handleSetMarkerActive(markerID: any): void;
+declare function handleRemoveMarkerActive(markerID: any): void;

package/dist/components/components/google-map/composables/AddPolygon.d.ts

@@ -0,0 +1,2 @@
+import { BrxmFeature } from '../../../types/types';
+export default function addPolygon(map: google.maps.Map, feature: BrxmFeature, isPolygonTooltipsEnabled: boolean): void;

package/dist/components/components/google-map/composables/AddTooltip.d.ts

@@ -0,0 +1,30 @@
+import { BrxmFeatureProperties } from '../../../types/types';
+export default function createTooltip(mapsLibrary: google.maps.MapsLibrary): {
+    new (map: google.maps.Map, location: google.maps.LatLng, properties: BrxmFeatureProperties, isMarker?: boolean): {
+        map: google.maps.Map;
+        location: google.maps.LatLng;
+        properties: BrxmFeatureProperties;
+        isMarker: boolean;
+        tooltipContainer?: HTMLDivElement;
+        onAdd(): void;
+        onRemove(): void;
+        draw(): void;
+        toggleDOM(): void;
+        show(): void;
+        hide(): void;
+        getMap(): google.maps.Map | google.maps.StreetViewPanorama | null | undefined;
+        getPanes(): google.maps.MapPanes | null | undefined;
+        getProjection(): google.maps.MapCanvasProjection;
+        setMap(map: google.maps.Map | google.maps.StreetViewPanorama | null): void;
+        addListener(eventName: string, handler: Function): google.maps.MapsEventListener;
+        bindTo(key: string, target: google.maps.MVCObject, targetKey?: string | null, noNotify?: boolean): void;
+        get(key: string): any;
+        notify(key: string): void;
+        set(key: string, value: unknown): void;
+        setValues(values?: object | null): void;
+        unbind(key: string): void;
+        unbindAll(): void;
+    };
+    preventMapHitsAndGesturesFrom(element: Element): void;
+    preventMapHitsFrom(element: Element): void;
+};

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

@@ -43,6 +43,8 @@ export { default as VsFooterCopyright } from './footer/components/FooterCopyrigh
 export { default as VsGlobalMenu } from './global-menu/GlobalMenu.vue';
 export { default as VsGlobalMenuLanguage } from './global-menu/components/GlobalMenuLanguage.vue';
 export { default as VsGlobalMenuLanguageItem } from './global-menu/components/GlobalMenuLanguageItem.vue';
+export { default as VsGoogleMap } from './google-map/GoogleMap.vue';
+export { default as VsGoogleMapMarker } from './google-map/components/GoogleMapMarker.vue';
 export { default as VsCol } from './grid/Col.vue';
 export { default as VsContainer } from './grid/Container.vue';
 export { default as VsRow } from './grid/Row.vue';

package/dist/components/components/mega-nav/MegaNav.vue.d.ts

@@ -318,7 +318,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         duration_base: string;
         duration_slowly: string;
     };
-    visitscotlandLogo: string;
+    visitscotlandLogo: any;
 }, {}, {
     /**
      * Toggles dropdown menu property
@@ -830,7 +830,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     routerTag?: string;
                     stretched?: boolean;
                     target?: import('bootstrap-vue-next').LinkTarget;
-                    to?: RouteLocationRaw;
+                    to?: visitscotlandLogo;
                     underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -915,7 +915,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     routerTag?: string;
                     stretched?: boolean;
                     target?: import('bootstrap-vue-next').LinkTarget;
-                    to?: RouteLocationRaw;
+                    to?: visitscotlandLogo;
                     underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -992,7 +992,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                 routerTag?: string;
                 stretched?: boolean;
                 target?: import('bootstrap-vue-next').LinkTarget;
-                to?: RouteLocationRaw;
+                to?: visitscotlandLogo;
                 underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -2133,7 +2133,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                         routerTag?: string;
                         stretched?: boolean;
                         target?: import('bootstrap-vue-next').LinkTarget;
-                        to?: RouteLocationRaw;
+                        to?: visitscotlandLogo;
                         underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                         underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                         underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -2218,7 +2218,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                         routerTag?: string;
                         stretched?: boolean;
                         target?: import('bootstrap-vue-next').LinkTarget;
-                        to?: RouteLocationRaw;
+                        to?: visitscotlandLogo;
                         underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                         underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                         underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -2295,7 +2295,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     routerTag?: string;
                     stretched?: boolean;
                     target?: import('bootstrap-vue-next').LinkTarget;
-                    to?: RouteLocationRaw;
+                    to?: visitscotlandLogo;
                     underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -2819,7 +2819,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     routerTag?: string;
                     stretched?: boolean;
                     target?: import('bootstrap-vue-next').LinkTarget;
-                    to?: RouteLocationRaw;
+                    to?: visitscotlandLogo;
                     underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -2904,7 +2904,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     routerTag?: string;
                     stretched?: boolean;
                     target?: import('bootstrap-vue-next').LinkTarget;
-                    to?: RouteLocationRaw;
+                    to?: visitscotlandLogo;
                     underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                     underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -2981,7 +2981,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                 routerTag?: string;
                 stretched?: boolean;
                 target?: import('bootstrap-vue-next').LinkTarget;
-                to?: RouteLocationRaw;
+                to?: visitscotlandLogo;
                 underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -3627,7 +3627,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                 routerTag?: string;
                 stretched?: boolean;
                 target?: import('bootstrap-vue-next').LinkTarget;
-                to?: RouteLocationRaw;
+                to?: visitscotlandLogo;
                 underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -3712,7 +3712,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                 routerTag?: string;
                 stretched?: boolean;
                 target?: import('bootstrap-vue-next').LinkTarget;
-                to?: RouteLocationRaw;
+                to?: visitscotlandLogo;
                 underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
                 underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;
@@ -3789,7 +3789,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             routerTag?: string;
             stretched?: boolean;
             target?: import('bootstrap-vue-next').LinkTarget;
-            to?: RouteLocationRaw;
+            to?: visitscotlandLogo;
             underlineOffset?: import('bootstrap-vue-next').UnderlineOffset;
             underlineOffsetHover?: import('bootstrap-vue-next').UnderlineOffset;
             underlineOpacity?: import('bootstrap-vue-next').UnderlineOpacity;