@citruslime/ui 2.0.2-beta.9 → 2.1.0-beta.0

package/dist/components/grid/header/cl-ui-grid-filter.d.ts

@@ -0,0 +1,722 @@
+import type { isInputButton, isInputCalendarSupportedDate, isInputText, getInputTypeAsCalendarType, convertFromEvent } from '../../input/utils';
+import type { InputValueType } from '../..';
+import type { LocaleMessage, RemoveIndexSignature, NumberFormatOptions } from '@intlify/core-base';
+import type { ComposerTranslation, VueMessageType, LocaleMessageValue, ComposerNumberFormatting, IntlNumberFormat } from 'vue-i18n';
+import type { DefineComponent, WritableComputedRef, ComputedRef, ComputedOptions, MethodOptions, ComponentOptionsMixin, VNodeProps, AllowedComponentProps, ComponentCustomProps, Ref, ExtractPropTypes } from 'vue';
+import { NumberFormat } from '../../../utils/i18n/types';
+import type { FilterMethod, FilterArg } from '../types';
+import { FilterOperation } from '../types';
+declare const _sfc_main: DefineComponent<{
+    filter: {
+        type: null;
+        required: true;
+    };
+    column: {
+        type: null;
+        required: true;
+    };
+    firstHalf: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}, {
+    props: any;
+    emit: (e: 'update:filter', value: FilterArg | undefined) => void;
+    locale: WritableComputedRef<string>;
+    t: ComposerTranslation<{
+        [x: string]: LocaleMessage<VueMessageType>;
+    }, string, RemoveIndexSignature<{
+        [x: string]: LocaleMessageValue<VueMessageType>;
+    }>, never, string, string>;
+    getDefaultFilterOperation: () => FilterOperation;
+    currentFilter: WritableComputedRef<FilterArg | undefined>;
+    currentFilterValue: ComputedRef<string>;
+    currentDateFilterValue: ComputedRef<Date | null>;
+    decimalSeparator: ComputedRef<string>;
+    isFilterable: ComputedRef<boolean>;
+    setFilter: (target: EventTarget | null, defaultValue?: string) => void;
+    setNumberFilter: (inputValue: string | number) => void;
+    setDateFilter: (value: Date | null) => void;
+    clUiInput: DefineComponent<{
+        inputType: {
+            type: null;
+            required: true;
+            default: string;
+        };
+        modelValue: {
+            type: null;
+            required: false;
+            default: undefined;
+        };
+        label: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        isRequired: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        customValidationFunction: {
+            type: FunctionConstructor;
+            required: false;
+            default: undefined;
+        };
+        onInputFunction: {
+            type: FunctionConstructor;
+            required: false;
+            default: undefined;
+        };
+        min: {
+            type: (StringConstructor | NumberConstructor)[];
+            required: false;
+            default: number;
+        };
+        max: {
+            type: (StringConstructor | NumberConstructor)[];
+            required: false;
+            default: number;
+        };
+        step: {
+            type: NumberConstructor;
+            required: false;
+            default: number;
+        };
+        validateImmediately: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        validateOn: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        externalErrors: {
+            type: ArrayConstructor;
+            required: false;
+            default: () => never[];
+        };
+        disabled: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        requiredText: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        placeholderText: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        fileExtensions: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        group: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        showLabel: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        showArrows: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        autocomplete: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        highlightWhenValid: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        messageWhenValid: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        inputSpecificClasses: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+    }, {
+        props: any;
+        emit: {
+            (e: "update:model-value", value: InputValueType): void;
+            (e: "click", event: MouseEvent): void;
+            (e: "focus"): void;
+            (e: "input", event: {
+                target: EventTarget | DefineComponent<unknown, object, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<unknown>, {}> | DefineComponent<{
+                    value: {
+                        type: NumberConstructor;
+                        required: true;
+                    };
+                    min: {
+                        type: NumberConstructor;
+                        required: true;
+                    };
+                    max: {
+                        type: NumberConstructor;
+                        required: true;
+                    };
+                    step: {
+                        type: NumberConstructor;
+                        required: false;
+                        default: number;
+                    };
+                    enforceStep: {
+                        type: BooleanConstructor;
+                        required: false;
+                        default: boolean;
+                    };
+                    disabled: {
+                        type: BooleanConstructor;
+                        required: false;
+                        default: boolean;
+                    };
+                    showNumericInput: {
+                        type: BooleanConstructor;
+                        required: false;
+                        default: boolean;
+                    };
+                }, {
+                    props: any;
+                    emit: (event: "update:value", ...args: any[]) => void;
+                    n: ComposerNumberFormatting<{
+                        [x: string]: IntlNumberFormat;
+                    }, string, RemoveIndexSignature<{
+                        [x: string]: NumberFormatOptions;
+                    }>, never, string | number, string | number>;
+                    t: ComposerTranslation<{
+                        [x: string]: LocaleMessage<VueMessageType>;
+                    }, string, RemoveIndexSignature<{
+                        [x: string]: LocaleMessageValue<VueMessageType>;
+                    }>, never, string, string>;
+                    debounce: (event: Function, ...eventArgs: unknown[]) => void;
+                    numericInputValue: Ref<number>;
+                    sliderRef: Ref<HTMLInputElement | undefined>;
+                    currentValue: WritableComputedRef<number>;
+                    colour: ComputedRef<string>;
+                    percentage: ComputedRef<number>;
+                    validProps: ComputedRef<boolean>;
+                    updateCurrentValue: (target: EventTarget | null, forceUpdate: Function) => void;
+                    readonly NumberFormat: typeof NumberFormat;
+                }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+                    'update:value': null;
+                }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+                    value: {
+                        type: NumberConstructor;
+                        required: true;
+                    };
+                    min: {
+                        type: NumberConstructor;
+                        required: true;
+                    };
+                    max: {
+                        type: NumberConstructor;
+                        required: true;
+                    };
+                    step: {
+                        type: NumberConstructor;
+                        required: false;
+                        default: number;
+                    };
+                    enforceStep: {
+                        type: BooleanConstructor;
+                        required: false;
+                        default: boolean;
+                    };
+                    disabled: {
+                        type: BooleanConstructor;
+                        required: false;
+                        default: boolean;
+                    };
+                    showNumericInput: {
+                        type: BooleanConstructor;
+                        required: false;
+                        default: boolean;
+                    };
+                }>> & {
+                    "onUpdate:value"?: ((...args: any[]) => any) | undefined;
+                }, {
+                    disabled: boolean;
+                    step: number;
+                    enforceStep: boolean;
+                    showNumericInput: boolean;
+                }> | null;
+            }, value: InputValueType): void;
+            (e: "change", event: Event, value: InputValueType): void;
+            (e: "validated", isValid: boolean, value: InputValueType): void;
+        };
+        inputElement: Ref<HTMLInputElement | DefineComponent<unknown, object, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<unknown>, {}> | DefineComponent<{
+            value: {
+                type: NumberConstructor;
+                required: true;
+            };
+            min: {
+                type: NumberConstructor;
+                required: true;
+            };
+            max: {
+                type: NumberConstructor;
+                required: true;
+            };
+            step: {
+                type: NumberConstructor;
+                required: false;
+                default: number;
+            };
+            enforceStep: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            showNumericInput: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+        }, {
+            props: any;
+            emit: (event: "update:value", ...args: any[]) => void;
+            n: ComposerNumberFormatting<{
+                [x: string]: IntlNumberFormat;
+            }, string, RemoveIndexSignature<{
+                [x: string]: NumberFormatOptions;
+            }>, never, string | number, string | number>;
+            t: ComposerTranslation<{
+                [x: string]: LocaleMessage<VueMessageType>;
+            }, string, RemoveIndexSignature<{
+                [x: string]: LocaleMessageValue<VueMessageType>;
+            }>, never, string, string>;
+            debounce: (event: Function, ...eventArgs: unknown[]) => void;
+            numericInputValue: Ref<number>;
+            sliderRef: Ref<HTMLInputElement | undefined>;
+            currentValue: WritableComputedRef<number>;
+            colour: ComputedRef<string>;
+            percentage: ComputedRef<number>;
+            validProps: ComputedRef<boolean>;
+            updateCurrentValue: (target: EventTarget | null, forceUpdate: Function) => void;
+            readonly NumberFormat: typeof NumberFormat;
+        }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+            'update:value': null;
+        }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+            value: {
+                type: NumberConstructor;
+                required: true;
+            };
+            min: {
+                type: NumberConstructor;
+                required: true;
+            };
+            max: {
+                type: NumberConstructor;
+                required: true;
+            };
+            step: {
+                type: NumberConstructor;
+                required: false;
+                default: number;
+            };
+            enforceStep: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            showNumericInput: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+        }>> & {
+            "onUpdate:value"?: ((...args: any[]) => any) | undefined;
+        }, {
+            disabled: boolean;
+            step: number;
+            enforceStep: boolean;
+            showNumericInput: boolean;
+        }> | null>;
+        focused: Ref<boolean>;
+        lostFocus: Ref<boolean>;
+        showRequiredAsterisk: ComputedRef<boolean>;
+        placeholder: ComputedRef<string>;
+        dateFlaggedAsOutOfRange: Ref<boolean>;
+        t: ComposerTranslation<{
+            [x: string]: LocaleMessage<VueMessageType>;
+        }, string, RemoveIndexSignature<{
+            [x: string]: LocaleMessageValue<VueMessageType>;
+        }>, never, string, string>;
+        currentKey: Ref<number>;
+        currentValue: WritableComputedRef<InputValueType>;
+        currentDateValue: WritableComputedRef<Date>;
+        minAsString: ComputedRef<string | undefined>;
+        maxAsString: ComputedRef<string | undefined>;
+        minAsNumber: ComputedRef<number>;
+        maxAsNumber: ComputedRef<number>;
+        validMessage: ComputedRef<string>;
+        isValid: Ref<boolean>;
+        internalErrors: Ref<string[]>;
+        errors: ComputedRef<string>;
+        updateDateValue: (value: Date | null) => Promise<void>;
+        onValueChanged: (value: InputValueType, forceValidation: boolean) => Promise<void>;
+        validateValue: (value: InputValueType) => Promise<void>;
+        getStyle: () => string;
+        emitClickIfButton: (event: MouseEvent) => void;
+        incrementNumericValue: () => void;
+        decrementNumericValue: () => void;
+        toggleFocus: (focus: boolean) => void;
+        onLostFocus: () => void;
+        forceUpdate: () => void;
+        onMouseWheel: (wheelEvent: WheelEvent) => void;
+        getShowAsteriskOrRequired: () => boolean;
+        onDateOutOfRange: () => void;
+        onChange: (event: Event) => Promise<void>;
+        readonly clUiCalendar: DefineComponent<unknown, object, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<unknown>, {}>;
+        readonly clUiSlider: DefineComponent<{
+            value: {
+                type: NumberConstructor;
+                required: true;
+            };
+            min: {
+                type: NumberConstructor;
+                required: true;
+            };
+            max: {
+                type: NumberConstructor;
+                required: true;
+            };
+            step: {
+                type: NumberConstructor;
+                required: false;
+                default: number;
+            };
+            enforceStep: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            showNumericInput: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+        }, {
+            props: any;
+            emit: (event: "update:value", ...args: any[]) => void;
+            n: ComposerNumberFormatting<{
+                [x: string]: IntlNumberFormat;
+            }, string, RemoveIndexSignature<{
+                [x: string]: NumberFormatOptions;
+            }>, never, string | number, string | number>;
+            t: ComposerTranslation<{
+                [x: string]: LocaleMessage<VueMessageType>;
+            }, string, RemoveIndexSignature<{
+                [x: string]: LocaleMessageValue<VueMessageType>;
+            }>, never, string, string>;
+            debounce: (event: Function, ...eventArgs: unknown[]) => void;
+            numericInputValue: Ref<number>;
+            sliderRef: Ref<HTMLInputElement | undefined>;
+            currentValue: WritableComputedRef<number>;
+            colour: ComputedRef<string>;
+            percentage: ComputedRef<number>;
+            validProps: ComputedRef<boolean>;
+            updateCurrentValue: (target: EventTarget | null, forceUpdate: Function) => void;
+            readonly NumberFormat: typeof NumberFormat;
+        }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+            'update:value': null;
+        }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+            value: {
+                type: NumberConstructor;
+                required: true;
+            };
+            min: {
+                type: NumberConstructor;
+                required: true;
+            };
+            max: {
+                type: NumberConstructor;
+                required: true;
+            };
+            step: {
+                type: NumberConstructor;
+                required: false;
+                default: number;
+            };
+            enforceStep: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            showNumericInput: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+        }>> & {
+            "onUpdate:value"?: ((...args: any[]) => any) | undefined;
+        }, {
+            disabled: boolean;
+            step: number;
+            enforceStep: boolean;
+            showNumericInput: boolean;
+        }>;
+        readonly isInputButton: typeof isInputButton;
+        readonly isInputCalendarSupportedDate: typeof isInputCalendarSupportedDate;
+        readonly isInputText: typeof isInputText;
+        readonly getInputTypeAsCalendarType: typeof getInputTypeAsCalendarType;
+        readonly convertFromEvent: typeof convertFromEvent;
+    }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("focus" | "input" | "update:model-value" | "click" | "change" | "validated")[], "focus" | "input" | "update:model-value" | "click" | "change" | "validated", VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+        inputType: {
+            type: null;
+            required: true;
+            default: string;
+        };
+        modelValue: {
+            type: null;
+            required: false;
+            default: undefined;
+        };
+        label: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        isRequired: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        customValidationFunction: {
+            type: FunctionConstructor;
+            required: false;
+            default: undefined;
+        };
+        onInputFunction: {
+            type: FunctionConstructor;
+            required: false;
+            default: undefined;
+        };
+        min: {
+            type: (StringConstructor | NumberConstructor)[];
+            required: false;
+            default: number;
+        };
+        max: {
+            type: (StringConstructor | NumberConstructor)[];
+            required: false;
+            default: number;
+        };
+        step: {
+            type: NumberConstructor;
+            required: false;
+            default: number;
+        };
+        validateImmediately: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        validateOn: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        externalErrors: {
+            type: ArrayConstructor;
+            required: false;
+            default: () => never[];
+        };
+        disabled: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        requiredText: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        placeholderText: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        fileExtensions: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        group: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        showLabel: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        showArrows: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        autocomplete: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        highlightWhenValid: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        messageWhenValid: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        inputSpecificClasses: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+    }>> & {
+        onFocus?: ((...args: any[]) => any) | undefined;
+        onInput?: ((...args: any[]) => any) | undefined;
+        "onUpdate:model-value"?: ((...args: any[]) => any) | undefined;
+        onClick?: ((...args: any[]) => any) | undefined;
+        onChange?: ((...args: any[]) => any) | undefined;
+        onValidated?: ((...args: any[]) => any) | undefined;
+    }, {
+        disabled: boolean;
+        inputType: any;
+        modelValue: any;
+        label: string;
+        isRequired: boolean;
+        customValidationFunction: Function;
+        onInputFunction: Function;
+        min: string | number;
+        max: string | number;
+        step: number;
+        validateImmediately: boolean;
+        validateOn: string;
+        externalErrors: unknown[];
+        requiredText: string;
+        placeholderText: string;
+        fileExtensions: string;
+        group: string;
+        showLabel: boolean;
+        showArrows: boolean;
+        autocomplete: string;
+        highlightWhenValid: boolean;
+        messageWhenValid: string;
+        inputSpecificClasses: string;
+    }>;
+    clUiGridMethodSelector: DefineComponent<{
+        filter: {
+            type: null;
+            required: true;
+        };
+        column: {
+            type: null;
+            required: true;
+        };
+        defaultOperation: {
+            type: null;
+            required: true;
+        };
+        firstHalf: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }, {
+        props: any;
+        emit: (e: "update:filter", value: FilterArg) => void;
+        t: ComposerTranslation<{
+            [x: string]: LocaleMessage<VueMessageType>;
+        }, string, RemoveIndexSignature<{
+            [x: string]: LocaleMessageValue<VueMessageType>;
+        }>, never, string, string>;
+        allowedFilterMethods: ComputedRef<FilterMethod[]>;
+        currentFilterMethod: ComputedRef<FilterMethod | undefined>;
+        setFilterMethod: (filterMethod: "equal" | "notequal" | "contains" | "notcontains" | "lessthan" | "greaterthan" | "startswith" | "endswith" | "equalorlessthan" | "equalorgreaterthan") => void;
+    }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "update:filter"[], "update:filter", VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+        filter: {
+            type: null;
+            required: true;
+        };
+        column: {
+            type: null;
+            required: true;
+        };
+        defaultOperation: {
+            type: null;
+            required: true;
+        };
+        firstHalf: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>> & {
+        "onUpdate:filter"?: ((...args: any[]) => any) | undefined;
+    }, {
+        firstHalf: boolean;
+    }>;
+}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "update:filter"[], "update:filter", VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+    filter: {
+        type: null;
+        required: true;
+    };
+    column: {
+        type: null;
+        required: true;
+    };
+    firstHalf: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:filter"?: ((...args: any[]) => any) | undefined;
+}, {
+    firstHalf: boolean;
+}>;
+export default _sfc_main;