@visitscotland/component-library 2.0.6 → 3.0.0

package/dist/components/components/img/Img.vue.d.ts

@@ -0,0 +1,121 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * The source URL
+     */
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Provide low res image to be initially loaded
+     */
+    lowResImage: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * The alt text for accessibility
+     */
+    alt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * If true makes the image responsive, scaling with the parent
+     * up to a max of the native width of the image itself
+     */
+    fluid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If true makes the image responsive, scaling with the parent
+     * beyond the native image width if necessary
+     */
+    fluidGrow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If true a generic LQIP is used for lazyloading, rather than the
+     * provided xxs path to the image scaler. Used when the image scaler
+     * is not functioning as desired for certain images.
+     */
+    useGenericLqip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If true switches on lazy loading for the image
+    */
+    useLazyLoading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {
+    imgStyle(): {
+        backgroundImage: string;
+    };
+}, {}, any, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The source URL
+     */
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Provide low res image to be initially loaded
+     */
+    lowResImage: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * The alt text for accessibility
+     */
+    alt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * If true makes the image responsive, scaling with the parent
+     * up to a max of the native width of the image itself
+     */
+    fluid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If true makes the image responsive, scaling with the parent
+     * beyond the native image width if necessary
+     */
+    fluidGrow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If true a generic LQIP is used for lazyloading, rather than the
+     * provided xxs path to the image scaler. Used when the image scaler
+     * is not functioning as desired for certain images.
+     */
+    useGenericLqip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If true switches on lazy loading for the image
+    */
+    useLazyLoading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    alt: string;
+    useGenericLqip: boolean;
+    fluid: boolean;
+    useLazyLoading: boolean;
+    fluidGrow: boolean;
+    lowResImage: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,2 @@
+import { default as VsImg } from './Img.vue';
+export default VsImg;

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

