@visitscotland/component-library 3.0.1 → 3.0.2

package/dist/components/components/canned-search/components/CannedSearchStars.vue.d.ts

@@ -0,0 +1,39 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The minimum number of stars for parts of the product, if the
+    * same as the max a number of stars will be displayed, if
+    * different a range will be displayed
+    */
+    min: {
+        type: NumberConstructor;
+        default: any;
+    };
+    /**
+    * The maximum number of stars for parts of the product
+    */
+    max: {
+        type: NumberConstructor;
+        default: any;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The minimum number of stars for parts of the product, if the
+    * same as the max a number of stars will be displayed, if
+    * different a range will be displayed
+    */
+    min: {
+        type: NumberConstructor;
+        default: any;
+    };
+    /**
+    * The maximum number of stars for parts of the product
+    */
+    max: {
+        type: NumberConstructor;
+        default: any;
+    };
+}>>, {
+    min: number;
+    max: number;
+}, {}>;
+export default _default;

package/dist/components/components/canned-search/components/CannedSearchSubHeading.vue.d.ts

@@ -0,0 +1,43 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The string to display
+    */
+    subHeading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The number of lines of text to limit the subHeading to, if
+     * this is un-set it will not limit
+     *
+     * 1, 2
+     */
+    lineLimit: {
+        type: NumberConstructor;
+        default: any;
+        validator: (value: unknown) => boolean;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The string to display
+    */
+    subHeading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The number of lines of text to limit the subHeading to, if
+     * this is un-set it will not limit
+     *
+     * 1, 2
+     */
+    lineLimit: {
+        type: NumberConstructor;
+        default: any;
+        validator: (value: unknown) => boolean;
+    };
+}>>, {
+    subHeading: string;
+    lineLimit: number;
+}, {}>;
+export default _default;

package/dist/components/components/canned-search/components/CannedSearchSummaryBox.vue.d.ts

@@ -0,0 +1,67 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The href of a product link, should match the website on the
+    * parent product card
+    */
+    linkHref: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The label of the product link
+    */
+    linkLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The link type for the product link
+    */
+    linkType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The title for the product link
+    */
+    linkTitle: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The href of a product link, should match the website on the
+    * parent product card
+    */
+    linkHref: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The label of the product link
+    */
+    linkLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The link type for the product link
+    */
+    linkType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The title for the product link
+    */
+    linkTitle: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    linkHref: string;
+    linkType: string;
+    linkLabel: string;
+    linkTitle: string;
+}, {}>;
+export default _default;

package/dist/components/components/canned-search/components/CannedSearchTourDeparts.vue.d.ts

@@ -0,0 +1,43 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * A string to precede the list of origins
+    */
+    label: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * A list of places that a tour departs from, should contain
+    * objects, each of which has a `name` prop
+    */
+    origins: {
+        type: ArrayConstructor;
+        default: any;
+    };
+}, any, any, {
+    /**
+    * Returns the first 3 provided categories as a pipe separated string for
+    * display
+    */
+    transformedOrigins(): any;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * A string to precede the list of origins
+    */
+    label: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * A list of places that a tour departs from, should contain
+    * objects, each of which has a `name` prop
+    */
+    origins: {
+        type: ArrayConstructor;
+        default: any;
+    };
+}>>, {
+    label: string;
+    origins: unknown[];
+}, {}>;
+export default _default;

package/dist/components/components/canned-search/components/CannedSearchTourRuns.vue.d.ts

@@ -0,0 +1,59 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * A string to precede the time period
+    */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The first time in the period, if an endDay isn't provided
+    * this will be shown on its own (as in the case `all year round`)
+    */
+    startDay: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The last time in the period, if set this appears - separated from
+    * the start day
+    */
+    endDay: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    /**
+     * Returns a formatted string for the date range
+     */
+    formattedPeriod(): string;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * A string to precede the time period
+    */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The first time in the period, if an endDay isn't provided
+    * this will be shown on its own (as in the case `all year round`)
+    */
+    startDay: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The last time in the period, if set this appears - separated from
+    * the start day
+    */
+    endDay: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    label: string;
+    startDay: string;
+    endDay: string;
+}, {}>;
+export default _default;

package/dist/components/components/canned-search/index.d.ts

