@propelinc/citrus-ui 0.6.0 → 1.0.0

package/dist/components/CTextArea.vue.d.ts

@@ -0,0 +1,240 @@
+import { PropType, DefineComponent, ExtractPropTypes, Ref, ComponentOptionsMixin, PublicProps, ComputedRef, ComponentProvideOptions } from 'vue';
+import { Rules } from '../composables/validations';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** The textarea's label, both visual and screenreader-only */
+    label: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** The textarea's placeholder */
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** The textarea element's id */
+    id: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** Controls whether the input is disabled */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The textarea's value */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Hides the label and instead labels the field with `aria-label` */
+    hideLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Hides the validation message area. Defaults to `false` (show message area even when valid), so validations transition in gracefully. */
+    hideDetails: {
+        type: PropType<boolean | "auto">;
+        default: boolean;
+    };
+    /** Adds a custom data test string to the form field and textarea elements */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Shows a character counter and sets its denominator. */
+    counter: {
+        type: PropType<number | null>;
+        default: null;
+    };
+    /** Function or number that determines the numerator of the counter. If not
+     * set, the counter will be the length of the input value. */
+    counterValue: {
+        type: PropType<number | (() => number | null)>;
+        default: null;
+    };
+    maxlength: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    /** Accepts a mixed array of types function, boolean and string.
+     * Functions pass an input value as an argument and must return either true / false or
+     * a string containing an error message. The input field will enter an error state if a
+     *  function returns (or any value in the array contains) false or is a string */
+    rules: {
+        type: PropType<Rules<string>>;
+        default: () => never[];
+    };
+    /** If true, the field is required */
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    textarea: Ref<HTMLTextAreaElement | null, HTMLTextAreaElement | null>;
+    idWithFallback: Ref<string, string>;
+    internalValue: Ref<string, string>;
+    validationMessage: Ref<string | null, string | null>;
+    isValidationValid: Ref<boolean | null, boolean | null>;
+    validationListeners: Record<string, (event: Event) => void>;
+    messageSlotHasContent: Ref<boolean, boolean>;
+    onInput: (event: Event) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("change" | "input" | "focus" | "blur")[], "change" | "input" | "focus" | "blur", PublicProps, Readonly< ExtractPropTypes<{
+    /** The textarea's label, both visual and screenreader-only */
+    label: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** The textarea's placeholder */
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** The textarea element's id */
+    id: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** Controls whether the input is disabled */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The textarea's value */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Hides the label and instead labels the field with `aria-label` */
+    hideLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Hides the validation message area. Defaults to `false` (show message area even when valid), so validations transition in gracefully. */
+    hideDetails: {
+        type: PropType<boolean | "auto">;
+        default: boolean;
+    };
+    /** Adds a custom data test string to the form field and textarea elements */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Shows a character counter and sets its denominator. */
+    counter: {
+        type: PropType<number | null>;
+        default: null;
+    };
+    /** Function or number that determines the numerator of the counter. If not
+     * set, the counter will be the length of the input value. */
+    counterValue: {
+        type: PropType<number | (() => number | null)>;
+        default: null;
+    };
+    maxlength: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    /** Accepts a mixed array of types function, boolean and string.
+     * Functions pass an input value as an argument and must return either true / false or
+     * a string containing an error message. The input field will enter an error state if a
+     *  function returns (or any value in the array contains) false or is a string */
+    rules: {
+        type: PropType<Rules<string>>;
+        default: () => never[];
+    };
+    /** If true, the field is required */
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+    onFocus?: ((...args: any[]) => any) | undefined;
+    onBlur?: ((...args: any[]) => any) | undefined;
+    onInput?: ((...args: any[]) => any) | undefined;
+}>, {
+    label: string | null;
+    id: string | null;
+    value: string;
+    dataTest: string;
+    placeholder: string;
+    disabled: boolean;
+    rules: Rules<string>;
+    required: boolean;
+    hideDetails: boolean | "auto";
+    counter: number | null;
+    counterValue: number | (() => number | null);
+    maxlength: number;
+    hideLabel: boolean;
+}, {}, {
+    CValidationMessage: DefineComponent<ExtractPropTypes<{
+        dataTest: {
+            type: StringConstructor;
+            default: string;
+        };
+        validationMessage: {
+            type: PropType<string | null>;
+            default: null;
+        };
+        hide: {
+            type: PropType<boolean | "auto">;
+            default: boolean;
+        };
+    }>, {
+        isHidden: ComputedRef<boolean>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        dataTest: {
+            type: StringConstructor;
+            default: string;
+        };
+        validationMessage: {
+            type: PropType<string | null>;
+            default: null;
+        };
+        hide: {
+            type: PropType<boolean | "auto">;
+            default: boolean;
+        };
+    }>> & Readonly<{}>, {
+        dataTest: string;
+        validationMessage: string | null;
+        hide: boolean | "auto";
+    }, {}, {
+        CFadeTransition: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    }, {}, string, ComponentProvideOptions, true, {}, any>;
+    CFormFieldCounter: DefineComponent<ExtractPropTypes<{
+        counter: {
+            type: PropType<number | null>;
+            default: null;
+        };
+        counterValue: {
+            type: PropType<number | (() => number | null)>;
+            default: null;
+        };
+        value: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>, {
+        numerator: ComputedRef<number | null>;
+        displayText: ComputedRef<string>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        counter: {
+            type: PropType<number | null>;
+            default: null;
+        };
+        counterValue: {
+            type: PropType<number | (() => number | null)>;
+            default: null;
+        };
+        value: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{}>, {
+        value: string;
+        counter: number | null;
+        counterValue: number | (() => number | null);
+    }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;