@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/heading/Heading.vue.d.ts

@@ -0,0 +1,78 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The heading level used for the heading.
+     * `1|2|3|4|5|6`
+     */
+    level: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Use the thin font
+     */
+    thin: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Alternative font
+     */
+    alternative: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Heading override style
+     * `1|2|3|4|5|6`
+     */
+    overrideStyleLevel: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: any;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {
+    hasSubtitle(): boolean;
+    headingClasses(): (string | {
+        'vs-heading--thin': any;
+        'vs-heading--alternative': any;
+    })[];
+    type(): string;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The heading level used for the heading.
+     * `1|2|3|4|5|6`
+     */
+    level: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Use the thin font
+     */
+    thin: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Alternative font
+     */
+    alternative: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Heading override style
+     * `1|2|3|4|5|6`
+     */
+    overrideStyleLevel: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: any;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    level: string | number;
+    overrideStyleLevel: string | number;
+    thin: boolean;
+    alternative: boolean;
+}, {}>;
+export default _default;

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

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

package/dist/components/components/html-error/HtmlError.vue.d.ts

@@ -0,0 +1,35 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The error status code to report
+     */
+    statusCode: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {}, {
+    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 error status code to report
+     */
+    statusCode: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

package/dist/components/components/html-error/index.d.ts

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

package/dist/components/components/icentre/Icentre.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/icentre/index.d.ts

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

package/dist/components/components/icon/Icon.vue.d.ts

@@ -0,0 +1,128 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The name of the icon to display, which will be the name of the icon file
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+        default: string;
+    };
+    /**
+     * The color of the icon.
+     * `primary|secondary|light|dark|color-white|secondary-teal`
+     */
+    variant: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Accepts a colour (hex code or colour name) for the icon, if this is
+     * set it will override the given variant. This should be used for individual
+     * exceptions but if one is being used regularly it should likely be a variant
+     * instead.
+     */
+    customColour: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * The orientation of the icon
+    * `up|down|left|right`
+    */
+    orientation: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Size of icon
+    * `xxs|xs|sm|md|lg|xl`
+    */
+    size: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Changes the size of the icon at sm and xs viewports
+    * `xxs|xs|sm|md|lg|xl`
+    */
+    smallSize: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+}, any, {
+    iconLookup: {
+        key: string;
+        value: string;
+    }[];
+}, {
+    icon(): any;
+    dimension(): any;
+    formattedName(): any;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The name of the icon to display, which will be the name of the icon file
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+        default: string;
+    };
+    /**
+     * The color of the icon.
+     * `primary|secondary|light|dark|color-white|secondary-teal`
+     */
+    variant: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Accepts a colour (hex code or colour name) for the icon, if this is
+     * set it will override the given variant. This should be used for individual
+     * exceptions but if one is being used regularly it should likely be a variant
+     * instead.
+     */
+    customColour: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * The orientation of the icon
+    * `up|down|left|right`
+    */
+    orientation: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Size of icon
+    * `xxs|xs|sm|md|lg|xl`
+    */
+    size: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Changes the size of the icon at sm and xs viewports
+    * `xxs|xs|sm|md|lg|xl`
+    */
+    smallSize: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    name: string;
+    size: string;
+    variant: string;
+    orientation: string;
+    customColour: string;
+    smallSize: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,80 @@
+declare const _default: {
+    VsIcon: import("vue").DefineComponent<{
+        name: {
+            type: StringConstructor;
+            required: true;
+            default: string;
+        };
+        variant: {
+            type: StringConstructor;
+            default: any;
+            validator: (value: unknown) => any;
+        };
+        customColour: {
+            type: StringConstructor;
+            default: any;
+        };
+        orientation: {
+            type: StringConstructor;
+            default: any;
+            validator: (value: unknown) => any;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+        smallSize: {
+            type: StringConstructor;
+            default: any;
+            validator: (value: unknown) => any;
+        };
+    }, any, {
+        iconLookup: {
+            key: string;
+            value: string;
+        }[];
+    }, {
+        icon(): any;
+        dimension(): any;
+        formattedName(): any;
+    }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+        name: {
+            type: StringConstructor;
+            required: true;
+            default: string;
+        };
+        variant: {
+            type: StringConstructor;
+            default: any;
+            validator: (value: unknown) => any;
+        };
+        customColour: {
+            type: StringConstructor;
+            default: any;
+        };
+        orientation: {
+            type: StringConstructor;
+            default: any;
+            validator: (value: unknown) => any;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+        smallSize: {
+            type: StringConstructor;
+            default: any;
+            validator: (value: unknown) => any;
+        };
+    }>>, {
+        name: string;
+        size: string;
+        variant: string;
+        orientation: string;
+        customColour: string;
+        smallSize: string;
+    }, {}>;
+};
+export default _default;

package/dist/components/components/icon-list/IconList.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The title for the icon list
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The title for the icon list
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    title: string;
+}, {}>;
+export default _default;

