@visitscotland/component-library 5.61.1 → 5.63.0

package/dist/components/components/radio-button/RadioButton.vue.d.ts

@@ -0,0 +1,444 @@
+declare const _default: import('vue').DefineComponent<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;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        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(): {};
+    };
+    /**
+     * 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;
+    };
+    /**
+     * An array of options that the user can select. Each should be an object with a `value`
+     * string (that is submitted as part of the answer to the carbon calculation), a `text`
+     * string which denotes what the answer represents, and an `icon` string which dictates
+     * which icon is rendered on the radio button.
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * An optional string which provides the user further information about how to answer
+     * the question. Appears below the radio button input.
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    v$: import('vue').Ref<import('@vuelidate/core').Validation<import('@vuelidate/core').ValidationArgs<unknown>, unknown>, import('@vuelidate/core').Validation<import('@vuelidate/core').ValidationArgs<unknown>, unknown>>;
+}, {
+    inputVal: string;
+    clearErrorsOnFocus: boolean;
+    checkedValue: string;
+}, {
+    /**
+     * element type class plus error classes
+     */
+    elementClass(): string;
+    showClearButton(): boolean;
+    errorClass(): "" | "vs-input--error";
+}, {
+    /**
+     * Clear any text entered in the input
+     */
+    clearInput(): void;
+    /**
+     * Focus on the input
+     */
+    focusOnInput(): void;
+    /**
+     * 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;
+    valueChanged(newData: any): void;
+}, {
+    emits: string[];
+    data(): {
+        inputVal: any;
+        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, ("updated" | "updateFieldData")[], "updated" | "updateFieldData", 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;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        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(): {};
+    };
+    /**
+     * 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;
+    };
+    /**
+     * An array of options that the user can select. Each should be an object with a `value`
+     * string (that is submitted as part of the answer to the carbon calculation), a `text`
+     * string which denotes what the answer represents, and an `icon` string which dictates
+     * which icon is rendered on the radio button.
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * An optional string which provides the user further information about how to answer
+     * the question. Appears below the radio button input.
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onUpdated?: (...args: any[]) => any;
+    onUpdateFieldData?: (...args: any[]) => any;
+}>, {
+    value: string;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+    hintText: string;
+}, {}, {
+    BFormRadioGroup: <Options extends readonly (object | string | number | boolean)[] = readonly (string | number | boolean | object)[]>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: {
+        slots: {
+            first?(_: {}): any;
+            option?(_: {
+                [key: string]: unknown;
+                text: string | undefined;
+                value: any;
+                disabled?: boolean | undefined;
+            }): any;
+            default?(_: {}): any;
+        };
+        attrs: any;
+        emit: (evt: "update:modelValue", value: import('bootstrap-vue-next').OptionsValues<Options> | undefined) => void;
+    }, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+        props: {
+            readonly "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').OptionsValues<Options> | undefined) => any) | undefined;
+            modelValue?: import('bootstrap-vue-next').OptionsValues<Options> | undefined;
+            reverse?: boolean;
+            required?: boolean;
+            name?: string;
+            size?: import('bootstrap-vue-next').Size;
+            id?: string;
+            state?: import('bootstrap-vue-next').ValidationState;
+            disabled?: boolean;
+            ariaInvalid?: import('bootstrap-vue-next').AriaInvalid;
+            validated?: boolean;
+            autofocus?: boolean;
+            buttonVariant?: import('bootstrap-vue-next').ButtonVariant | null;
+            form?: string;
+            plain?: boolean;
+            options?: Options;
+            buttons?: boolean;
+            disabledField?: string;
+            stacked?: boolean;
+            textField?: string;
+            valueField?: string;
+        } & import('vue').PublicProps;
+        expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+        attrs: any;
+        slots: {
+            first?(_: {}): any;
+            option?(_: {
+                [key: string]: unknown;
+                text: string | undefined;
+                value: any;
+                disabled?: boolean | undefined;
+            }): any;
+            default?(_: {}): any;
+        };
+        emit: (evt: "update:modelValue", value: import('bootstrap-vue-next').OptionsValues<Options> | undefined) => void;
+    }>) => import('vue').VNode & {
+        __ctx?: Awaited<typeof __VLS_setup>;
+    };
+    BFormRadio: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+            modelValue?: import('bootstrap-vue-next').BFormRadioProps["modelValue"];
+        } & {
+            reverse?: boolean;
+            required?: boolean;
+            name?: string;
+            value?: import('bootstrap-vue-next').RadioValue;
+            size?: import('bootstrap-vue-next').Size;
+            id?: string;
+            state?: import('bootstrap-vue-next').ValidationState;
+            disabled?: boolean;
+            button?: boolean;
+            ariaLabel?: string;
+            ariaLabelledby?: string;
+            autofocus?: boolean;
+            buttonGroup?: boolean;
+            buttonVariant?: import('bootstrap-vue-next').ButtonVariant | null;
+            form?: string;
+            inline?: boolean;
+            plain?: boolean;
+        }> & Readonly<{
+            "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').RadioValue | undefined) => any) | undefined;
+        }>, {
+            blur: () => void;
+            element: Readonly<import('vue').ShallowRef<HTMLInputElement | null>>;
+            focus: () => void;
+        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+            "update:modelValue": (value: import('bootstrap-vue-next').RadioValue | undefined) => any;
+        }, import('vue').PublicProps, {
+            value: import('bootstrap-vue-next').RadioValue;
+            disabled: boolean;
+            autofocus: boolean;
+            form: string;
+            id: string;
+            name: string;
+            required: boolean;
+            size: import('bootstrap-vue-next').Size;
+            state: import('bootstrap-vue-next').ValidationState;
+            button: boolean;
+            buttonGroup: boolean;
+            reverse: boolean;
+            ariaLabel: string;
+            inline: boolean;
+            plain: boolean;
+            ariaLabelledby: string;
+            buttonVariant: import('bootstrap-vue-next').ButtonVariant | null;
+        }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+            _input: HTMLInputElement;
+        }, any, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<{
+            modelValue?: import('bootstrap-vue-next').BFormRadioProps["modelValue"];
+        } & {
+            reverse?: boolean;
+            required?: boolean;
+            name?: string;
+            value?: import('bootstrap-vue-next').RadioValue;
+            size?: import('bootstrap-vue-next').Size;
+            id?: string;
+            state?: import('bootstrap-vue-next').ValidationState;
+            disabled?: boolean;
+            button?: boolean;
+            ariaLabel?: string;
+            ariaLabelledby?: string;
+            autofocus?: boolean;
+            buttonGroup?: boolean;
+            buttonVariant?: import('bootstrap-vue-next').ButtonVariant | null;
+            form?: string;
+            inline?: boolean;
+            plain?: boolean;
+        }> & Readonly<{
+            "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').RadioValue | undefined) => any) | undefined;
+        }>, {
+            blur: () => void;
+            element: Readonly<import('vue').ShallowRef<HTMLInputElement | null>>;
+            focus: () => void;
+        }, {}, {}, {}, {
+            value: import('bootstrap-vue-next').RadioValue;
+            disabled: boolean;
+            autofocus: boolean;
+            form: string;
+            id: string;
+            name: string;
+            required: boolean;
+            size: import('bootstrap-vue-next').Size;
+            state: import('bootstrap-vue-next').ValidationState;
+            button: boolean;
+            buttonGroup: boolean;
+            reverse: boolean;
+            ariaLabel: string;
+            inline: boolean;
+            plain: boolean;
+            ariaLabelledby: string;
+            buttonVariant: import('bootstrap-vue-next').ButtonVariant | null;
+        }>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<{
+        modelValue?: import('bootstrap-vue-next').BFormRadioProps["modelValue"];
+    } & {
+        reverse?: boolean;
+        required?: boolean;
+        name?: string;
+        value?: import('bootstrap-vue-next').RadioValue;
+        size?: import('bootstrap-vue-next').Size;
+        id?: string;
+        state?: import('bootstrap-vue-next').ValidationState;
+        disabled?: boolean;
+        button?: boolean;
+        ariaLabel?: string;
+        ariaLabelledby?: string;
+        autofocus?: boolean;
+        buttonGroup?: boolean;
+        buttonVariant?: import('bootstrap-vue-next').ButtonVariant | null;
+        form?: string;
+        inline?: boolean;
+        plain?: boolean;
+    }> & Readonly<{
+        "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').RadioValue | undefined) => any) | undefined;
+    }>, {
+        blur: () => void;
+        element: Readonly<import('vue').ShallowRef<HTMLInputElement | null>>;
+        focus: () => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        "update:modelValue": (value: import('bootstrap-vue-next').RadioValue | undefined) => any;
+    }, string, {
+        value: import('bootstrap-vue-next').RadioValue;
+        disabled: boolean;
+        autofocus: boolean;
+        form: string;
+        id: string;
+        name: string;
+        required: boolean;
+        size: import('bootstrap-vue-next').Size;
+        state: import('bootstrap-vue-next').ValidationState;
+        button: boolean;
+        buttonGroup: boolean;
+        reverse: boolean;
+        ariaLabel: string;
+        inline: boolean;
+        plain: boolean;
+        ariaLabelledby: string;
+        buttonVariant: import('bootstrap-vue-next').ButtonVariant | null;
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+        $slots: Readonly<import('bootstrap-vue-next').BFormRadioSlots> & import('bootstrap-vue-next').BFormRadioSlots;
+    });
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/components/recaptcha/Recaptcha.vue.d.ts

@@ -0,0 +1,116 @@
+import { VueRecaptcha } from 'vue-recaptcha';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * Recaptcha site key string
+     */
+    siteKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether or not the form is invalid - this should
+     * also only be true when an attempt at submission has
+     * been made
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Language to show text in
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Validation message if the recaptcha isn't completed
+     */
+    errorMsg: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for invisible recaptcha textarea - tells
+     * screenreader users it's not needed
+     */
+    textareaLabel: {
+        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;
+    };
+}>, {}, {
+    response: any;
+    recaptchaSiteKey: string;
+}, {}, {
+    verified(response: any): void;
+    render(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "verified"[], "verified", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Recaptcha site key string
+     */
+    siteKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether or not the form is invalid - this should
+     * also only be true when an attempt at submission has
+     * been made
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Language to show text in
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Validation message if the recaptcha isn't completed
+     */
+    errorMsg: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for invisible recaptcha textarea - tells
+     * screenreader users it's not needed
+     */
+    textareaLabel: {
+        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;
+    };
+}>> & Readonly<{
+    onVerified?: (...args: any[]) => any;
+}>, {
+    language: string;
+    invalid: boolean;
+    reAlertErrors: boolean;
+    siteKey: string;
+    errorMsg: string;
+    textareaLabel: string;
+}, {}, {
+    VueRecaptcha: typeof VueRecaptcha;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;