@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/button/Button.vue.d.ts

@@ -0,0 +1,244 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Use this option to render the button as an anchor element with the given href.
+     */
+    href: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Tab index value - this is needed as tabindex attribute is sometimes stripped
+     * from the button on first update with nested components.
+     */
+    tabindex: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Style variation to give additional meaning
+     * `primary|secondary|transparent|dark|light`.
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Size of the button
+     * `sm|md|lg`.
+     */
+    size: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * By default, buttons have an animation behaviour on click.
+     * Pass `false` to disable.
+     */
+    animate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * By default, button text is uppercase. Pass `false` to disable.
+     */
+    uppercase: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set this for a button on a dark background for better colour contrast
+     */
+    onDark: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Pass the name of the icon to add it to the button.
+     */
+    icon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The icon orientation
+     * `up|down|left|right`.
+     */
+    iconOrientation: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * If the button contains an icon only with no text.
+     */
+    iconOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If the button contains an icon with accessible text.
+     */
+    iconWithText: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The position of the icon
+     * `left|right`
+     */
+    iconPosition: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, {
+    isAnimating: boolean;
+}, {
+    buttonClasses(): {
+        'vs-button--animated': boolean;
+        'vs-button--is-animating': boolean;
+        'vs-button--on-dark': any;
+        'vs-button--icon-only': any;
+        'vs-button--icon-with-text': any;
+        'button-flex': boolean;
+        'vs-button--flex-reverse': boolean;
+        'text-uppercase': boolean;
+    }[];
+    iconClasses(): {
+        'vs-icon--right': boolean;
+        'vs-icon--left': boolean;
+    }[];
+    calcIconSize(): "xs" | "sm" | "md";
+}, {
+    animateHandler(event: any): void;
+    tabbedIn(event: any): void;
+    trackLink(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<{
+    /**
+     * Use this option to render the button as an anchor element with the given href.
+     */
+    href: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Tab index value - this is needed as tabindex attribute is sometimes stripped
+     * from the button on first update with nested components.
+     */
+    tabindex: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Style variation to give additional meaning
+     * `primary|secondary|transparent|dark|light`.
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Size of the button
+     * `sm|md|lg`.
+     */
+    size: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * By default, buttons have an animation behaviour on click.
+     * Pass `false` to disable.
+     */
+    animate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * By default, button text is uppercase. Pass `false` to disable.
+     */
+    uppercase: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set this for a button on a dark background for better colour contrast
+     */
+    onDark: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Pass the name of the icon to add it to the button.
+     */
+    icon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The icon orientation
+     * `up|down|left|right`.
+     */
+    iconOrientation: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * If the button contains an icon only with no text.
+     */
+    iconOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If the button contains an icon with accessible text.
+     */
+    iconWithText: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The position of the icon
+     * `left|right`
+     */
+    iconPosition: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    size: string;
+    animate: boolean;
+    variant: string;
+    uppercase: boolean;
+    icon: string;
+    iconOnly: boolean;
+    href: string;
+    tabindex: string;
+    onDark: boolean;
+    iconOrientation: string;
+    iconWithText: boolean;
+    iconPosition: string;
+}, {}>;
+export default _default;

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

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

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 @@
+export default VsButtonToggleGroup;
+import VsButtonToggleGroup from './ButtonToggleGroup.vue';

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, teal badge
+    */
+    badgeOne: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Content for multiple top right, teal 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, teal badge
+    */
+    badgeOne: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Content for multiple top right, teal 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;