@visitscotland/component-library 4.0.3 → 4.1.0

package/dist/components/components/textarea/Textarea.vue.d.ts

@@ -0,0 +1,287 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Name of the field (if different from ID)
+     */
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the browser can autocomplete the field or not.
+     */
+    autoComplete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Option to disable the input
+    */
+    disabled: {
+        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(): {};
+    };
+    /**
+     * Content for hint text
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Element placeholder text
+     */
+    placeholder: {
+        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;
+    };
+    /** The number of visible lines of text */
+    rows: {
+        type: StringConstructor | NumberConstructor;
+        default: number;
+    };
+}, {
+    v$: import('vue').Ref<import('@vuelidate/core').Validation<import('@vuelidate/core').ValidationArgs<unknown>, unknown>>;
+}, {
+    inputVal: string;
+    clearErrorsOnFocus: boolean;
+}, {
+    /**
+     * element type class plus error classes
+     */
+    elementClass(): string;
+}, {
+    /**
+     * Clear any text entered in the input
+     */
+    clearInput(): void;
+    /**
+     * Focus on the input
+     */
+    focusOnInput(): void;
+    /**
+     * Clears the input on button click
+     * and adds focus back to the input
+     */
+    clearInputAndFocus(): void;
+    /**
+     *  return autocomplete value in appropriate places
+     */
+    autocompleteValue(): "off" | "on";
+    /**
+     * 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;
+}, {
+    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<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Name of the field (if different from ID)
+     */
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the browser can autocomplete the field or not.
+     */
+    autoComplete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * Option to disable the input
+    */
+    disabled: {
+        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(): {};
+    };
+    /**
+     * Content for hint text
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Element placeholder text
+     */
+    placeholder: {
+        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;
+    };
+    /** The number of visible lines of text */
+    rows: {
+        type: StringConstructor | NumberConstructor;
+        default: number;
+    };
+}>>, {
+    name: string;
+    value: string;
+    disabled: boolean;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    hintText: string;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+    placeholder: string;
+    autoComplete: boolean;
+    rows: string | number;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,3 @@
+import { default as VsTextarea } from './Textarea.vue';
+
+export default VsTextarea;