@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/map-with-sidebar/components/MapWithSidebarPanel.vue.d.ts

@@ -0,0 +1,274 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Heading for the categories view
+     */
+    categoryHeading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Heading level for panel header
+     */
+    headingLevel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Currently selected category
+     */
+    selectedCategory: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Currently selected subcategory
+     */
+    selectedSubcategory: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * The current stage
+     */
+    currentStage: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * The ID of thecurrently selected item
+     */
+    selectedItem: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+     * The ID of the currently hover item
+     */
+    hovered: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The ID of the currently hover item
+     */
+    subcategoryLocations: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Place data defined from endpoint
+     */
+    currentEndpointData: {
+        type: ArrayConstructor;
+        default: () => any[];
+    };
+    /**
+     * Whether or not to show a panel message
+     */
+    panelStatus: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * A message that appears at the bottom
+     * of the side panel
+     */
+    panelMessage: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Total amount of places coming from endpoint.
+     * Used to work out if there's more to load in panel.
+     */
+    totalPins: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The number of the list item that should be focussed
+     * on creation
+     */
+    currentListItemFocus: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, any, {
+    placesLoaded: number;
+}, {
+    detailHeadingLevel(): string;
+    showLoadMore(): boolean;
+    subCatFilterCount: () => any;
+    currentHeading(): string;
+    currentData(): unknown;
+    panelClasses(): string;
+    headerClasses(): "" | "vs-map-with-sidebar-panel__header-section--with-spacer" | "vs-map-with-sidebar-panel__header-section--overlapped";
+    currentFilter(): string;
+    currentPlaceData(): any;
+    selectedSubcategoryData(): any;
+}, {
+    /**
+     * Emits 'close-panel'
+     */
+    closePanel(): void;
+    /**
+     * Moves back stages dependent on current state
+     */
+    stageBack(): void;
+    /**
+     * Resets the panel
+     */
+    resetPanel(): void;
+    /**
+     * Emits the current stage
+     */
+    setStage(stageNum: any): void;
+    /**
+     * Determines whether or not a subCategory
+     * array exists and has data in it
+     */
+    subCatExists(cat: any): boolean;
+    /**
+     * transforms endpoint data into format to be used
+     */
+    refineEndpointData(data: any): {
+        isEndpoint: boolean;
+        properties: {
+            category: any;
+            id: any;
+            image: any;
+            placeTitle: any;
+            description: any;
+            link: {
+                label: any;
+                link: any;
+                type: any;
+            };
+            website: {
+                label: any;
+                link: any;
+                type: any;
+            };
+            address: {
+                shortAddress: string;
+            };
+        };
+    }[];
+    /**
+     * clear the subcategory filters
+    */
+    clearSubCatFilters(): void;
+    /**
+     * Load more places from endpoint
+    */
+    loadMorePlaces(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Heading for the categories view
+     */
+    categoryHeading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Heading level for panel header
+     */
+    headingLevel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Currently selected category
+     */
+    selectedCategory: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Currently selected subcategory
+     */
+    selectedSubcategory: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * The current stage
+     */
+    currentStage: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * The ID of thecurrently selected item
+     */
+    selectedItem: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+     * The ID of the currently hover item
+     */
+    hovered: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The ID of the currently hover item
+     */
+    subcategoryLocations: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Place data defined from endpoint
+     */
+    currentEndpointData: {
+        type: ArrayConstructor;
+        default: () => any[];
+    };
+    /**
+     * Whether or not to show a panel message
+     */
+    panelStatus: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * A message that appears at the bottom
+     * of the side panel
+     */
+    panelMessage: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Total amount of places coming from endpoint.
+     * Used to work out if there's more to load in panel.
+     */
+    totalPins: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The number of the list item that should be focussed
+     * on creation
+     */
+    currentListItemFocus: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>>, {
+    selectedItem: Record<string, any>;
+    headingLevel: string;
+    categoryHeading: string;
+    selectedCategory: string;
+    selectedSubcategory: string;
+    hovered: string;
+    subcategoryLocations: unknown[];
+    currentEndpointData: unknown[];
+    panelStatus: string;
+    panelMessage: string;
+    totalPins: number;
+    currentListItemFocus: number;
+}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/components/MapWithSidebarSubcategory.vue.d.ts

@@ -0,0 +1,35 @@
+declare const _default: import("vue").DefineComponent<{
+    /** Data for subcategory */
+    data: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    selectedSubCategory: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, {
+    selected: any[];
+}, {
+    activeSubcatFilters: () => any;
+}, {
+    /**
+     * Emits data of checkboxes currently selected
+     */
+    checkboxesChangeSubmit(): void;
+    /**
+     * Emits change event declaring if any selections have been made
+     */
+    emitChange(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /** Data for subcategory */
+    data: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    selectedSubCategory: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/index.d.ts

@@ -0,0 +1,19 @@
+declare namespace _default {
+    export { VsMapWithSidebar };
+    export { VsMapWithSidebarPanel };
+    export { VsMapWithSidebarCategory };
+    export { VsMapWithSidebarListItem };
+    export { VsMapWithSidebarDetail };
+    export { VsMapWithSidebarButtons };
+    export { VsMapWithSidebarSubcategory };
+    export { VsMapWithSidebarControls };
+}
+export default _default;
+import VsMapWithSidebar from './MapWithSidebar.vue';
+import VsMapWithSidebarPanel from './components/MapWithSidebarPanel.vue';
+import VsMapWithSidebarCategory from './components/MapWithSidebarCategory.vue';
+import VsMapWithSidebarListItem from './components/MapWithSidebarListItem.vue';
+import VsMapWithSidebarDetail from './components/MapWithSidebarDetail.vue';
+import VsMapWithSidebarButtons from './components/MapWithSidebarButtons.vue';
+import VsMapWithSidebarSubcategory from './components/MapWithSidebarSubcategory.vue';
+import VsMapWithSidebarControls from './components/MapWithSidebarControls.vue';

package/dist/components/components/marketo-form/MarketoForm.vue.d.ts

@@ -0,0 +1,284 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL for the form data file
+     */
+    dataUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Recaptcha site key string
+     */
+    recaptchaKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Text for invisible recaptcha textarea - tells
+     * screenreader users it's not needed
+     */
+    recaptchaTextareaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * If the form should use sandbox or live Marketo details
+     */
+    isProd: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Munchkin ID for the Marketo environment
+     */
+    munchkinId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Marketo instance URL for the form
+     */
+    marketoInstance: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Language indicator for content
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * URL for generic messaging config
+     */
+    messagingUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * URL for generic messaging config
+     */
+    countryListUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    submitted: boolean;
+    submitting: boolean;
+    submitError: boolean;
+    formData: {};
+    messagingData: {};
+    form: {};
+    formIsInvalid: boolean;
+    showErrorMessage: boolean;
+    errorFields: any[];
+    triggerValidate: boolean;
+    recaptchaVerified: boolean;
+    conditionalFields: {};
+    inputVal: string;
+    reAlertErrors: boolean;
+}, {
+    formId(): any;
+    showFormHeading(): boolean;
+}, {
+    /**
+     * Called on component created. Loads the json file located at this.dataUrl which
+     * contains all of the question data, localisations and validation.
+     */
+    getFormData(): void;
+    /**
+     * Called on component created. Loads the generic messaging files which provide
+     * global validation and submission messages and localisations.
+     */
+    getGlobalMessaging(): void;
+    /**
+     * Retrieves the subset of info from a formdata json files which relates to the
+     * current language. This is used in all translation functions to check if a
+     * translation for a given string is provided.
+     */
+    getLanguageObj(): any;
+    /**
+     * Attempts to retrieve the label for a given field from the current language obj.
+     * If no localisation is available, or the langauge is en, falls back to the default
+     * label for the fieldname.
+     */
+    getTranslatedLabel(fieldName: any, index: any): string;
+    /**
+     * Attempts to retrieve the legend for a given field from the current language obj.
+     * If no localisation is available, or the langauge is en, falls back to the default
+     * legend for the fieldname.
+     */
+    getTranslatedLegend(fieldName: any, index: any): string;
+    getTranslatedInfo(fieldName: any, index: any): string;
+    /**
+     * Attempts to retrieve the validation for a given field from the current language obj.
+     * If no localisation is available, or the langauge is en, falls back to the default
+     * validation for the fieldname.
+     */
+    getTranslatedValidation(fieldName: any, index: any): any;
+    /**
+     * Attempts to retrieve the options for a given select field from the current language
+     * obj. If no localisation is available, or the langauge is en, falls back to the default
+     * options for the fieldname.
+     */
+    getTranslatedOptions(fieldName: any, index: any): any;
+    /**
+     * Attempts to retrieve the hint for a given field from the current language obj.
+     * If no localisation is available, or the langauge is en, falls back to the default
+     * hint for the fieldname.
+     */
+    getTranslatedHint(fieldName: any, index: any): string;
+    /**
+     * Attempts to retrieve a localisation of a given piece of static content from
+     * the current language obj. If no localisation is available, or the langauge is en,
+     * falls back to the default english version of that content. If that is also not
+     * provided, falls back to the generic content from the global messaging obj.
+     */
+    getTranslatedContent(type: any): any;
+    /**
+     * Retrieves the default value for a message from the global messages json file in the
+     * current language.
+     */
+    getMessagingData(type: any, lang: any): any;
+    /**
+     * Returns true if a given value is undefined
+     */
+    isUndefined(value: any): boolean;
+    /**
+     * Called when the value of any input changes, updating values in the main this.form source
+     * of truth. The new value is stored, validated, error statuses and conditional field
+     * appearance is updated
+     *
+     * The inputs can't directly v-model variables from the this.form object because reactivity
+     * on sub-variables on arrays passed through multiple components is inconsistent and
+     * unreliable. Instead each component tracks its own value on an internal variable called
+     * inputVal then reports any changes to that value back up to the form.
+     */
+    updateFieldData(data: any): void;
+    /**
+     * Updates the errorFields list with the current validated state of each field.
+     */
+    manageErrorStatus(field: any, errors: any): void;
+    /**
+     * Determines whether a given field should display the localised word "optional".
+     */
+    showOptionalText(field: any): boolean;
+    /**
+     * Determines whether or not an element should have a label with the bootstrap vue
+     * component or if that should be handled separately.
+     */
+    needsLabel(field: any): boolean;
+    /**
+     * Interrupts form submission to ensure that manually triggered validation and recaptcha
+     * verification has occurred. If successful, proceeds with submission.
+     */
+    preSubmit(e: any): void;
+    /**
+     * Invokes Marketo functionality to submit the form, along with recaptcha info, in the
+     * correct format.
+     */
+    marketoSubmit(): void;
+    /**
+     * Checks recaptcha response from the server
+     */
+    onRecaptchaVerify(): void;
+    /**
+     * Checks whether each conditional field in the formdata currently meets its condition,
+     * and updates the status of those fields in this.conditionalFields.
+     */
+    checkConditionalFields(): void;
+    /**
+     * Sets the 'd-none' class on conditional fields which are currently not displaying.
+     */
+    conditionalElementClass(fieldName: any): "" | "d-none";
+}, {
+    computed: {
+        pageUrl: () => string;
+    };
+    data(): {
+        dataLayerLoadConfirmed: boolean;
+        dataLayerStore: any;
+    };
+    mounted(): void;
+    methods: {
+        templateFiller(template: any, values: any): {};
+        createDataLayerObject(type: any, event: any, href: any): void;
+        returnIsoDate(): string;
+        pushToDataLayer(object: any): void;
+        compileFullTemplate(templateValues: any): any;
+        targetText(event: any): any;
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The URL for the form data file
+     */
+    dataUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Recaptcha site key string
+     */
+    recaptchaKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Text for invisible recaptcha textarea - tells
+     * screenreader users it's not needed
+     */
+    recaptchaTextareaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * If the form should use sandbox or live Marketo details
+     */
+    isProd: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Munchkin ID for the Marketo environment
+     */
+    munchkinId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Marketo instance URL for the form
+     */
+    marketoInstance: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Language indicator for content
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * URL for generic messaging config
+     */
+    messagingUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * URL for generic messaging config
+     */
+    countryListUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    language: string;
+    recaptchaKey: string;
+    recaptchaTextareaLabel: string;
+    isProd: boolean;
+    countryListUrl: string;
+}, {}>;
+export default _default;

package/dist/components/components/marketo-form/index.d.ts

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