@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/mega-nav/MegaNav.vue.d.ts

@@ -0,0 +1,151 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL for the VS logo link
+     */
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Accessiblity alt text for the menu button
+     */
+    menuToggleAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Search button text
+     */
+    logoAltText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Search button text
+     */
+    searchButtonText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text that renders in search form label (sr-only)
+     * and input placeholder
+     */
+    searchLabelText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the clear button
+     * on the search form (sr-only)
+     */
+    searchClearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the close button on
+     * the search form (sr-only)
+     */
+    searchCloseButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    isOpen: boolean;
+    showSearch: boolean;
+}, {}, {
+    /**
+     * Toggles dropdown menu property
+     * @returns {Boolean} true if menu is open
+    */
+    menuToggle(): boolean;
+    /**
+     * Toggles site search box when event emitted from button
+    */
+    toggleSearch(): void;
+    /**
+     * Closes the menu as long as the open button hasn't just been clicked
+     */
+    closeMenu(event: any): void;
+    /**
+     * adds event listener for tabbing out of mobile menu
+    */
+    addTabClose(): 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<{
+    /**
+     * The URL for the VS logo link
+     */
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Accessiblity alt text for the menu button
+     */
+    menuToggleAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Search button text
+     */
+    logoAltText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Search button text
+     */
+    searchButtonText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text that renders in search form label (sr-only)
+     * and input placeholder
+     */
+    searchLabelText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the clear button
+     * on the search form (sr-only)
+     */
+    searchClearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the close button on
+     * the search form (sr-only)
+     */
+    searchCloseButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    logoAltText: string;
+    searchLabelText: string;
+    searchClearButtonText: string;
+    searchCloseButtonText: string;
+}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavAccordionItem.vue.d.ts

@@ -0,0 +1,84 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The aria control ID used for panel ID to match button aria control
+     */
+    controlId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The title for the submenu and alias for the testing data-unique-id
+     */
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Level of items in the nav
+     * `1, 2`
+     */
+    level: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * The CTA link used at the top of the accordion dropdown
+     */
+    ctaLink: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The CTA text used for the CTA link at the top of the accordion dropdown
+     */
+    ctaText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    getUniqueId(): string;
+    accordionItemClasses(): string[];
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The aria control ID used for panel ID to match button aria control
+     */
+    controlId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The title for the submenu and alias for the testing data-unique-id
+     */
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Level of items in the nav
+     * `1, 2`
+     */
+    level: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * The CTA link used at the top of the accordion dropdown
+     */
+    ctaLink: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The CTA text used for the CTA link at the top of the accordion dropdown
+     */
+    ctaText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    ctaLink: string;
+    ctaText: string;
+}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavDropdown.vue.d.ts

@@ -0,0 +1,44 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Accessiblity alt text for the menu button
+     */
+    menuToggleAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {
+    /**
+     * Close the menu
+     */
+    closeMenu(): void;
+    /**
+     * Submit event to dataLayer for tracking
+     */
+    dataLayerSubmit(): 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<{
+    /**
+     * Accessiblity alt text for the menu button
+     */
+    menuToggleAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavFeaturedEvent.vue.d.ts

@@ -0,0 +1,29 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * URL to retrieve the information about the featured event
+    * from, if no response do not display
+    */
+    sourceUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    featuredEvent: any;
+}, {}, {
+    /**
+     * Invoked when mounted, retrieves a featured event from the dms
+     */
+    retrieveFeaturedEvent(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * URL to retrieve the information about the featured event
+    * from, if no response do not display
+    */
+    sourceUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    sourceUrl: string;
+}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavFeaturedItem.vue.d.ts

@@ -0,0 +1,48 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * Link URL for the featured item
+    */
+    link: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Image URL for the featured item
+    */
+    imgUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Image alt text for the featured item
+    */
+    imgAlt: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * Link URL for the featured item
+    */
+    link: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Image URL for the featured item
+    */
+    imgUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Image alt text for the featured item
+    */
+    imgAlt: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    imgAlt: string;
+}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavList.vue.d.ts

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

package/dist/components/components/mega-nav/components/MegaNavListItem.vue.d.ts

@@ -0,0 +1,74 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL for the nav list link
+     */
+    href: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Check if link is for subheading
+     */
+    subheadingLink: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Check if link is a CTA link
+     */
+    ctaLink: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {
+    navItemClasses(): {
+        'vs-mega-nav-list-item__heading': boolean;
+        'vs-mega-nav-list-item__link': boolean;
+        'vs-mega-nav-list-item__subheading-link': any;
+        'vs-mega-nav-list-item__cta-link': 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 URL for the nav list link
+     */
+    href: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Check if link is for subheading
+     */
+    subheadingLink: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Check if link is a CTA link
+     */
+    ctaLink: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    href: string;
+    ctaLink: boolean;
+    subheadingLink: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavMobileMenu.vue.d.ts

@@ -0,0 +1,24 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {
+    /**
+     * Submit event to dataLayer for tracking
+     */
+    dataLayerSubmit(text: 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<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/mega-nav/components/MegaNavTopMenu.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/mega-nav/components/MegaNavTopMenuItem.vue.d.ts

@@ -0,0 +1,57 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL for the top level CTA link
+     */
+    href: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text to display for the CTA link
+     */
+    ctaText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Alignment of featured item block - top or bottom
+    */
+    align: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {
+    hasFeaturedItem(): any;
+    hasFeaturedItemLeft(): any;
+    hasFeaturedEvent(): any;
+    alignmentClass(): "" | "vs-mega-nav-top-menu-item__featured--bottom";
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The URL for the top level CTA link
+     */
+    href: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text to display for the CTA link
+     */
+    ctaText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Alignment of featured item block - top or bottom
+    */
+    align: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    align: string;
+    href: string;
+    ctaText: string;
+}, {}>;
+export default _default;

package/dist/components/components/megalinks/Megalinks.vue.d.ts

@@ -0,0 +1,126 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+    * Title for the megalinks component
+    */
+    title: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * Component has an optional main link at the bottom
+    * this is the href for that
+    */
+    buttonLink: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * The component variant
+    */
+    variant: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * The component color theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * A message explaining why the component has been disabled js is disabled, is provided
+    * for descendent components to inject
+    */
+    noJsMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * 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 for the link to the cookies preference centre.
+    */
+    cookieLinkText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    megalinksClasses(): string[];
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+    * Title for the megalinks component
+    */
+    title: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * Component has an optional main link at the bottom
+    * this is the href for that
+    */
+    buttonLink: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * The component variant
+    */
+    variant: {
+        type: StringConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+    * The component color theme
+    */
+    theme: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * A message explaining why the component has been disabled js is disabled, is provided
+    * for descendent components to inject
+    */
+    noJsMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * 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 for the link to the cookies preference centre.
+    */
+    cookieLinkText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    title: string;
+    variant: string;
+    theme: string;
+    noJsMessage: string;
+    noCookiesMessage: string;
+    cookieLinkText: string;
+    buttonLink: string;
+}, {}>;
+export default _default;