@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/number-input/NumberInput.vue.d.ts

@@ -0,0 +1,294 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Assigns a floor that the number input can be set to, only relevant
+     * if the type is number
+     */
+    minimumNumber: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Assigns a ceiling that the number input can be set to, only relevant
+     * if the type is number
+     */
+    maximumNumber: {
+        type: NumberConstructor;
+        default: number;
+    };
+    autoComplete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to trigger manual validation. Used by a parent
+     * component to trigger validation eg. when the submit
+     * button is clicked.
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specific validation messages for different
+     * types of validation
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Fallback translated validation - this is a set of
+     * validation messages to be used when no specific
+     * validation message is needed, eg. "This field is required"
+     */
+    genericValidation: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Content for hint text
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for the 'clear' button
+     * the existence of this will defined whether the button
+     * also exists
+     */
+    clearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    v$: import("vue").Ref<import("@vuelidate/core").Validation<import("@vuelidate/core").ValidationArgs<unknown>, unknown>>;
+}, {
+    inputVal: number;
+    clearErrorsOnFocus: boolean;
+}, {
+    /**
+     * element type class plus error classes
+     */
+    elementClass(): string;
+    showClearButton(): boolean;
+    errorClass(): "" | "vs-input--error";
+}, {
+    /**
+     * Clear any text entered in the input
+     */
+    clearInput(): void;
+    /**
+     * Focus on the input
+     */
+    focusOnInput(): void;
+    /**
+     * Clears the input on button click
+     * and adds focus back to the input
+     */
+    clearInputAndFocus(): void;
+    /**
+     * Check if an entered number value is within the specified bounds and
+     * resets it if not, then passes to the validation process
+     */
+    controlBlurred(): void;
+    /**
+     * Validate errors on blur, and re-render them to the screen for screen
+     * reader notice
+     */
+    validateErrors(): void;
+    /**
+     * Reset field errors on focus to allow screen reader to notice them if still
+     * present on blur
+     */
+    resetErrors(): void;
+    /**
+     * If the input value is a number, decrement it by one down to the minimum value
+     */
+    decrementValue(event: any): void;
+    /**
+     * If the input value is a number, increment it by one up to the maximum value
+     */
+    incrementValue(event: any): void;
+}, {
+    data(): {
+        inputVal: any;
+        /**
+         * A number input allows a user to select a number within a defined range
+         *
+         * @displayName NumberInput
+         */
+        isInvalid: any;
+    };
+    computed: {
+        isRequired(): boolean;
+        rules(): {
+            inputVal: {};
+        } | {
+            inputVal?: undefined;
+        };
+        errorsList(): any[];
+    };
+    watch: {
+        errorsList(newValue: any): void;
+    };
+    methods: {
+        manualValidate(): void;
+        emitStatus(): void;
+    };
+} | {
+    computed: {
+        ariaDescription(): string;
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Assigns a floor that the number input can be set to, only relevant
+     * if the type is number
+     */
+    minimumNumber: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Assigns a ceiling that the number input can be set to, only relevant
+     * if the type is number
+     */
+    maximumNumber: {
+        type: NumberConstructor;
+        default: number;
+    };
+    autoComplete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to trigger manual validation. Used by a parent
+     * component to trigger validation eg. when the submit
+     * button is clicked.
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specific validation messages for different
+     * types of validation
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Fallback translated validation - this is a set of
+     * validation messages to be used when no specific
+     * validation message is needed, eg. "This field is required"
+     */
+    genericValidation: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Content for hint text
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for the 'clear' button
+     * the existence of this will defined whether the button
+     * also exists
+     */
+    clearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    value: number;
+    hintText: string;
+    minimumNumber: number;
+    maximumNumber: number;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+    autoComplete: boolean;
+    clearButtonText: string;
+}, {}>;
+export default _default;

package/dist/components/components/number-input/index.d.ts

@@ -0,0 +1,2 @@
+export default VsNumberInput;
+import VsNumberInput from './NumberInput.vue';

package/dist/components/components/page-intro/PageIntro.vue.d.ts

@@ -0,0 +1,60 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * Background theme
+    */
+    background: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Option for an intro to be used on simple page type
+    */
+    heroIntro: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Identifies the hero as an itinerary
+    */
+    isItinerary: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {
+    introClasses(): string[];
+    contentColProps(): {
+        md: string;
+        lg: string;
+        xl: string;
+        'offset-lg': string;
+    };
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * Background theme
+    */
+    background: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Option for an intro to be used on simple page type
+    */
+    heroIntro: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Identifies the hero as an itinerary
+    */
+    isItinerary: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    background: string;
+    heroIntro: boolean;
+    isItinerary: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/page-intro/index.d.ts

@@ -0,0 +1,2 @@
+export default VsPageIntro;
+import VsPageIntro from './PageIntro.vue';

package/dist/components/components/panel/Panel.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;

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

@@ -0,0 +1,2 @@
+export default VsPanel;
+import VsPanel from './Panel.vue';

package/dist/components/components/product-search/ProductSearch.vue.d.ts

@@ -0,0 +1,64 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Message to show when Javascript is disabled
+     */
+    noJsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Autofilled location field
+     */
+    defaultLocation: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Autofilled product field
+     */
+    defaultProd: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Locale to set language
+     */
+    defaultLocale: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Message to show when Javascript is disabled
+     */
+    noJsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Autofilled location field
+     */
+    defaultLocation: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Autofilled product field
+     */
+    defaultProd: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Locale to set language
+     */
+    defaultLocale: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    defaultProd: string;
+    defaultLocale: string;
+    defaultLocation: string;
+}, {}>;
+export default _default;

package/dist/components/components/product-search/components/Autocomplete.vue.d.ts

@@ -0,0 +1,37 @@
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    id: string;
+    label: string;
+    mode?: string;
+    multiselectLabel?: string;
+    name: string;
+    options: any[];
+    placeholder: string;
+    trackBy?: string;
+    isTourLocation?: boolean;
+    defaultVal?: any;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    changeValue: (payload: any) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    id: string;
+    label: string;
+    mode?: string;
+    multiselectLabel?: string;
+    name: string;
+    options: any[];
+    placeholder: string;
+    trackBy?: string;
+    isTourLocation?: boolean;
+    defaultVal?: any;
+}>>> & {
+    onChangeValue?: (payload: any) => any;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/components/product-search/components/DateInput.vue.d.ts

@@ -0,0 +1,27 @@
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    label: string;
+    id: string;
+    name: string;
+    value?: string;
+    minDate?: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    changeDate: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    label: string;
+    id: string;
+    name: string;
+    value?: string;
+    minDate?: string;
+}>>> & {
+    onChangeDate?: (...args: any[]) => any;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/components/product-search/components/DateRange.vue.d.ts

@@ -0,0 +1,48 @@
+declare const _default: import("vue").DefineComponent<{
+    startLabel: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    endLabel: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    defaultDates: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectedProd: {
+        type: StringConstructor;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    dateUpdated: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    startLabel: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    endLabel: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    defaultDates: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectedProd: {
+        type: StringConstructor;
+        required: true;
+    };
+}>> & {
+    onDateUpdated?: (...args: any[]) => any;
+}, {
+    startLabel: string;
+    endLabel: string;
+    defaultDates: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/product-search/components/GuestSelector.vue.d.ts

@@ -0,0 +1,15 @@
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    availability: boolean;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    availability: boolean;
+}>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/components/product-search/components/GuestSelectorNumberGroup.vue.d.ts

@@ -0,0 +1,44 @@
+import type { GuestNumberGroup } from '../../../types/types';
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    adultCount: number;
+    childrenCount: number;
+    count: number;
+    disabled: boolean;
+    id: string;
+    infantCount: number;
+    inputType: GuestNumberGroup;
+    maxValue: number;
+    minValue: number;
+    name: string;
+    rowName: string;
+    rowLabel: string;
+    unitRemoved: boolean;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    changeHandler: (inputName: string, inputValue: number, type: string, unitId: string) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    adultCount: number;
+    childrenCount: number;
+    count: number;
+    disabled: boolean;
+    id: string;
+    infantCount: number;
+    inputType: GuestNumberGroup;
+    maxValue: number;
+    minValue: number;
+    name: string;
+    rowName: string;
+    rowLabel: string;
+    unitRemoved: boolean;
+}>>> & {
+    onChangeHandler?: (inputName: string, inputValue: number, type: string, unitId: string) => any;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/components/product-search/components/GuestSelectorRow.vue.d.ts

@@ -0,0 +1,30 @@
+import type { GuestUnit } from '../../../types/types';
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    name: string;
+    showRemoveBtn: boolean;
+    unitLabel: string;
+    unitOptions: GuestUnit;
+    unitRemoved: boolean;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    numberChange: (type: string, groupName: string, unitId: string) => void;
+    onRemove: (totalCount: number, childCount: number, unitId: string) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    name: string;
+    showRemoveBtn: boolean;
+    unitLabel: string;
+    unitOptions: GuestUnit;
+    unitRemoved: boolean;
+}>>> & {
+    onNumberChange?: (type: string, groupName: string, unitId: string) => any;
+    onOnRemove?: (totalCount: number, childCount: number, unitId: string) => any;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/components/product-search/components/ProductSearchEmbed.vue.d.ts

@@ -0,0 +1,55 @@
+declare const _default: import("vue").DefineComponent<{
+    defaultProd: {
+        type: StringConstructor;
+        default: string;
+        validator(value: string): boolean;
+    };
+    defaultLocale: {
+        type: StringConstructor;
+        default: string;
+        validator(value: string): boolean;
+    };
+    defaultLocation: {
+        type: StringConstructor;
+        default: string;
+    };
+}, {}, unknown, {}, {
+    trackSubmit(type: any, location: 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<{
+    defaultProd: {
+        type: StringConstructor;
+        default: string;
+        validator(value: string): boolean;
+    };
+    defaultLocale: {
+        type: StringConstructor;
+        default: string;
+        validator(value: string): boolean;
+    };
+    defaultLocation: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    defaultProd: string;
+    defaultLocale: string;
+    defaultLocation: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,2 @@
+export default VsProductSearch;
+import VsProductSearch from './ProductSearch.vue';