@@ -0,0 +1,27 @@
+import { default as VsCannedSearch } from './CannedSearch.vue';
+import { default as VsCannedSearchProductCard } from './components/CannedSearchProductCard.vue';
+import { default as VsCannedSearchStars } from './components/CannedSearchStars.vue';
+import { default as VsCannedSearchCategories } from './components/CannedSearchCategories.vue';
+import { default as VsCannedSearchLogos } from './components/CannedSearchLogos.vue';
+import { default as VsCannedSearchPrice } from './components/CannedSearchPrice.vue';
+import { default as VsCannedSearchBadges } from './components/CannedSearchBadges.vue';
+import { default as VsCannedSearchSummaryBox } from './components/CannedSearchSummaryBox.vue';
+import { default as VsCannedSearchCuisines } from './components/CannedSearchCuisines.vue';
+import { default as VsCannedSearchDates } from './components/CannedSearchDates.vue';
+import { default as VsCannedSearchDuration } from './components/CannedSearchDuration.vue';
+import { default as VsCannedSearchSubHeading } from './components/CannedSearchSubHeading.vue';
+declare namespace _default {
+    export { VsCannedSearch };
+    export { VsCannedSearchProductCard };
+    export { VsCannedSearchStars };
+    export { VsCannedSearchCategories };
+    export { VsCannedSearchLogos };
+    export { VsCannedSearchPrice };
+    export { VsCannedSearchBadges };
+    export { VsCannedSearchSummaryBox };
+    export { VsCannedSearchCuisines };
+    export { VsCannedSearchDates };
+    export { VsCannedSearchDuration };
+    export { VsCannedSearchSubHeading };
+}
+export default _default;

package/dist/components/components/caption/Caption.vue.d.ts

@@ -0,0 +1,82 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Option to choose which variant to show
+     * `fullwidth, large`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * The image latitude
+     */
+    latitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The image longitude
+     */
+    longitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Option to choose text alignment
+     * `left, right`
+     */
+    textAlign: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, {
+    tokens: any;
+}, {
+    showMap(): boolean;
+    isLargeCaption(): boolean;
+    captionClasses(): (string | {
+        'vs-caption--large': boolean;
+        'vs-caption--fullwidth': boolean;
+    })[];
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Option to choose which variant to show
+     * `fullwidth, large`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * The image latitude
+     */
+    latitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The image longitude
+     */
+    longitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Option to choose text alignment
+     * `left, right`
+     */
+    textAlign: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    variant: string;
+    latitude: string;
+    longitude: string;
+    textAlign: string;
+}, {}>;
+export default _default;

package/dist/components/components/caption/components/CaptionImageMap.vue.d.ts