@@ -0,0 +1,115 @@
+export { default as VsAccordion } from './accordion/Accordion.vue';
+export { default as VsAccordionItem } from './accordion/components/AccordionItem.vue';
+export { default as VsAccordionToggle } from './accordion/components/AccordionToggle.vue';
+export { default as VsAddress } from './address/Address.vue';
+export { default as VsAlert } from './alert/Alert.vue';
+export { default as VsArticle } from './article/Article.vue';
+export { default as VsArticleSection } from './article/components/ArticleSection.vue';
+export { default as VsArticleSidebar } from './article/components/ArticleSidebar.vue';
+export { default as VsBanner } from './banner/Banner.vue';
+export { default as VsBlogDetails } from './blog-details/BlogDetails.vue';
+export { default as VsBreadcrumb } from './breadcrumb/Breadcrumb.vue';
+export { default as VsBreadcrumbItem } from './breadcrumb/components/BreadcrumbItem.vue';
+export { default as VsButton } from './button/Button.vue';
+export { default as VsButtonToggleGroup } from './button-toggle-group/ButtonToggleGroup.vue';
+export { default as VsCannedSearch } from './canned-search/CannedSearch.vue';
+export { default as VsCaption } from './caption/Caption.vue';
+export { default as VsCarbonCalculator } from './carbon-calculator/CarbonCalculator.vue';
+export { default as VsCarousel } from './carousel/Carousel.vue';
+export { default as VsCarouselSlide } from './carousel/components/CarouselSlide.vue';
+export { default as VsCheckbox } from './checkbox/Checkbox.vue';
+export { default as VsCookieChecker } from './cookie-checker/CookieChecker.vue';
+export { default as VsDescriptionList } from './description-list/DescriptionList.vue';
+export { default as VsDescriptionListItem } from './description-list/components/DescriptionListItem.vue';
+export { default as VsDropdown } from './dropdown/Dropdown.vue';
+export { default as VsDropdownItem } from './dropdown/components/DropdownItem.vue';
+export { default as VsEmbedWrapper } from './embed-wrapper/EmbedWrapper.vue';
+export { default as VsFooter } from './footer/Footer.vue';
+export { default as VsFooterAccordionItem } from './footer/components/FooterAccordionItem.vue';
+export { default as VsFooterNavListItem } from './footer/components/FooterNavListItem.vue';
+export { default as VsFooterSocialMenu } from './footer/components/FooterSocialMenu.vue';
+export { default as VsFooterSocialItem } from './footer/components/FooterSocialItem.vue';
+export { default as VsFooterUtilityList } from './footer/components/FooterUtilityList.vue';
+export { default as VsFooterCopyright } from './footer/components/FooterCopyright.vue';
+export { default as VsGlobalMenu } from './global-menu/GlobalMenu.vue';
+export { default as VsGlobalMenuLanguage } from './global-menu/components/GlobalMenuLanguage.vue';
+export { default as VsGlobalMenuLanguageItem } from './global-menu/components/GlobalMenuLanguageItem.vue';
+export { default as VsCol } from './grid/Col.vue';
+export { default as VsContainer } from './grid/Container.vue';
+export { default as VsRow } from './grid/Row.vue';
+export { default as VsHeading } from './heading/Heading.vue';
+export { default as VsHtmlError } from './html-error/HtmlError.vue';
+export { default as VsIcentre } from './icentre/Icentre.vue';
+export { default as VsIcon } from './icon/Icon.vue';
+export { default as VsIconList } from './icon-list/IconList.vue';
+export { default as VsIconListItem } from './icon-list/components/IconListItem.vue';
+export { default as VsImageWithCaption } from './image-with-caption/ImageWithCaption.vue';
+export { default as VsImg } from './img/Img.vue';
+export { default as VsInput } from './input/Input.vue';
+export { default as VsItinerary } from './itineraries/Itinerary.vue';
+export { default as VsItineraryDay } from './itineraries/components/ItineraryDay.vue';
+export { default as VsItineraryStop } from './itineraries/components/ItineraryStop.vue';
+export { default as VsItineraryStopInfo } from './itineraries/components/ItineraryStopInfo.vue';
+export { default as VsItineraryTips } from './itineraries/components/ItineraryTips.vue';
+export { default as VsLink } from './link/Link.vue';
+export { default as VsList } from './list/List.vue';
+export { default as VsLinkList } from './link-list/LinkList.vue';
+export { default as VsLinkListItem } from './link-list/components/LinkListItem.vue';
+export { default as VsListicleItem } from './listicle/ListicleItem.vue';
+export { default as VsLoadingSpinner } from './loading-spinner/LoadingSpinner.vue';
+export { default as VsForm } from './form/Form.vue';
+export { default as VsMeganav } from './mega-nav/MegaNav.vue';
+export { default as VsMegaNavDropdownContainer } from './mega-nav/components/MegaNavDropdownContainer.vue';
+export { default as VsMegaNavList } from './mega-nav/components/MegaNavList.vue';
+export { default as VsMegaNavListItem } from './mega-nav/components/MegaNavListItem.vue';
+export { default as VsMegaNavAccordionItem } from './mega-nav/components/MegaNavAccordionItem.vue';
+export { default as VsMegaNavFeaturedItem } from './mega-nav/components/MegaNavFeaturedItem.vue';
+export { default as VsMegaNavFeaturedEvent } from './mega-nav/components/MegaNavFeaturedEvent.vue';
+export { default as VsMegaNavStaticLink } from './mega-nav/components/MegaNavStaticLink.vue';
+export { default as VsMegalinks } from './megalinks/Megalinks.vue';
+export { default as VsMegalinkLinkList } from './megalinks/components/megalink-link-list/MegalinkLinkList.vue';
+export { default as VsMegalinkMultiImage } from './megalinks/components/megalink-multi-image/MegalinkMultiImage.vue';
+export { default as VsMegalinkSingleImage } from './megalinks/components/megalink-single-image/MegalinkSingleImage.vue';
+export { default as VsModal } from './modal/Modal.vue';
+export { default as VsModuleWrapper } from './module-wrapper/ModuleWrapper.vue';
+export { default as VsNumberInput } from './number-input/NumberInput.vue';
+export { default as VsPageIntro } from './page-intro/PageIntro.vue';
+export { default as VsPanel } from './panel/Panel.vue';
+export { default as VsProductSearch } from './product-search/ProductSearch.vue';
+export { default as VsProgressBar } from './progress-bar/ProgressBar.vue';
+export { default as VsRadioButton } from './radio-button/RadioButton.vue';
+export { default as VsQuote } from './quote/Quote.vue';
+export { default as VsRecaptcha } from './recaptcha/Recaptcha.vue';
+export { default as VsRichTextWrapper } from './rich-text-wrapper/RichTextWrapper.vue';
+export { default as VsSelect } from './select/Select.vue';
+export { default as VsSiteSearch } from './site-search/SiteSearch.vue';
+export { default as VsSiteSearchForm } from './site-search/components/SiteSearchForm.vue';
+export { default as VsSkiScotlandCard } from './ski-scotland/ski-scotland-card/SkiScotlandCard.vue';
+export { default as VsSkiScotlandStatus } from './ski-scotland/ski-scotland-status/SkiScotlandStatus.vue';
+export { default as VsSkipTo } from './skip-to/SkipTo.vue';
+export { default as VsSocialCreditLink } from './social-credit-link/SocialCreditLink.vue';
+export { default as VsSocialShare } from './social-share/SocialShare.vue';
+export { default as VsSocialShareItem } from './social-share/components/SocialShareItem.vue';
+export { default as VsStretchedLinkCard } from './stretched-link-card/StretchedLinkCard.vue';
+export { default as VsStretchedLinkPanel } from './stretched-link-card/components/StretchedLinkPanels.vue';
+export { default as VsSummaryBoxList } from './summary-box/SummaryBoxList.vue';
+export { default as VsSummaryBoxListItem } from './summary-box/components/SummaryBoxListItem.vue';
+export { default as VsSummaryBoxDistanceListItem } from './summary-box/components/SummaryBoxDistanceListItem.vue';
+export { default as VsSvg } from './svg/Svg.vue';
+export { default as VsSvgLink } from './svg-link/SvgLink.vue';
+export { default as VsTable } from './table/Table.vue';
+export { default as VsTableHead } from './table/components/TableHead.vue';
+export { default as VsTableRow } from './table/components/TableRow.vue';
+export { default as VsTableHeaderCell } from './table/components/TableHeaderCell.vue';
+export { default as VsTableBody } from './table/components/TableBody.vue';
+export { default as VsTableDataCell } from './table/components/TableDataCell.vue';
+export { default as VsTableFooter } from './table/components/TableFooter.vue';
+export { default as VsTabs } from './tabs/Tabs.vue';
+export { default as VsTabItem } from './tabs/components/TabItem.vue';
+export { default as VsTag } from './tag/Tag.vue';
+export { default as VsTagManagerWrapper } from './tag-manager-wrapper/TagManagerWrapper.vue';
+export { default as VsToggleButton } from './toggle-button/ToggleButton.vue';
+export { default as VsTooltip } from './tooltip/Tooltip.vue';
+export { default as VsVideo } from './video/Video.vue';
+export { default as VsVideoCaption } from './video-caption/VideoCaption.vue';
+export { default as VsWarning } from './warning/Warning.vue';

