@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/itineraries/components/ItineraryStop.vue.d.ts

@@ -0,0 +1,46 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Label used for the word 'Stop'
+     */
+    stopLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Number of the stop in the component
+     */
+    stopNumber: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Title of the stop in the component
+    */
+    stopTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Label used for the word 'Stop'
+     */
+    stopLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Number of the stop in the component
+     */
+    stopNumber: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Title of the stop in the component
+    */
+    stopTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

package/dist/components/components/itineraries/components/ItineraryStopInfo.vue.d.ts

@@ -0,0 +1,175 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * JSON object of opening hour details
+    */
+    openingHours: {
+        type: (StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: any;
+    };
+    /**
+    * URL for full opening times details
+    */
+    openingTimesLink: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * Text for when stop is closed
+    */
+    closedText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for when stop is closing soon
+    */
+    closingSoonText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for when stop is open
+    */
+    openText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'Usually'
+    */
+    usualText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'Provisionally'
+    */
+    provisionalText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'Tempoprarily closed'
+    */
+    temporarilyClosedText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'To'
+    */
+    toText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'and'
+    */
+    andText: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, {
+    openingMessage: string;
+    currentDayData: {};
+    currentTime: {};
+    dayDataIndex: number;
+    closedLongTerm: boolean;
+    ukDate: string;
+    isCurrentTimeframe: boolean;
+    parsedHours: {};
+}, {
+    hoursMessage(): string;
+    provisionalMessage(): string;
+}, {
+    parseIncomingData(): void;
+    getCurrentTime(): void;
+    isActiveDate(): void;
+    getCurrentHoursInfo(): void;
+    compareTimes(currentTime: any, openingData: any, index: any): void;
+    returnDayName(day: any): string;
+    calculateClosingSoon(endTimeHours: any, endTimeMinutes: any): {
+        hours: any;
+        mins: number;
+    };
+    withinClosingSoonTime(currentTime: any, closingSoonTime: any): boolean;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * JSON object of opening hour details
+    */
+    openingHours: {
+        type: (StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: any;
+    };
+    /**
+    * URL for full opening times details
+    */
+    openingTimesLink: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * Text for when stop is closed
+    */
+    closedText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for when stop is closing soon
+    */
+    closingSoonText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for when stop is open
+    */
+    openText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'Usually'
+    */
+    usualText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'Provisionally'
+    */
+    provisionalText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'Tempoprarily closed'
+    */
+    temporarilyClosedText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'To'
+    */
+    toText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text for 'and'
+    */
+    andText: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {
+    openingHours: string | Record<string, any>;
+    openingTimesLink: string;
+}, {}>;
+export default _default;

package/dist/components/components/itineraries/components/ItineraryTips.vue.d.ts

@@ -0,0 +1,8 @@
+declare const _default: import("vue").DefineComponent<Readonly<import("vue").ComponentPropsOptions<{
+    [x: string]: unknown;
+}>>, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, readonly string[] | Readonly<import("vue").ExtractPropTypes<Readonly<import("vue").ComponentObjectPropsOptions<{
+    [x: string]: unknown;
+}>>>>, {
+    readonly [x: number]: string;
+} | {}, {}>;
+export default _default;

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

@@ -0,0 +1,7 @@
+import VsItinerary from './Itinerary.vue';
+import VsItineraryDay from './components/ItineraryDay.vue';
+import VsItineraryStop from './components/ItineraryStop.vue';
+import VsItineraryBorderOverlapWrapper from './components/ItineraryBorderOverlapWrapper.vue';
+import VsItineraryTips from './components/ItineraryTips.vue';
+import VsItineraryStopInfo from './components/ItineraryStopInfo.vue';
+export { VsItinerary, VsItineraryDay, VsItineraryStop, VsItineraryBorderOverlapWrapper, VsItineraryTips, VsItineraryStopInfo };

package/dist/components/components/itineraries/itineraries.store.d.ts

@@ -0,0 +1,30 @@
+import { type Ref } from 'vue';
+type Geometry = {
+    type: string;
+    coordinates: number[];
+};
+type Properties = {
+    altText: string;
+    imageSrc: string;
+    stopCount: string;
+    title: string;
+};
+type Stop = {
+    type: string;
+    geometry: Geometry;
+    properties: Properties;
+};
+declare const useItinerariesStore: import("pinia").StoreDefinition<"itineraries", import("pinia")._UnwrapAll<Pick<{
+    highlightedStop: Ref<Stop>;
+    setStopHighlighted: (newStop: any) => void;
+    getHighlightedStopCoordinates: () => number[];
+}, "highlightedStop">>, Pick<{
+    highlightedStop: Ref<Stop>;
+    setStopHighlighted: (newStop: any) => void;
+    getHighlightedStopCoordinates: () => number[];
+}, never>, Pick<{
+    highlightedStop: Ref<Stop>;
+    setStopHighlighted: (newStop: any) => void;
+    getHighlightedStopCoordinates: () => number[];
+}, "setStopHighlighted" | "getHighlightedStopCoordinates">>;
+export default useItinerariesStore;

package/dist/components/components/link/Link.vue.d.ts

@@ -0,0 +1,133 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL the link will point to
+     */
+    href: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Option to choose a type which gives the link an icon
+     * `default|external|internal|download`
+     */
+    type: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Option to choose a pre-defined style variant
+     * `primary|on-dark`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Size of icon
+    * `xxs|xs|sm|md|lg|xl`
+    */
+    iconSize: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Option to disable the link
+    */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * If the click should trigger a dataLayerPush
+    */
+    dataLayerValue: {
+        type: StringConstructor;
+        default: any;
+    };
+}, any, any, {
+    variantClass(): string;
+}, {
+    clickHandler(event: any): void;
+    /**
+     * Fires on keypress events on the link, and passes 'space' and 'enter' events
+     * to the click handler to ensure analytics events are properly initiated.
+     */
+    keyHandler(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<{
+    /**
+     * The URL the link will point to
+     */
+    href: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Option to choose a type which gives the link an icon
+     * `default|external|internal|download`
+     */
+    type: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Option to choose a pre-defined style variant
+     * `primary|on-dark`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Size of icon
+    * `xxs|xs|sm|md|lg|xl`
+    */
+    iconSize: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Option to disable the link
+    */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * If the click should trigger a dataLayerPush
+    */
+    dataLayerValue: {
+        type: StringConstructor;
+        default: any;
+    };
+}>>, {
+    type: string;
+    variant: string;
+    href: string;
+    disabled: boolean;
+    dataLayerValue: string;
+    iconSize: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsLink };
+}
+export default _default;
+import VsLink from './Link.vue';

package/dist/components/components/link-list/LinkList.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/link-list/components/LinkListItem.vue.d.ts

@@ -0,0 +1,96 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL the link will point to
+     */
+    href: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Option to create link type which defines icon and whether it opens in a new tab
+     * `external, internal, download, video`
+     */
+    type: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Option to choose a pre-defined style variant
+     * `primary, on-dark`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * The video id that a video type link should open
+     */
+    videoId: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * The localised word for video, gets attached to the link label for video type links
+     */
+    videoDescriptor: {
+        type: StringConstructor;
+        default: any;
+    };
+}, {
+    videoStore: any;
+}, any, {
+    formattedVideoDuration(): string;
+    videoDetails(): any;
+    videoLoaded(): boolean;
+}, {
+    emitShowModal(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The URL the link will point to
+     */
+    href: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Option to create link type which defines icon and whether it opens in a new tab
+     * `external, internal, download, video`
+     */
+    type: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Option to choose a pre-defined style variant
+     * `primary, on-dark`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * The video id that a video type link should open
+     */
+    videoId: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * The localised word for video, gets attached to the link label for video type links
+     */
+    videoDescriptor: {
+        type: StringConstructor;
+        default: any;
+    };
+}>>, {
+    type: string;
+    variant: string;
+    href: string;
+    videoId: string;
+    videoDescriptor: string;
+}, {}>;
+export default _default;

package/dist/components/components/link-list/index.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    export { VsLinkList };
+    export { VsLinkListItem };
+}
+export default _default;
+import VsLinkList from './LinkList.vue';
+import VsLinkListItem from './components/LinkListItem.vue';

package/dist/components/components/list/List.vue.d.ts

@@ -0,0 +1,50 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Option to choose the kind of list needed (ordered | unordered)
+     */
+    ordered: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option to add/remove bullet points
+     */
+    unstyled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option to set the list as inline or normal
+     */
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Option to choose the kind of list needed (ordered | unordered)
+     */
+    ordered: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option to add/remove bullet points
+     */
+    unstyled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option to set the list as inline or normal
+     */
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    inline: boolean;
+    unstyled: boolean;
+    ordered: boolean;
+}, {}>;
+export default _default;

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

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

package/dist/components/components/listicle/ListicleItem.vue.d.ts

@@ -0,0 +1,52 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The index value for the listicle item to be shown on the header
+     */
+    index: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The listicle item title
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The listicle item subtitle
+     */
+    subTitle: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    hasKeyFacilitiesSlot(): boolean;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The index value for the listicle item to be shown on the header
+     */
+    index: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The listicle item title
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The listicle item subtitle
+     */
+    subTitle: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    title: string;
+    index: string;
+    subTitle: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsListicleItem };
+}
+export default _default;
+import VsListicleItem from './ListicleItem.vue';

package/dist/components/components/loading-spinner/LoadingSpinner.vue.d.ts

@@ -0,0 +1,18 @@
+declare const _default: import("vue").DefineComponent<{
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {
+    spinnerClasses(): string;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    variant: string;
+}, {}>;
+export default _default;

package/dist/components/components/loading-spinner/index.d.ts

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsLoadingSpinner };
+}
+export default _default;
+import VsLoadingSpinner from './LoadingSpinner.vue';