@visitscotland/component-library 3.0.1 → 3.0.2

package/dist/components/components/carousel/components/CarouselSlide.vue.d.ts

@@ -0,0 +1,176 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * 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;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download`
+    */
+    linkType: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The link destination
+    */
+    linkUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Translatable text for the 'category' label
+    */
+    categoryLabel: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * The category of the content
+    */
+    category: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Label for days - too allow translation in CMS
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Mandatory index of slide -
+    * needed to calculate active slides
+    */
+    slideIndex: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {
+    isVisible(slideNum: any): boolean;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * 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;
+    };
+    /**
+    * The type of link. This will set the icon.
+    * `external, internal, download`
+    */
+    linkType: {
+        type: StringConstructor;
+        required: true;
+        validator: (value: unknown) => any;
+    };
+    /**
+    * The link destination
+    */
+    linkUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+    * Translatable text for the 'category' label
+    */
+    categoryLabel: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * The category of the content
+    */
+    category: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+    * Optional prop for number of days
+    */
+    days: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Label for days - too allow translation in CMS
+    */
+    daysLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Optional prop for transport type (will show a the transport icon if used)
+    */
+    transport: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Display-friendly transport name
+    * to allow for translation
+    */
+    transportName: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Mandatory index of slide -
+    * needed to calculate active slides
+    */
+    slideIndex: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {
+    imgAlt: string;
+    transport: string;
+    days: string;
+    categoryLabel: string;
+    category: string;
+    daysLabel: string;
+    transportName: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,7 @@
+import { default as VsCarousel } from './Carousel.vue';
+import { default as VsCarouselSlide } from './components/CarouselSlide.vue';
+declare namespace _default {
+    export { VsCarousel };
+    export { VsCarouselSlide };
+}
+export default _default;

package/dist/components/components/checkbox/Checkbox.vue.d.ts

@@ -0,0 +1,218 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Name of the input
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Value when checked
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Label for checkbox
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * 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(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 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;
+    };
+    /**
+     * Content for info text
+     */
+    infoText: {
+        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;
+    errors: any[];
+}, {
+    errorClass(): "" | "vs-checkbox--error";
+}, {}, {
+    data(): {
+        inputVal: any;
+        isInvalid: any;
+    };
+    computed: {
+        isRequired(): boolean;
+        rules(): {
+            inputVal: {};
+        } | {
+            inputVal?: undefined;
+        }; /**
+         * 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
+         */
+        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<{
+    /**
+     * Name of the input
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Value when checked
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Label for checkbox
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * 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(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 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;
+    };
+    /**
+     * Content for info text
+     */
+    infoText: {
+        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;
+    };
+}>>, {
+    value: string;
+    hintText: string;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    infoText: string;
+    reAlertErrors: boolean;
+}, {}>;
+export default _default;

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

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

package/dist/components/components/cookie-checker/CookieChecker.vue.d.ts

@@ -0,0 +1,17 @@
+import { default as OneTrustVS } from '../../utils/one-trust';
+declare const _default: import('vue').DefineComponent<{}, {}, {
+    oneTrust: OneTrustVS;
+    activeGroups: string;
+}, {}, {
+    /**
+     * initialises listener to ensure accepted cookie values
+     * are updated when OneTrust preferences are changed
+     */
+    checkOneTrust(): void;
+    /**
+     * checks cookies have been accepted via OneTrust and
+     * adds them to activeGroups
+     */
+    checkActiveGroups(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/cookie-checker/index.d.ts

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

package/dist/components/components/description-list/DescriptionList.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Option to create inline list
+     */
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Option to create inline list
+     */
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    inline: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/description-list/components/DescriptionListItem.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Use this option to render this component with a title styling.
+     */
+    title: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Use this option to render this component with a title styling.
+     */
+    title: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    title: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,4 @@
+import { default as VsDescriptionList } from './DescriptionList.vue';
+import { default as VsDescriptionListItem } from './components/DescriptionListItem.vue';
+
+export { VsDescriptionList, VsDescriptionListItem };

package/dist/components/components/dropdown/Dropdown.vue.d.ts

@@ -0,0 +1,16 @@
+declare const _default: import('vue').DefineComponent<{
+    text: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    nonButtonContentSlots(): any[];
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    text: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    text: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,4 @@
+import { default as VsDropdown } from './Dropdown.vue';
+import { default as VsDropdownItem } from './components/DropdownItem.vue';
+
+export { VsDropdown, VsDropdownItem };

package/dist/components/components/embed-wrapper/EmbedWrapper.vue.d.ts

@@ -0,0 +1,78 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Set to true if the embedded code does not require a cookie check
+     */
+    noCookiesRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Text to display when cookies have been rejected
+     */
+    noCookieText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to display when there is an error displaying the content
+     */
+    errorText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to display when javascript has been turned off
+     */
+    noJsText: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, {
+    requiredCookies: string[];
+}, {
+    showError(): boolean;
+    warningText(): string;
+}, {}, {
+    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<{
+    /**
+     * Set to true if the embedded code does not require a cookie check
+     */
+    noCookiesRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Text to display when cookies have been rejected
+     */
+    noCookieText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to display when there is an error displaying the content
+     */
+    errorText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to display when javascript has been turned off
+     */
+    noJsText: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {
+    noCookiesRequired: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/embed-wrapper/index.d.ts

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

package/dist/components/components/footer/Footer.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/footer/components/FooterAccordionItem.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;
+    };
+    /**
+     * If this is provided, the accordion expands above
+     * the specified viewport `xs, sm, md, lg, xl, xxl`
+     */
+    itemBreakPoint: {
+        type: StringConstructor;
+        default: (props: any) => any;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Choose to show accordion open or closed by default
+     */
+    openByDefault: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The title for the submenu and alias for the testing data-unique-id
+     */
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Variant for which button to show in headers
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    getUniqueId(): 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;
+    };
+    /**
+     * If this is provided, the accordion expands above
+     * the specified viewport `xs, sm, md, lg, xl, xxl`
+     */
+    itemBreakPoint: {
+        type: StringConstructor;
+        default: (props: any) => any;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Choose to show accordion open or closed by default
+     */
+    openByDefault: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The title for the submenu and alias for the testing data-unique-id
+     */
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Variant for which button to show in headers
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    itemBreakPoint: string;
+    openByDefault: boolean;
+    variant: string;
+}, {}>;
+export default _default;