@visitscotland/component-library 5.61.1 → 5.62.0

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

@@ -0,0 +1,424 @@
+declare const _default: import('vue').DefineComponent<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;
+    };
+    /**
+     * Size of the checkbox
+     * `sm|md|lg`.
+     */
+    size: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+}>, {
+    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;
+    errors: any[];
+}, {
+    checkBoxClasses(): {
+        'vs-checkbox': boolean;
+        'vs-checkbox--error': any;
+        'vs-checkbox--small': boolean;
+    };
+}, {}, {
+    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, {}, 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;
+    };
+    /**
+     * Size of the checkbox
+     * `sm|md|lg`.
+     */
+    size: {
+        type: StringConstructor;
+        default: any;
+        validator: (value: unknown) => any;
+    };
+}>> & Readonly<{}>, {
+    value: string;
+    size: string;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+    hintText: string;
+    infoText: string;
+}, {}, {
+    BFormCheckbox: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+            modelValue?: import('bootstrap-vue-next').BFormCheckboxProps["modelValue"];
+            indeterminate?: Exclude<import('bootstrap-vue-next').BFormCheckboxProps["indeterminate"], undefined>;
+        } & {
+            reverse?: boolean;
+            required?: boolean;
+            name?: string;
+            value?: string | boolean | import('bootstrap-vue-next').CheckboxValue;
+            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;
+            switch?: boolean;
+            uncheckedValue?: import('bootstrap-vue-next').CheckboxValue;
+            wrapperAttrs?: Readonly<import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').AttrsValue>;
+            inputClass?: import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').ClassValue;
+        }> & Readonly<{
+            "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').CheckboxValue | readonly import('bootstrap-vue-next').CheckboxValue[] | undefined) => any) | undefined;
+            "onUpdate:indeterminate"?: ((value: boolean) => 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').CheckboxValue | readonly import('bootstrap-vue-next').CheckboxValue[] | undefined) => any;
+            "update:indeterminate": (value: boolean) => any;
+        }, import('vue').PublicProps, {
+            value: string | boolean | import('bootstrap-vue-next').CheckboxValue;
+            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;
+            switch: boolean;
+            ariaLabel: string;
+            wrapperAttrs: Readonly<import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').AttrsValue>;
+            inline: boolean;
+            plain: boolean;
+            ariaLabelledby: string;
+            buttonVariant: import('bootstrap-vue-next').ButtonVariant | null;
+            uncheckedValue: import('bootstrap-vue-next').CheckboxValue;
+            inputClass: import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').ClassValue;
+        }, 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').BFormCheckboxProps["modelValue"];
+            indeterminate?: Exclude<import('bootstrap-vue-next').BFormCheckboxProps["indeterminate"], undefined>;
+        } & {
+            reverse?: boolean;
+            required?: boolean;
+            name?: string;
+            value?: string | boolean | import('bootstrap-vue-next').CheckboxValue;
+            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;
+            switch?: boolean;
+            uncheckedValue?: import('bootstrap-vue-next').CheckboxValue;
+            wrapperAttrs?: Readonly<import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').AttrsValue>;
+            inputClass?: import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').ClassValue;
+        }> & Readonly<{
+            "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').CheckboxValue | readonly import('bootstrap-vue-next').CheckboxValue[] | undefined) => any) | undefined;
+            "onUpdate:indeterminate"?: ((value: boolean) => any) | undefined;
+        }>, {
+            blur: () => void;
+            element: Readonly<import('vue').ShallowRef<HTMLInputElement | null>>;
+            focus: () => void;
+        }, {}, {}, {}, {
+            value: string | boolean | import('bootstrap-vue-next').CheckboxValue;
+            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;
+            switch: boolean;
+            ariaLabel: string;
+            wrapperAttrs: Readonly<import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').AttrsValue>;
+            inline: boolean;
+            plain: boolean;
+            ariaLabelledby: string;
+            buttonVariant: import('bootstrap-vue-next').ButtonVariant | null;
+            uncheckedValue: import('bootstrap-vue-next').CheckboxValue;
+            inputClass: import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').ClassValue;
+        }>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<{
+        modelValue?: import('bootstrap-vue-next').BFormCheckboxProps["modelValue"];
+        indeterminate?: Exclude<import('bootstrap-vue-next').BFormCheckboxProps["indeterminate"], undefined>;
+    } & {
+        reverse?: boolean;
+        required?: boolean;
+        name?: string;
+        value?: string | boolean | import('bootstrap-vue-next').CheckboxValue;
+        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;
+        switch?: boolean;
+        uncheckedValue?: import('bootstrap-vue-next').CheckboxValue;
+        wrapperAttrs?: Readonly<import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').AttrsValue>;
+        inputClass?: import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').ClassValue;
+    }> & Readonly<{
+        "onUpdate:modelValue"?: ((value: import('bootstrap-vue-next').CheckboxValue | readonly import('bootstrap-vue-next').CheckboxValue[] | undefined) => any) | undefined;
+        "onUpdate:indeterminate"?: ((value: boolean) => 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').CheckboxValue | readonly import('bootstrap-vue-next').CheckboxValue[] | undefined) => any;
+        "update:indeterminate": (value: boolean) => any;
+    }, string, {
+        value: string | boolean | import('bootstrap-vue-next').CheckboxValue;
+        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;
+        switch: boolean;
+        ariaLabel: string;
+        wrapperAttrs: Readonly<import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').AttrsValue>;
+        inline: boolean;
+        plain: boolean;
+        ariaLabelledby: string;
+        buttonVariant: import('bootstrap-vue-next').ButtonVariant | null;
+        uncheckedValue: import('bootstrap-vue-next').CheckboxValue;
+        inputClass: import('node_modules/bootstrap-vue-next/dist/types/AnyValuedAttributes').ClassValue;
+    }, {}, 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').BFormCheckboxSlots> & import('bootstrap-vue-next').BFormCheckboxSlots;
+    });
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;