@visitscotland/component-library 2.0.6 → 3.0.0

package/dist/components/components/skip-to/index.d.ts

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

package/dist/components/components/social-credit-link/SocialCreditLink.vue.d.ts

@@ -0,0 +1,50 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * The social credit
+     */
+    credit: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * URL to social item
+     */
+    socialPostUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Where the image came from
+     * `instagram`
+     */
+    source: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The social credit
+     */
+    credit: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * URL to social item
+     */
+    socialPostUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Where the image came from
+     * `instagram`
+     */
+    source: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+}>>, {}, {}>;
+export default _default;

package/dist/components/components/social-credit-link/index.d.ts

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

package/dist/components/components/social-share/SocialShare.vue.d.ts

@@ -0,0 +1,141 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Text to display on share button
+     */
+    shareBtnText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Title text for popover
+     */
+    sharePopoverTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Page URL to share
+     */
+    pageUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Page Title to include in share link
+     */
+    pageTitle: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Accessiblity alt text for the close button
+     */
+    closeAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Unique element ID
+     */
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Displays in a list instead of a popover
+     */
+    noJs: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    copyLink: boolean;
+    renderPopover: boolean;
+}, {}, {
+    /**
+     * Closes popover on close button click
+     */
+    onClose(event: any): void;
+    /**
+     * When popover is shown, focuses on the first share button
+     */
+    onShown(): void;
+    /**
+     * When popover is hidden, focuses back on share button
+     */
+    onHidden(): void;
+    onHide(bvEvent: any): void;
+    onCopyLink(): void;
+    /**
+     * Wait for the popover to be rendered then focus on a given element by ref
+     */
+    focusRef(ref: any): void;
+    /**
+     * Wait for the popover to be rendered then focus on the first share button
+     */
+    focusFirst(): void;
+    /**
+     * When tabbing forward from the close button, trap focus within the modal
+     * and loop back to the start
+     */
+    tabFromClose(event: any): void;
+    /**
+     * When tabbing backwards from the header element, trap focus within the modal
+     * and loop back to the close button
+     */
+    tabBackFromHidden(event: any): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Text to display on share button
+     */
+    shareBtnText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Title text for popover
+     */
+    sharePopoverTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Page URL to share
+     */
+    pageUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Page Title to include in share link
+     */
+    pageTitle: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Accessiblity alt text for the close button
+     */
+    closeAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Unique element ID
+     */
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Displays in a list instead of a popover
+     */
+    noJs: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    pageTitle: string;
+    noJs: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/social-share/components/SocialShareItem.vue.d.ts

@@ -0,0 +1,76 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * Type of link and icon to display
+    */
+    name: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Text to display within the link
+    */
+    linkText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text to display when link is copied
+    */
+    linkCopiedText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    show: boolean;
+}, {
+    iconColour(): string;
+    encodedPageTitle(): string;
+    shareUrl(): string;
+}, {
+    copyToClipboard(event: any): void;
+    trackShareClick(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<{
+    /**
+    * Type of link and icon to display
+    */
+    name: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * Text to display within the link
+    */
+    linkText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Text to display when link is copied
+    */
+    linkCopiedText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    linkCopiedText: string;
+}, {}>;
+export default _default;

package/dist/components/components/social-share/index.d.ts

@@ -0,0 +1,7 @@
+import { default as VsSocialShare } from './SocialShare.vue';
+import { default as VsSocialShareItem } from './components/SocialShareItem.vue';
+declare namespace _default {
+    export { VsSocialShare };
+    export { VsSocialShareItem };
+}
+export default _default;

package/dist/components/components/stretched-link-card/StretchedLinkCard.vue.d.ts

@@ -0,0 +1,219 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The link that the component will use
+    */
+    link: {
+        type: StringConstructor;
+        required: true;
+        default: string;
+    };
+    /**
+    * The correct heading level for page hierarchy, the
+    * heading will be styled the same regardless of level provided
+    * `1|2|3|4|5|6`
+    */
+    headingLevel: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download, video`
+    */
+    type: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The image to use in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the component
+    */
+    imgAlt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Prop to disable link functionality
+    */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 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;
+    };
+    /**
+     * Where the error message should appear
+    */
+    errorType: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Size of warning message to show
+    */
+    warningSize: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, {
+    videoStore: any;
+}, {
+    jsDisabled: boolean;
+    requiredCookies: string[];
+}, {
+    formattedVideoBtnText(): string;
+    formattedVideoDuration(): string;
+    stretchedLinkCardClasses(): string;
+    videoDetails(): any;
+    videoLoaded(): boolean;
+    warningClass(): string;
+    showCookieWarning(): boolean;
+    showError(): boolean;
+    showWarning(): string | boolean;
+    warningMessage(): string;
+    warningAttrs(): {
+        class: string;
+        size: string;
+    };
+}, {
+    emitShowModal(): 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 link that the component will use
+    */
+    link: {
+        type: StringConstructor;
+        required: true;
+        default: string;
+    };
+    /**
+    * The correct heading level for page hierarchy, the
+    * heading will be styled the same regardless of level provided
+    * `1|2|3|4|5|6`
+    */
+    headingLevel: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download, video`
+    */
+    type: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The image to use in the component
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the component
+    */
+    imgAlt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Prop to disable link functionality
+    */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 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;
+    };
+    /**
+     * Where the error message should appear
+    */
+    errorType: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Size of warning message to show
+    */
+    warningSize: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    link: string;
+    imgAlt: string;
+    disabled: boolean;
+    videoId: string;
+    errorMessage: string;
+    videoBtnText: string;
+    headingLevel: string | number;
+    errorType: string;
+    warningSize: string;
+}, {}>;
+export default _default;

package/dist/components/components/stretched-link-card/components/StretchedLinkPanels.vue.d.ts

@@ -0,0 +1,67 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Text to use for 'days' label - to allow for CMS translation
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Text to use for 'days' label - to allow for CMS translation
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    transport: string;
+    days: string;
+    daysLabel: string;
+    transportName: string;
+}, {}>;
+export default _default;

package/dist/components/components/stretched-link-card/index.d.ts

@@ -0,0 +1,7 @@
+import { default as VsStretchedLinkCard } from './StretchedLinkCard.vue';
+import { default as VsStretchedLinkPanels } from './components/StretchedLinkPanels.vue';
+declare namespace _default {
+    export { VsStretchedLinkCard };
+    export { VsStretchedLinkPanels };
+}
+export default _default;

package/dist/components/components/summary-box/SummaryBoxList.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/summary-box/components/SummaryBoxDistanceListItem.vue.d.ts

@@ -0,0 +1,99 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * The number of miles the summary box covers
+     */
+    miles: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The number of kilometres the summary box covers
+     */
+    kilometres: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The main label for the box, should generally be a
+     * localised version of "Distance"
+     */
+    distanceLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The word for `miles` in the current language
+     */
+    milesLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The word for `kilometres` in the current language
+     */
+    kilometresLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the summary box should default to miles
+     * If false it will default to km
+     */
+    showMiles: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The number of miles the summary box covers
+     */
+    miles: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The number of kilometres the summary box covers
+     */
+    kilometres: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The main label for the box, should generally be a
+     * localised version of "Distance"
+     */
+    distanceLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The word for `miles` in the current language
+     */
+    milesLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The word for `kilometres` in the current language
+     */
+    kilometresLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the summary box should default to miles
+     * If false it will default to km
+     */
+    showMiles: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    miles: string;
+    kilometres: string;
+    distanceLabel: string;
+    milesLabel: string;
+    kilometresLabel: string;
+    showMiles: boolean;
+}, {}>;
+export default _default;