@visitscotland/component-library 3.0.1 → 3.0.2

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 @@
+import { default as VsImageWithCaption } from './ImageWithCaption.vue';
+declare namespace _default {
+    export { VsImageWithCaption };
+}
+export default _default;

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';