@@ -0,0 +1,67 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * The image latitude
+     */
+    latitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The image longitude
+     */
+    longitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    mapOutlineColor: {
+        type: StringConstructor;
+        default: string;
+    };
+    mapMarkerColor: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    cornerCoordinates: {
+        NE: number;
+        NW: number;
+        SE: number;
+        SW: number;
+    };
+    mapWidth: number;
+    mapHeight: number;
+}, {
+    positionY(): number;
+    positionX(): number;
+}, {
+    calculateAxisPosition(scaleStart: any, scaleEnd: any, coord: any, axisLength: any): number;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The image latitude
+     */
+    latitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The image longitude
+     */
+    longitude: {
+        type: StringConstructor;
+        default: string;
+    };
+    mapOutlineColor: {
+        type: StringConstructor;
+        default: string;
+    };
+    mapMarkerColor: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    latitude: string;
+    longitude: string;
+    mapOutlineColor: string;
+    mapMarkerColor: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,7 @@
+import { default as VsCaption } from './Caption.vue';
+import { default as VsCaptionImageMap } from './components/CaptionImageMap.vue';
+declare namespace _default {
+    export { VsCaption };
+    export { VsCaptionImageMap };
+}
+export default _default;

package/dist/components/components/carbon-calculator/CarbonCalculator.vue.d.ts

@@ -0,0 +1,239 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * An object providing all required localisation content from the CMS. This
+     * should contain global props like a translation for `next`, `previous`,
+     * `results` and so on, as well as question by question labels. Those should
+     * take the form
+     *    `question-1.title` <- the category for the first question
+     *    `question-1.question` <- the content of the first question
+     *    `question-1.option-1` <- the first option for the first question
+     *    `question-1.tip` <- the content of the tip for the above option
+     * and then repeat for each question-x beyond that.
+     */
+    labelsMap: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Language locale string. Used to determine correct formatting for numbers (decimal
+     * delimeter)
+     *
+     * Example: "en-gb"
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    /**
+     * The question which is currently being displayed to the user, null if
+     * the user is on the intro or results page.
+     */
+    currentQuestion(): any;
+    /**
+     * The tip which is currently being displayed to the user, based on their
+     * answer to the current question and what tips are available in their language
+     */
+    currentTip(): any;
+    /**
+     * The length of the user's stay, parsed to an int from an answer
+     * provided to the user. Necessary to calculate the emissions per
+     * day in the results page.
+     */
+    stayDuration(): number;
+    /**
+     * Retrieves the category for a given stage from the localised labelsMap provided
+     * by the CMS
+     */
+    currentCategory(): any;
+    /**
+     * Retrieves the CTA to add an extra answer for a given stage, if that stage is repeatable
+     */
+    activeStageRepeatable(): any;
+}, {
+    /**
+     * Defines the initial state of the component, when the component is
+     * initialised and when the user resets the form to get another calculation.
+     */
+    initialState(): {
+        formData: {};
+        messagingData: {};
+        form: {};
+        formIsInvalid: boolean;
+        showErrorMessage: boolean;
+        errorFields: any[];
+        triggerValidate: boolean;
+        conditionalFields: {};
+        reAlertErrors: boolean;
+        totalKilos: number;
+        transportKilos: number;
+        accommodationKilos: number;
+        foodKilos: number;
+        transportTip: any;
+        foodTip: any;
+        accommodationTip: any;
+        transportInternalTip: any;
+        activeStage: number;
+        answerSet: boolean;
+        repeatableStages: {};
+    };
+    /**
+     * Resets the form to its initial data configuration to restart the user's calculation.
+     * The formData is loaded on page creation by axios and won't change between calculations
+     * so can be held and set in the component to avoid doubling the load.
+     */
+    restart(): void;
+    /**
+     * Remove leftover duplicated fields from form field data on reset, and reset count for
+     * each field that has been duplicated.
+     */
+    cleanFields(): void;
+    /**
+     * Called on component created. Loads the json file located at this.dataUrl which
+     * contains all of the question data validation. This does not contain localisations, which
+     * are loaded from the CMS as labels and then mapped to the questions from the form.
+     */
+    getFormData(): void;
+    /**
+     * Retrieves the default value for a message from the global messages json file in the
+     * current language.
+     */
+    getMessagingData(type: any, lang: any): any;
+    /**
+     * Retrieves the label for a given question from the localised labelsMap provided
+     * by the CMS
+     */
+    getQuestionLabel(field: any, index: any): any;
+    /**
+     * Retrieves the hint for a given question from the localised labelsMap provided
+     * by the CMS
+     */
+    getQuestionHint(field: any, index: any): any;
+    /**
+     * Retrieves the options for a given question from the localised labelsMap provided
+     * by the CMS
+     */
+    getQuestionOptions(field: any, index: any): any;
+    /**
+     * 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;
+    /**
+     * Calculates the current value of a radio button based question in the carbon calculator
+     * form. Each field has an actual raw value which is retruned by the radio button
+     * component, but also has a potential multiplication factor which could be based on
+     * another field or on a static value.
+     */
+    getRadioValue(fieldName: any, key: any): any;
+    /**
+     * Calculates the current value of a number input based question in the carbon calculator
+     * form. Each field has an actual raw value which is retruned by the radio button
+     * component, but also has a potential multiplication factor which could be based on
+     * another field or on a static value.
+     */
+    getNumberValue(fieldName: any, key: any): number;
+    /**
+     * Retrieves the current value for a given field, based on its type
+     */
+    getFieldValue(checkField: any): any;
+    /**
+     * Calculates the current total emissions value, and category specific emission values
+     * for the user based on their submitted answers.
+     */
+    calculateEmissions(): void;
+    /**
+     * Checks whether conditional fields meet the rules to show them
+     */
+    checkConditionalFields(): void;
+    /**
+     * Moves the form forward one stage
+     */
+    forwardPage(event: any): void;
+    /**
+     * Moves the form back one stage
+     */
+    backwardPage(event: any): void;
+    /**
+     * Checks if an answer has been provided for the current question, if one
+     * is necessary to proceed
+     */
+    checkNewAnswerSet(): void;
+    /**
+     * Check if the current stage appears in the list of repeatableStages defined in the form
+     * data. If so it should be possible to enter multiple values for it.
+     */
+    isRepeatable(stage: any): boolean;
+    /**
+     * Sets the 'd-none' class on conditional fields which are currently not displaying.
+     */
+    conditionalElementClass(fieldName: any): "" | "d-none";
+    /**
+     * Set the user focus to just before the current question. Called whenever they navigate
+     * to a new page to ensure a keyboard navigating user has clarity on what is happening
+     * after nav.
+     */
+    resetFocus(): void;
+    /**
+     * Adds a duplicate for each question in the current stage to the form data. Duplicates
+     * are marked as clones to ensure subsequent duplicates are only added one set at a time
+     * rather than doubled.
+     */
+    duplicateCurrentStage(event: any): void;
+}, {
+    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<{
+    /**
+     * An object providing all required localisation content from the CMS. This
+     * should contain global props like a translation for `next`, `previous`,
+     * `results` and so on, as well as question by question labels. Those should
+     * take the form
+     *    `question-1.title` <- the category for the first question
+     *    `question-1.question` <- the content of the first question
+     *    `question-1.option-1` <- the first option for the first question
+     *    `question-1.tip` <- the content of the tip for the above option
+     * and then repeat for each question-x beyond that.
+     */
+    labelsMap: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Language locale string. Used to determine correct formatting for numbers (decimal
+     * delimeter)
+     *
+     * Example: "en-gb"
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    language: string;
+}, {}>;
+export default _default;

package/dist/components/components/carbon-calculator/components/CarbonCalculatorIntro.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{}>>, {}, {}>;
+export default _default;