x-next 0.0.0-alpha.9 → 1.0.0

package/dist/components/form-input-tag/InputTag.d.ts

@@ -0,0 +1,365 @@
+import { PropType } from 'vue';
+import { Size } from '../../_utils/constant';
+import { InputTagFieldNames, TagData } from './interface';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     * @vModel
+     */
+    modelValue: {
+        type: PropType<(string | number | TagData)[]>;
+    };
+    /**
+     * @zh 默认值（非受控状态）
+     * @en Default value (uncontrolled state)
+     */
+    defaultValue: {
+        type: PropType<(string | number | TagData)[]>;
+        default: () => never[];
+    };
+    /**
+     * @zh 输入框的值
+     * @en The value of the input
+     * @vModel
+     */
+    inputValue: StringConstructor;
+    /**
+     * @zh 输入框的默认值（非受控状态）
+     * @en The default value of the input (uncontrolled state)
+     */
+    defaultInputValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @zh 占位符
+     * @en Placeholder
+     */
+    placeholder: StringConstructor;
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为错误状态
+     * @en Whether it is an error state
+     */
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为只读模式
+     * @en Whether it is read-only mode
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否允许清空
+     * @en Whether to allow clear
+     */
+    allowClear: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 输入框的大小
+     * @en The size of the input
+     * @values 'mini','small','medium','large'
+     * @defaultValue 'medium'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+    /**
+     * @zh 最多展示的标签个数，`0` 表示不限制
+     * @en The maximum number of tags displayed, `0` means unlimited
+     */
+    maxTagCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * @zh 是否保留输入框的内容
+     * @en Whether to keep the content of the input box
+     */
+    retainInputValue: {
+        type: PropType<boolean | {
+            create?: boolean;
+            blur?: boolean;
+        }>;
+        default: boolean;
+    };
+    /**
+     * @zh 格式化标签内容
+     * @en Format tag content
+     */
+    formatTag: {
+        type: PropType<(data: TagData) => string>;
+    };
+    /**
+     * @zh 是否仅创建唯一的值
+     * @en Whether to create only unique values
+     * @version 2.15.0
+     */
+    uniqueValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 自定义 `TagData` 中的字段
+     * @en Customize fields in `TagData`
+     * @version 2.22.0
+     */
+    fieldNames: {
+        type: PropType<InputTagFieldNames>;
+    };
+    /**
+     * @zh 标签内容不换行
+     * @en Tag content does not wrap
+     * @version 2.56.1
+     */
+    tagNowrap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    baseCls: StringConstructor;
+    focused: BooleanConstructor;
+    disabledInput: BooleanConstructor;
+    uninjectFormItemContext: BooleanConstructor;
+}>, {
+    inputRef: import('vue').Ref<HTMLInputElement | undefined, HTMLInputElement | undefined>;
+    render: () => VNode;
+}, {}, {}, {
+    /**
+     * @zh 使输入框获取焦点
+     * @en Make the input box focus
+     * @public
+     */
+    focus(): void;
+    /**
+     * @zh 使输入框失去焦点
+     * @en Make the input box lose focus
+     * @public
+     */
+    blur(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    'update:modelValue': (value: (string | number | TagData)[]) => true;
+    'update:inputValue': (inputValue: string) => true;
+    /**
+     * @zh 值发生改变时触发
+     * @en Triggered when the value changes
+     * @param {(string | number | TagData)[]} value
+     * @param {Event} ev
+     */
+    change: (value: (string | number | TagData)[], ev: Event) => true;
+    /**
+     * @zh 输入值发生改变时触发
+     * @en Trigger when the input value changes
+     * @param {string} inputValue
+     * @param {Event} ev
+     */
+    inputValueChange: (inputValue: string, ev: Event) => true;
+    /**
+     * @zh 按下回车键时触发
+     * @en Triggered when the enter key is pressed
+     * @param {string} inputValue
+     * @param {KeyboardEvent} ev
+     */
+    pressEnter: (inputValue: string, ev: KeyboardEvent) => true;
+    /**
+     * @zh 点击标签的删除按钮时触发
+     * @en Triggered when the delete button of the label is clicked
+     * @param {string | number} removed
+     * @param {Event} ev
+     */
+    remove: (removed: string | number, ev: Event) => true;
+    /**
+     * @zh 点击清除按钮时触发
+     * @en Triggered when the clear button is clicked
+     * @param {MouseEvent} ev
+     */
+    clear: (ev: MouseEvent) => true;
+    /**
+     * @zh 输入框获取焦点时触发
+     * @en Triggered when the input box gets focus
+     * @param {FocusEvent} ev
+     */
+    focus: (ev: FocusEvent) => true;
+    /**
+     * @zh 输入框失去焦点时触发
+     * @en Triggered when the input box loses focus
+     * @param {FocusEvent} ev
+     */
+    blur: (ev: FocusEvent) => true;
+    keydown: (ev: KeyboardEvent) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     * @vModel
+     */
+    modelValue: {
+        type: PropType<(string | number | TagData)[]>;
+    };
+    /**
+     * @zh 默认值（非受控状态）
+     * @en Default value (uncontrolled state)
+     */
+    defaultValue: {
+        type: PropType<(string | number | TagData)[]>;
+        default: () => never[];
+    };
+    /**
+     * @zh 输入框的值
+     * @en The value of the input
+     * @vModel
+     */
+    inputValue: StringConstructor;
+    /**
+     * @zh 输入框的默认值（非受控状态）
+     * @en The default value of the input (uncontrolled state)
+     */
+    defaultInputValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @zh 占位符
+     * @en Placeholder
+     */
+    placeholder: StringConstructor;
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为错误状态
+     * @en Whether it is an error state
+     */
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为只读模式
+     * @en Whether it is read-only mode
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否允许清空
+     * @en Whether to allow clear
+     */
+    allowClear: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 输入框的大小
+     * @en The size of the input
+     * @values 'mini','small','medium','large'
+     * @defaultValue 'medium'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+    /**
+     * @zh 最多展示的标签个数，`0` 表示不限制
+     * @en The maximum number of tags displayed, `0` means unlimited
+     */
+    maxTagCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * @zh 是否保留输入框的内容
+     * @en Whether to keep the content of the input box
+     */
+    retainInputValue: {
+        type: PropType<boolean | {
+            create?: boolean;
+            blur?: boolean;
+        }>;
+        default: boolean;
+    };
+    /**
+     * @zh 格式化标签内容
+     * @en Format tag content
+     */
+    formatTag: {
+        type: PropType<(data: TagData) => string>;
+    };
+    /**
+     * @zh 是否仅创建唯一的值
+     * @en Whether to create only unique values
+     * @version 2.15.0
+     */
+    uniqueValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 自定义 `TagData` 中的字段
+     * @en Customize fields in `TagData`
+     * @version 2.22.0
+     */
+    fieldNames: {
+        type: PropType<InputTagFieldNames>;
+    };
+    /**
+     * @zh 标签内容不换行
+     * @en Tag content does not wrap
+     * @version 2.56.1
+     */
+    tagNowrap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    baseCls: StringConstructor;
+    focused: BooleanConstructor;
+    disabledInput: BooleanConstructor;
+    uninjectFormItemContext: BooleanConstructor;
+}>> & Readonly<{
+    onFocus?: ((ev: FocusEvent) => any) | undefined;
+    onClear?: ((ev: MouseEvent) => any) | undefined;
+    onRemove?: ((removed: string | number, ev: Event) => any) | undefined;
+    onBlur?: ((ev: FocusEvent) => any) | undefined;
+    onChange?: ((value: (string | number | TagData)[], ev: Event) => any) | undefined;
+    onKeydown?: ((ev: KeyboardEvent) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: (string | number | TagData)[]) => any) | undefined;
+    onPressEnter?: ((inputValue: string, ev: KeyboardEvent) => any) | undefined;
+    "onUpdate:inputValue"?: ((inputValue: string) => any) | undefined;
+    onInputValueChange?: ((inputValue: string, ev: Event) => any) | undefined;
+}>, {
+    error: boolean;
+    readonly: boolean;
+    disabled: boolean;
+    defaultValue: (string | number | TagData)[];
+    focused: boolean;
+    allowClear: boolean;
+    disabledInput: boolean;
+    uninjectFormItemContext: boolean;
+    defaultInputValue: string;
+    maxTagCount: number;
+    retainInputValue: boolean | {
+        create?: boolean;
+        blur?: boolean;
+    };
+    uniqueValue: boolean;
+    tagNowrap: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/form-input-tag/index.d.ts

@@ -0,0 +1,326 @@
+export declare const InputTag: {
+    new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+        modelValue: {
+            type: import('vue').PropType<(string | number | import('./interface.ts').TagData)[]>;
+        };
+        defaultValue: {
+            type: import('vue').PropType<(string | number | import('./interface.ts').TagData)[]>;
+            default: () => never[];
+        };
+        inputValue: StringConstructor;
+        defaultInputValue: {
+            type: StringConstructor;
+            default: string;
+        };
+        placeholder: StringConstructor;
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        error: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        readonly: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        allowClear: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        size: {
+            type: import('vue').PropType<import('../../_utils/constant.ts').Size>;
+        };
+        maxTagCount: {
+            type: NumberConstructor;
+            default: number;
+        };
+        retainInputValue: {
+            type: import('vue').PropType<boolean | {
+                create?: boolean;
+                blur?: boolean;
+            }>;
+            default: boolean;
+        };
+        formatTag: {
+            type: import('vue').PropType<(data: import('./interface.ts').TagData) => string>;
+        };
+        uniqueValue: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        fieldNames: {
+            type: import('vue').PropType<import('./interface.ts').InputTagFieldNames>;
+        };
+        tagNowrap: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        baseCls: StringConstructor;
+        focused: BooleanConstructor;
+        disabledInput: BooleanConstructor;
+        uninjectFormItemContext: BooleanConstructor;
+    }>> & Readonly<{
+        onFocus?: ((ev: FocusEvent) => any) | undefined;
+        onClear?: ((ev: MouseEvent) => any) | undefined;
+        onRemove?: ((removed: string | number, ev: Event) => any) | undefined;
+        onBlur?: ((ev: FocusEvent) => any) | undefined;
+        onChange?: ((value: (string | number | import('./interface.ts').TagData)[], ev: Event) => any) | undefined;
+        onKeydown?: ((ev: KeyboardEvent) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: (string | number | import('./interface.ts').TagData)[]) => any) | undefined;
+        onPressEnter?: ((inputValue: string, ev: KeyboardEvent) => any) | undefined;
+        "onUpdate:inputValue"?: ((inputValue: string) => any) | undefined;
+        onInputValueChange?: ((inputValue: string, ev: Event) => any) | undefined;
+    }>, {
+        inputRef: import('vue').Ref<HTMLInputElement | undefined, HTMLInputElement | undefined>;
+        render: () => VNode;
+    }, {}, {}, {
+        focus(): void;
+        blur(): void;
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        'update:modelValue': (value: (string | number | import('./interface.ts').TagData)[]) => true;
+        'update:inputValue': (inputValue: string) => true;
+        change: (value: (string | number | import('./interface.ts').TagData)[], ev: Event) => true;
+        inputValueChange: (inputValue: string, ev: Event) => true;
+        pressEnter: (inputValue: string, ev: KeyboardEvent) => true;
+        remove: (removed: string | number, ev: Event) => true;
+        clear: (ev: MouseEvent) => true;
+        focus: (ev: FocusEvent) => true;
+        blur: (ev: FocusEvent) => true;
+        keydown: (ev: KeyboardEvent) => true;
+    }, import('vue').PublicProps, {
+        error: boolean;
+        readonly: boolean;
+        disabled: boolean;
+        defaultValue: (string | number | import('./interface.ts').TagData)[];
+        focused: boolean;
+        allowClear: boolean;
+        disabledInput: boolean;
+        uninjectFormItemContext: boolean;
+        defaultInputValue: string;
+        maxTagCount: number;
+        retainInputValue: boolean | {
+            create?: boolean;
+            blur?: boolean;
+        };
+        uniqueValue: boolean;
+        tagNowrap: boolean;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('vue').ExtractPropTypes<{
+        modelValue: {
+            type: import('vue').PropType<(string | number | import('./interface.ts').TagData)[]>;
+        };
+        defaultValue: {
+            type: import('vue').PropType<(string | number | import('./interface.ts').TagData)[]>;
+            default: () => never[];
+        };
+        inputValue: StringConstructor;
+        defaultInputValue: {
+            type: StringConstructor;
+            default: string;
+        };
+        placeholder: StringConstructor;
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        error: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        readonly: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        allowClear: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        size: {
+            type: import('vue').PropType<import('../../_utils/constant.ts').Size>;
+        };
+        maxTagCount: {
+            type: NumberConstructor;
+            default: number;
+        };
+        retainInputValue: {
+            type: import('vue').PropType<boolean | {
+                create?: boolean;
+                blur?: boolean;
+            }>;
+            default: boolean;
+        };
+        formatTag: {
+            type: import('vue').PropType<(data: import('./interface.ts').TagData) => string>;
+        };
+        uniqueValue: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        fieldNames: {
+            type: import('vue').PropType<import('./interface.ts').InputTagFieldNames>;
+        };
+        tagNowrap: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        baseCls: StringConstructor;
+        focused: BooleanConstructor;
+        disabledInput: BooleanConstructor;
+        uninjectFormItemContext: BooleanConstructor;
+    }>> & Readonly<{
+        onFocus?: ((ev: FocusEvent) => any) | undefined;
+        onClear?: ((ev: MouseEvent) => any) | undefined;
+        onRemove?: ((removed: string | number, ev: Event) => any) | undefined;
+        onBlur?: ((ev: FocusEvent) => any) | undefined;
+        onChange?: ((value: (string | number | import('./interface.ts').TagData)[], ev: Event) => any) | undefined;
+        onKeydown?: ((ev: KeyboardEvent) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: (string | number | import('./interface.ts').TagData)[]) => any) | undefined;
+        onPressEnter?: ((inputValue: string, ev: KeyboardEvent) => any) | undefined;
+        "onUpdate:inputValue"?: ((inputValue: string) => any) | undefined;
+        onInputValueChange?: ((inputValue: string, ev: Event) => any) | undefined;
+    }>, {
+        inputRef: import('vue').Ref<HTMLInputElement | undefined, HTMLInputElement | undefined>;
+        render: () => VNode;
+    }, {}, {}, {
+        focus(): void;
+        blur(): void;
+    }, {
+        error: boolean;
+        readonly: boolean;
+        disabled: boolean;
+        defaultValue: (string | number | import('./interface.ts').TagData)[];
+        focused: boolean;
+        allowClear: boolean;
+        disabledInput: boolean;
+        uninjectFormItemContext: boolean;
+        defaultInputValue: string;
+        maxTagCount: number;
+        retainInputValue: boolean | {
+            create?: boolean;
+            blur?: boolean;
+        };
+        uniqueValue: boolean;
+        tagNowrap: boolean;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+    modelValue: {
+        type: import('vue').PropType<(string | number | import('./interface.ts').TagData)[]>;
+    };
+    defaultValue: {
+        type: import('vue').PropType<(string | number | import('./interface.ts').TagData)[]>;
+        default: () => never[];
+    };
+    inputValue: StringConstructor;
+    defaultInputValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    placeholder: StringConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    allowClear: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    size: {
+        type: import('vue').PropType<import('../../_utils/constant.ts').Size>;
+    };
+    maxTagCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    retainInputValue: {
+        type: import('vue').PropType<boolean | {
+            create?: boolean;
+            blur?: boolean;
+        }>;
+        default: boolean;
+    };
+    formatTag: {
+        type: import('vue').PropType<(data: import('./interface.ts').TagData) => string>;
+    };
+    uniqueValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fieldNames: {
+        type: import('vue').PropType<import('./interface.ts').InputTagFieldNames>;
+    };
+    tagNowrap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    baseCls: StringConstructor;
+    focused: BooleanConstructor;
+    disabledInput: BooleanConstructor;
+    uninjectFormItemContext: BooleanConstructor;
+}>> & Readonly<{
+    onFocus?: ((ev: FocusEvent) => any) | undefined;
+    onClear?: ((ev: MouseEvent) => any) | undefined;
+    onRemove?: ((removed: string | number, ev: Event) => any) | undefined;
+    onBlur?: ((ev: FocusEvent) => any) | undefined;
+    onChange?: ((value: (string | number | import('./interface.ts').TagData)[], ev: Event) => any) | undefined;
+    onKeydown?: ((ev: KeyboardEvent) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: (string | number | import('./interface.ts').TagData)[]) => any) | undefined;
+    onPressEnter?: ((inputValue: string, ev: KeyboardEvent) => any) | undefined;
+    "onUpdate:inputValue"?: ((inputValue: string) => any) | undefined;
+    onInputValueChange?: ((inputValue: string, ev: Event) => any) | undefined;
+}>, {
+    inputRef: import('vue').Ref<HTMLInputElement | undefined, HTMLInputElement | undefined>;
+    render: () => VNode;
+}, {}, {}, {
+    focus(): void;
+    blur(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    'update:modelValue': (value: (string | number | import('./interface.ts').TagData)[]) => true;
+    'update:inputValue': (inputValue: string) => true;
+    change: (value: (string | number | import('./interface.ts').TagData)[], ev: Event) => true;
+    inputValueChange: (inputValue: string, ev: Event) => true;
+    pressEnter: (inputValue: string, ev: KeyboardEvent) => true;
+    remove: (removed: string | number, ev: Event) => true;
+    clear: (ev: MouseEvent) => true;
+    focus: (ev: FocusEvent) => true;
+    blur: (ev: FocusEvent) => true;
+    keydown: (ev: KeyboardEvent) => true;
+}, string, {
+    error: boolean;
+    readonly: boolean;
+    disabled: boolean;
+    defaultValue: (string | number | import('./interface.ts').TagData)[];
+    focused: boolean;
+    allowClear: boolean;
+    disabledInput: boolean;
+    uninjectFormItemContext: boolean;
+    defaultInputValue: string;
+    maxTagCount: number;
+    retainInputValue: boolean | {
+        create?: boolean;
+        blur?: boolean;
+    };
+    uniqueValue: boolean;
+    tagNowrap: boolean;
+}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & {
+    install(app: import('vue').App): void;
+};
+export { InputTag as default };