package/dist/components/components/input/Input.vue.d.ts

@@ -0,0 +1,310 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Name of the field (if different from ID)
+     */
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Type of input
+     */
+    type: {
+        type: StringConstructor;
+        default: string;
+    };
+    autoComplete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Option to disable the input
+    */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to trigger manual validation. Used by a parent
+     * component to trigger validation eg. when the submit
+     * button is clicked.
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specific validation messages for different
+     * types of validation
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Fallback translated validation - this is a set of
+     * validation messages to be used when no specific
+     * validation message is needed, eg. "This field is required"
+     */
+    genericValidation: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Content for hint text
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for the 'clear' button
+     * the existence of this will defined whether the button
+     * also exists
+     */
+    clearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Element placeholder text
+     */
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    v$: import('vue').Ref<import('@vuelidate/core').Validation<import('@vuelidate/core').ValidationArgs<unknown>, unknown>>;
+}, {
+    inputVal: string;
+    clearErrorsOnFocus: boolean;
+}, {
+    /**
+     * element type class plus error classes
+     */
+    elementClass(): string;
+    showClearButton(): boolean;
+}, {
+    /**
+     * Clear any text entered in the input
+     */
+    clearInput(): void;
+    /**
+     * Focus on the input
+     */
+    focusOnInput(): void;
+    /**
+     * Clears the input on button click
+     * and adds focus back to the input
+     */
+    clearInputAndFocus(): void;
+    /**
+     *  return autocomplete value in appropriate places
+     */
+    autocompleteValue(fieldName: any): string;
+    /**
+     * Validate errors on blur, and re-render them to the screen for screen
+     * reader notice
+     */
+    validateErrors(): void;
+    /**
+     * Reset field errors on focus to allow screen reader to notice them if still
+     * present on blur
+     */
+    resetErrors(): void;
+}, {
+    data(): {
+        inputVal: any;
+        /**
+         * An input allows a user to enter a short amount of text.
+         *
+         * @displayName Input
+         */
+        isInvalid: any;
+    };
+    computed: {
+        isRequired(): boolean;
+        rules(): {
+            inputVal: {};
+        } | {
+            inputVal?: undefined;
+        };
+        errorsList(): any[];
+    };
+    watch: {
+        errorsList(newValue: any): void;
+    };
+    methods: {
+        manualValidate(): void;
+        emitStatus(): void;
+    };
+} | {
+    computed: {
+        ariaDescription(): string;
+    };
+}, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Name of the field (if different from ID)
+     */
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Type of input
+     */
+    type: {
+        type: StringConstructor;
+        default: string;
+    };
+    autoComplete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Option to disable the input
+    */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to trigger manual validation. Used by a parent
+     * component to trigger validation eg. when the submit
+     * button is clicked.
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specific validation messages for different
+     * types of validation
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Fallback translated validation - this is a set of
+     * validation messages to be used when no specific
+     * validation message is needed, eg. "This field is required"
+     */
+    genericValidation: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Content for hint text
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for the 'clear' button
+     * the existence of this will defined whether the button
+     * also exists
+     */
+    clearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Element placeholder text
+     */
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    name: string;
+    value: string;
+    type: string;
+    disabled: boolean;
+    hintText: string;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+    placeholder: string;
+    autoComplete: boolean;
+    clearButtonText: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,2 @@
+import { default as VsInput } from './Input.vue';
+export default VsInput;

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

@@ -0,0 +1,43 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Text for 'list view'
+     */
+    listViewText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for 'map view'
+     */
+    mapViewText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    showMap: boolean;
+    isDesktop: boolean;
+    withinItineraryMain: boolean;
+}, {}, {
+    resizeWidth(): void;
+    onScroll(): void;
+    toggleShowMap(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Text for 'list view'
+     */
+    listViewText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for 'map view'
+     */
+    mapViewText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    listViewText: string;
+    mapViewText: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,66 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Logic to collapse certain Day list items on mobile by default
+     * (e.g. after Day 1 and 2, collapse the days on mobile)
+     */
+    defaultShow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Label used for the word 'Day'
+     */
+    dayLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Number of the day in the component
+     */
+    dayNumber: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Title of the day in the component
+     */
+    dayTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, {
+    show: boolean;
+}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Logic to collapse certain Day list items on mobile by default
+     * (e.g. after Day 1 and 2, collapse the days on mobile)
+     */
+    defaultShow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Label used for the word 'Day'
+     */
+    dayLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Number of the day in the component
+     */
+    dayNumber: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Title of the day in the component
+     */
+    dayTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {
+    defaultShow: boolean;
+}, {}>;
+export default _default;