package/dist/components/components/icon-list/components/IconListItem.vue.d.ts

@@ -0,0 +1,32 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Label displayed under the icon
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The icon name will be passed to the vs-icon component to select which icon is rendered
+     */
+    icon: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Label displayed under the icon
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The icon name will be passed to the vs-icon component to select which icon is rendered
+     */
+    icon: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

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

@@ -0,0 +1,7 @@
+declare namespace _default {
+    export { VsIconList };
+    export { VsIconListItem };
+}
+export default _default;
+import VsIconList from './IconList.vue';
+import VsIconListItem from './components/IconListItem.vue';

package/dist/components/components/image-with-caption/ImageWithCaption.vue.d.ts

@@ -0,0 +1,276 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The image alt text for screen readers
+     */
+    altText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Chooses to show caption open by default or not: used when images are smaller than 300px
+     */
+    closedDefaultCaption: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The source URL for the image
+     */
+    imageSrc: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Option for a large Hero image at top of a page
+     */
+    isHeroImage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option for a video to open in a modal
+     */
+    isVideo: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option if the mobile view is overlapped at the bottom
+    */
+    mobileOverlap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The screenreader text for the toggle button
+     */
+    toggleButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text for the video play button
+     */
+    playButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The YouTube video ID
+     */
+    videoId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Set to true if component displays a video and is in a narrow container, adjusts
+     * the layout of the play button
+    */
+    smallPlayButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * A message explaining why the component has been disabled with disabled cookies, is
+    * provided for descendent components to inject
+    */
+    noCookiesMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Text used for the link which opens the cookie preference centre, is
+    * provided for descendent components to inject
+    */
+    cookieLinkText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A message explaining why the component has been disabled when js is disabled,
+    * is provided for descendent components to inject
+    */
+    noJsMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    useLazyLoading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Message to show when there's an error with a third party
+    */
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * whether or not to show toggle button
+     */
+    showToggle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    showCaption: boolean;
+    requiredCookies: string[];
+    uniqueCaptionId: string;
+}, {
+    imageWithCaptionClasses(): {
+        'vs-image-with-caption--closed-default': any;
+        'vs-image-with-caption--hero': any;
+        'vs-image-with-caption--show-caption': boolean;
+        'vs-image-with-caption--video': any;
+    };
+    captionWrapperClasses(): {
+        'd-block': boolean;
+        'd-flex': any;
+        container: any;
+    };
+}, {
+    toggleCaption(): void;
+}, {
+    data(): {
+        bypassCookiesExist: boolean;
+    };
+    computed: {
+        onetrustActiveGroups(): any;
+        requiredCookiesExist(): any;
+        cookiesInitStatus(): any;
+        cookiesSet: () => any;
+    };
+    mounted(): void;
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The image alt text for screen readers
+     */
+    altText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Chooses to show caption open by default or not: used when images are smaller than 300px
+     */
+    closedDefaultCaption: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The source URL for the image
+     */
+    imageSrc: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Option for a large Hero image at top of a page
+     */
+    isHeroImage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option for a video to open in a modal
+     */
+    isVideo: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Option if the mobile view is overlapped at the bottom
+    */
+    mobileOverlap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The screenreader text for the toggle button
+     */
+    toggleButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text for the video play button
+     */
+    playButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The YouTube video ID
+     */
+    videoId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Set to true if component displays a video and is in a narrow container, adjusts
+     * the layout of the play button
+    */
+    smallPlayButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * A message explaining why the component has been disabled with disabled cookies, is
+    * provided for descendent components to inject
+    */
+    noCookiesMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Text used for the link which opens the cookie preference centre, is
+    * provided for descendent components to inject
+    */
+    cookieLinkText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * A message explaining why the component has been disabled when js is disabled,
+    * is provided for descendent components to inject
+    */
+    noJsMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    useLazyLoading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Message to show when there's an error with a third party
+    */
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * whether or not to show toggle button
+     */
+    showToggle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    noJsMessage: string;
+    altText: string;
+    closedDefaultCaption: boolean;
+    imageSrc: string;
+    isHeroImage: boolean;
+    isVideo: boolean;
+    mobileOverlap: boolean;
+    toggleButtonText: string;
+    playButtonText: string;
+    videoId: string;
+    smallPlayButton: boolean;
+    noCookiesMessage: string;
+    cookieLinkText: string;
+    useLazyLoading: boolean;
+    errorMessage: string;
+    showToggle: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/image-with-caption/index.d.ts

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