@visitscotland/component-library 1.2.1 → 1.2.2

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

@@ -0,0 +1,73 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * If set, the good to go logo appears. Should contain a unique `id` (String), a `name`
+    * (String) that appears as a tooltip and a url to an `image` (String)
+    */
+    goodToGoLogo: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * If set, the safe travels logo appears. Should contain a unique `id` (String), a `name`
+    * (String) that appears as a tooltip and a url to an `image` (String)
+    */
+    safeTravelsLogo: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * A set of award badges to display, each should contain a unique `id` (String), a `name`
+    * (String) that appears as a tooltip and a url to an `image` (String)
+    */
+    awards: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+    * A specific award, should contain a `name` (String) and an `image` (String) - appears on
+    * the right hand side of the award list
+    */
+    accessGuide: {
+        type: ObjectConstructor;
+        default: any;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * If set, the good to go logo appears. Should contain a unique `id` (String), a `name`
+    * (String) that appears as a tooltip and a url to an `image` (String)
+    */
+    goodToGoLogo: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * If set, the safe travels logo appears. Should contain a unique `id` (String), a `name`
+    * (String) that appears as a tooltip and a url to an `image` (String)
+    */
+    safeTravelsLogo: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * A set of award badges to display, each should contain a unique `id` (String), a `name`
+    * (String) that appears as a tooltip and a url to an `image` (String)
+    */
+    awards: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+    * A specific award, should contain a `name` (String) and an `image` (String) - appears on
+    * the right hand side of the award list
+    */
+    accessGuide: {
+        type: ObjectConstructor;
+        default: any;
+    };
+}>>, {
+    goodToGoLogo: Record<string, any>;
+    safeTravelsLogo: Record<string, any>;
+    accessGuide: Record<string, any>;
+    awards: unknown[];
+}, {}>;
+export default _default;

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

@@ -0,0 +1,50 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * The price of the product
+    */
+    price: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A line of text that precedes the product price
+    */
+    priceIntro: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A line of text that appears after the product price
+    */
+    priceOutro: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * The price of the product
+    */
+    price: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A line of text that precedes the product price
+    */
+    priceIntro: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A line of text that appears after the product price
+    */
+    priceOutro: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    priceIntro: string;
+    price: string;
+    priceOutro: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,141 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * The type of product being searched for by the canned search
+    * the card appears in, dictates certain layout elements
+    */
+    searchType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The image to use in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The title of the product in the card
+    */
+    title: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+     * The duration of the product, if it should be shown as part of the main card body
+     * rather than in the summary box, will be truncated if >2 lines
+     *
+     * Expects an object with a label, a startDay and an optional endDay
+     */
+    inBodyDuration: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * The description of the product, will be truncated if >2 lines
+    */
+    description: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * An object containing a link to product details, should contain a `url`
+    * field, a `label` field and a `type` field
+    */
+    detailLink: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+    * Mandatory index of slide -
+    * needed to calculate active slides
+    */
+    slideIndex: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {
+    /**
+     * Calculates any required modified classes for the card-body, depending on the
+     * searchType provided
+     */
+    modCardBody(): "" | "card-body--short";
+    /**
+     * TMS images currently aren't passed to the image scaler, and as such return the
+     * full quality image when we request the xxs one causing some significant performance
+     * issues in tours canned searches. If the searchType is tour, use a generic
+     * placeholder rather than the specified one.
+     *
+     * Remove when TMS images are scaled properly.
+     */
+    useGenericLqip(): boolean;
+}, {
+    /**
+     * Detects if the card is one of the currently visible cards in the carousel
+     * so it can be disabled if not
+     *
+     * @returns {Boolean} true if card is visible
+     */
+    isVisible(): boolean;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * The type of product being searched for by the canned search
+    * the card appears in, dictates certain layout elements
+    */
+    searchType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The image to use in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The title of the product in the card
+    */
+    title: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+     * The duration of the product, if it should be shown as part of the main card body
+     * rather than in the summary box, will be truncated if >2 lines
+     *
+     * Expects an object with a label, a startDay and an optional endDay
+     */
+    inBodyDuration: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * The description of the product, will be truncated if >2 lines
+    */
+    description: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * An object containing a link to product details, should contain a `url`
+    * field, a `label` field and a `type` field
+    */
+    detailLink: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+    * Mandatory index of slide -
+    * needed to calculate active slides
+    */
+    slideIndex: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {
+    description: string;
+    searchType: string;
+    inBodyDuration: Record<string, any>;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,56 @@
+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;
+    };
+    /**
+    * Whether the stars should be displayed in gold, if false they
+    * will be purple
+    */
+    gold: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, 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;
+    };
+    /**
+    * Whether the stars should be displayed in gold, if false they
+    * will be purple
+    */
+    gold: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    min: number;
+    max: number;
+    gold: boolean;
+}, {}>;
+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 @@
+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;
+import VsCannedSearch from './CannedSearch.vue';
+import VsCannedSearchProductCard from './components/CannedSearchProductCard.vue';
+import VsCannedSearchStars from './components/CannedSearchStars.vue';
+import VsCannedSearchCategories from './components/CannedSearchCategories.vue';
+import VsCannedSearchLogos from './components/CannedSearchLogos.vue';
+import VsCannedSearchPrice from './components/CannedSearchPrice.vue';
+import VsCannedSearchBadges from './components/CannedSearchBadges.vue';
+import VsCannedSearchSummaryBox from './components/CannedSearchSummaryBox.vue';
+import VsCannedSearchCuisines from './components/CannedSearchCuisines.vue';
+import VsCannedSearchDates from './components/CannedSearchDates.vue';
+import VsCannedSearchDuration from './components/CannedSearchDuration.vue';
+import VsCannedSearchSubHeading from './components/CannedSearchSubHeading.vue';

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;