@visitscotland/component-library 3.0.1 → 3.0.2

package/dist/components/components/button-toggle-group/ButtonToggleGroup.vue.d.ts

@@ -0,0 +1,68 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * An object of options for the
+     * toggle buttons
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Initially selected options
+     */
+    initialSelected: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Initially selected options
+     */
+    buttonsLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, {
+    selected: string;
+    groupTabbedInto: boolean;
+}, {}, {
+    /**
+     * Emit checked value when the selected
+     * item changes
+     */
+    toggleChange(checked: any): void;
+    /**
+     * Updates data value to signify that the element
+     * has been tabbed into
+     */
+    addTabClass(): void;
+    /**
+     * Removes the 'tabbed into' class
+     */
+    removeTabClass(event: any): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * An object of options for the
+     * toggle buttons
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Initially selected options
+     */
+    initialSelected: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Initially selected options
+     */
+    buttonsLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {
+    initialSelected: string;
+}, {}>;
+export default _default;

package/dist/components/components/button-toggle-group/index.d.ts

@@ -0,0 +1,2 @@
+import { default as VsButtonToggleGroup } from './ButtonToggleGroup.vue';
+export default VsButtonToggleGroup;

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

@@ -0,0 +1,135 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The url that products should be retrieved from for display
+    */
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The type of product that is being search for via our API - this determines how the product
+    * cards are displayed. Currently these are:
+    *
+    * `even` - events
+    * `acco` - accomodation
+    * `cate` - food & drink
+    * `acti` - things to do
+    * `tour` - tours
+    */
+    searchType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional header that appears above the canned search carousel, rendered as an h2
+    */
+    heading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Accessible text for next carousel control, passed to vs-carousel
+    */
+    carouselNextText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Accessible text for next carousel control, passed to vs-carousel
+    */
+    carouselPreviousText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    products: any[];
+}, {
+    showLogos(): boolean;
+}, {
+    /**
+     * Invoked when mounted, retrieves products from the dms and sets them
+     * to the component
+     */
+    retrieveProducts(): void;
+    /**
+     * Returns an appropriate subheading for the product card based on the search type,
+     * tours display a comma separated list of categories, non-tours display a formatted
+     * address
+     */
+    fetchSubHeading(product: any): any;
+    /**
+     * Returns a comma separated list of all the categories on the product
+     */
+    fetchCategoryStrings(product: any): any;
+    /**
+     * Returns the address string for each card, dependent on whether the event is
+     * online and what type of product the search is looking for
+     *
+     * Defaults to `city, country` if no exception present
+     */
+    fetchAddress(product: any): any;
+    /**
+     * Returns the elements to display in the first badge, usually a category
+     */
+    fetchBadgeOne(product: any): any;
+    /**
+     * Returns the elements to display in the first badge section if there are multiple
+     * of them, usually occurs for tours and lists modes of transport
+     */
+    fetchMultiBadgeOne(product: any): any;
+    /**
+     * Returns the elements to display in the first badge if covid opening information is
+     * provided return that, otherwise if a nowOn status for an event is provided return that
+     */
+    fetchBadgeThree(product: any): any;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The url that products should be retrieved from for display
+    */
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The type of product that is being search for via our API - this determines how the product
+    * cards are displayed. Currently these are:
+    *
+    * `even` - events
+    * `acco` - accomodation
+    * `cate` - food & drink
+    * `acti` - things to do
+    * `tour` - tours
+    */
+    searchType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional header that appears above the canned search carousel, rendered as an h2
+    */
+    heading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Accessible text for next carousel control, passed to vs-carousel
+    */
+    carouselNextText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Accessible text for next carousel control, passed to vs-carousel
+    */
+    carouselPreviousText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    apiUrl: string;
+    searchType: string;
+    heading: string;
+    carouselNextText: string;
+    carouselPreviousText: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,76 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * Content for the top right, category badge
+    */
+    badgeOne: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Content for multiple top right, category badges
+    * Only appears if badgeOne not set
+    *
+    * Expects an array of strings
+    */
+    multiBadgeOne: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+    * Content for the middle right, pink badge
+    */
+    badgeTwo: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Content for the bottom right, light pink badge
+    */
+    badgeThree: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    /**
+    * Limits multiBadgeOne to 3 entries
+    */
+    limitedMulti(): any;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * Content for the top right, category badge
+    */
+    badgeOne: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Content for multiple top right, category badges
+    * Only appears if badgeOne not set
+    *
+    * Expects an array of strings
+    */
+    multiBadgeOne: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+    * Content for the middle right, pink badge
+    */
+    badgeTwo: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Content for the bottom right, light pink badge
+    */
+    badgeThree: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    badgeOne: string;
+    multiBadgeOne: unknown[];
+    badgeTwo: string;
+    badgeThree: string;
+}, {}>;
+export default _default;

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

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

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

@@ -0,0 +1,22 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * A list of cuisines that describe the product, should contain
+    * objects, each of which has a `name` prop
+    */
+    cuisines: {
+        type: ArrayConstructor;
+        default: any;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * A list of cuisines that describe the product, should contain
+    * objects, each of which has a `name` prop
+    */
+    cuisines: {
+        type: ArrayConstructor;
+        default: any;
+    };
+}>>, {
+    cuisines: unknown[];
+}, {}>;
+export default _default;

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

@@ -0,0 +1,41 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The date range an event is occurring in, should contain a `startDay` as a
+    * YYYY-MM-DD formatted String, and an optional `endDay` if on more than one
+    * day.
+    */
+    period: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * A line of text that precedes the dates
+    */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    datePeriod(): any;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The date range an event is occurring in, should contain a `startDay` as a
+    * YYYY-MM-DD formatted String, and an optional `endDay` if on more than one
+    * day.
+    */
+    period: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+    * A line of text that precedes the dates
+    */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    label: string;
+    period: Record<string, any>;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,35 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The duration of the product
+    */
+    duration: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A line of text that precedes the product duration
+    */
+    durationIntro: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The duration of the product
+    */
+    duration: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A line of text that precedes the product duration
+    */
+    durationIntro: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    durationIntro: string;
+    duration: string;
+}, {}>;
+export default _default;

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;