@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/megalinks/components/megalink-link-list/MegalinkLinkList.vue.d.ts

@@ -0,0 +1,194 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * The source of the image used in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the component
+    */
+    imgAlt: {
+        required: false;
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download, video`
+    */
+    linkType: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The component color theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The link destination
+    */
+    linkUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Label for days - too allow translation in CMS
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An optional YouTube video ID
+     */
+    videoId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A label to add to the youtube play button if one is present.
+     * Only appears in certain page layouts.
+     */
+    videoBtnText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Message to show when there's an error with a third party
+    */
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * The source of the image used in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the component
+    */
+    imgAlt: {
+        required: false;
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download, video`
+    */
+    linkType: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The component color theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The link destination
+    */
+    linkUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Label for days - too allow translation in CMS
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An optional YouTube video ID
+     */
+    videoId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A label to add to the youtube play button if one is present.
+     * Only appears in certain page layouts.
+     */
+    videoBtnText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Message to show when there's an error with a third party
+    */
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    imgAlt: string;
+    theme: string;
+    days: string;
+    daysLabel: string;
+    transport: string;
+    transportName: string;
+    videoId: string;
+    errorMessage: string;
+    videoBtnText: string;
+}, {}>;
+export default _default;

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

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

package/dist/components/components/megalinks/components/megalink-multi-image/MegalinkMultiImage.vue.d.ts

@@ -0,0 +1,233 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * If the component should be the featured variant
+    */
+    featured: {
+        required: false;
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * If the featured component is the last one
+    */
+    lastFeatured: {
+        required: false;
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * The image to use in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the component
+    */
+    imgAlt: {
+        required: false;
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download, video`
+    */
+    linkType: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The link destination
+    */
+    linkUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * The component color theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Label for days - too allow translation in CMS
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An optional YouTube video ID
+     */
+    videoId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A label to add to the youtube play button if one is present.
+     * Only appears in certain page layouts.
+     */
+    videoBtnText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Message to show when there's an error with a third party
+    */
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    multiImageClasses(): (string | {
+        'vs-megalink-multi-image-card--featured': any;
+        'vs-megalink-multi-image-card--featured-last': any;
+    })[];
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * If the component should be the featured variant
+    */
+    featured: {
+        required: false;
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * If the featured component is the last one
+    */
+    lastFeatured: {
+        required: false;
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * The image to use in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the component
+    */
+    imgAlt: {
+        required: false;
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download, video`
+    */
+    linkType: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The link destination
+    */
+    linkUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * The component color theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Label for days - too allow translation in CMS
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An optional YouTube video ID
+     */
+    videoId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A label to add to the youtube play button if one is present.
+     * Only appears in certain page layouts.
+     */
+    videoBtnText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Message to show when there's an error with a third party
+    */
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    imgAlt: string;
+    theme: string;
+    days: string;
+    daysLabel: string;
+    transport: string;
+    transportName: string;
+    videoId: string;
+    errorMessage: string;
+    videoBtnText: string;
+    featured: boolean;
+    lastFeatured: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/megalinks/components/megalink-multi-image/index.d.ts

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

package/dist/components/components/megalinks/components/megalink-single-image/MegalinkSingleImage.vue.d.ts

@@ -0,0 +1,76 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * Alternate layout with image and text switched sides
+    */
+    alternate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Component title
+    */
+    title: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * Button url
+    */
+    buttonLink: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The component theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, {
+    negativeMargin: string;
+    imageHeight: string;
+}, {
+    singleImageClasses(): string[];
+    cssVars(): {
+        '--negative-margin': string;
+        '--image-height': string;
+    };
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * Alternate layout with image and text switched sides
+    */
+    alternate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Component title
+    */
+    title: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * Button url
+    */
+    buttonLink: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The component theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    title: string;
+    theme: string;
+    buttonLink: string;
+    alternate: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/megalinks/components/megalink-single-image/index.d.ts

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

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

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

package/dist/components/components/modal/Modal.vue.d.ts

@@ -0,0 +1,82 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The ID for the modal, each modal must have a
+     * unique ID.
+     */
+    modalId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to display on close button
+     */
+    closeBtnText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether or not the modal contains an embedded
+     * video
+     */
+    isVideoModal: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * In the jest environment we don't want to have to wait for the mounted
+     * trigger to occur before rendering the component, that fix is only necessary
+     * for the SSR environment and it slows our tests down. There we can skip
+     * through it and render the modal immediately.
+     */
+    autoMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    show: boolean;
+    mounted: boolean;
+}, {}, {
+    /**
+     * Closes modal window
+     */
+    hideModal(): void;
+    showModal(id: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The ID for the modal, each modal must have a
+     * unique ID.
+     */
+    modalId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to display on close button
+     */
+    closeBtnText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether or not the modal contains an embedded
+     * video
+     */
+    isVideoModal: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * In the jest environment we don't want to have to wait for the mounted
+     * trigger to occur before rendering the component, that fix is only necessary
+     * for the SSR environment and it slows our tests down. There we can skip
+     * through it and render the modal immediately.
+     */
+    autoMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    isVideoModal: boolean;
+    autoMount: boolean;
+}, {}>;
+export default _default;

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

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

package/dist/components/components/module-wrapper/ModuleWrapper.vue.d.ts

@@ -0,0 +1,22 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * Theme of module wrapper to use
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * Theme of module wrapper to use
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    theme: string;
+}, {}>;
+export default _default;

package/dist/components/components/module-wrapper/index.d.ts

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