x-next 0.0.0-alpha.9 → 1.0.0

package/dist/components/form/interface.d.ts

@@ -0,0 +1,185 @@
+export declare const VALIDATE_STATUSES: readonly ["success", "warning", "error", "validating"];
+export type ValidateStatus = (typeof VALIDATE_STATUSES)[number];
+export declare const VALIDATE_TRIGGERS: readonly ["change", "input", "focus", "blur"];
+export type ValidateTrigger = (typeof VALIDATE_TRIGGERS)[number];
+export interface FieldRule<FieldValue = any> {
+    /**
+     * @zh 校验的值的类型，默认为 `'string'`
+     * @en The type of the value to be checked, the default is `'string'`
+     */
+    type?: 'string' | 'number' | 'boolean' | 'array' | 'object' | 'email' | 'url' | 'ip';
+    /**
+     * @zh 是否必填
+     * @en Is it required
+     */
+    required?: boolean;
+    /**
+     * @zh 校验失败时展示的信息
+     * @en Information displayed when verification fails
+     */
+    message?: string;
+    /**
+     * @zh 校验长度（string, array）
+     * @en Check length (string, array)
+     */
+    length?: number;
+    /**
+     * @zh 最大长度（string）
+     * @en Maximum length (string)
+     */
+    maxLength?: number;
+    /**
+     * @zh 最小长度（string）
+     * @en Minimum length (string)
+     */
+    minLength?: number;
+    /**
+     * @zh 匹配校验（string）
+     * @en Match check (string)
+     */
+    match?: RegExp;
+    /**
+     * @zh 大写（string）
+     * @en Uppercase (string)
+     */
+    uppercase?: boolean;
+    /**
+     * @zh 小写（string）
+     * @en Lowercase (string)
+     */
+    lowercase?: boolean;
+    /**
+     * @zh 最小值（number）
+     * @en Minimum (number)
+     */
+    min?: number;
+    /**
+     * @zh 最大值（number）
+     * @en Maximum (number)
+     */
+    max?: number;
+    /**
+     * @zh 校验数值（number）
+     * @en Check value (number)
+     */
+    equal?: number;
+    /**
+     * @zh 正数（number）
+     * @en Positive number (number)
+     */
+    positive?: boolean;
+    /**
+     * @zh 负数（number）
+     * @en Negative number (number)
+     */
+    negative?: boolean;
+    /**
+     * @zh 是否为 `true`（boolean）
+     * @en Whether it is `true` (boolean)
+     */
+    true?: boolean;
+    /**
+     * @zh 是否为 `false`（boolean）
+     * @en Whether it is `false` (boolean)
+     */
+    false?: boolean;
+    /**
+     * @zh 数组中是否包含给定值（array）
+     * @en Does the array contain the given value (array)
+     */
+    includes?: any[];
+    /**
+     * @zh 数组元素是否相等（array）
+     * @en Are array elements equal (array)
+     */
+    deepEqual?: any;
+    /**
+     * @zh 是否为空（object）
+     * @en Is it empty (object)
+     */
+    empty?: boolean;
+    /**
+     * @zh 对象是否包含给定属性（object）
+     * @en Does the object contain the given attribute (object)
+     */
+    hasKeys?: string[];
+    /**
+     * @zh 自定义校验规则
+     * @en Custom verification rules
+     * @param value
+     * @param callback
+     */
+    validator?: (value: FieldValue | undefined, callback: (error?: string) => void) => void;
+}
+export interface FieldData {
+    /**
+     * @zh 字段的值
+     * @en Field value
+     */
+    value?: any;
+    /**
+     * @zh 字段的状态
+     * @en Field status
+     */
+    status?: ValidateStatus;
+    /**
+     * @zh 字段的错误信息
+     * @en Field error message
+     */
+    message?: string;
+}
+export interface ValidatedError {
+    /**
+     * @zh 标签的文本
+     * @en Label text
+     * @version 2.18.0
+     */
+    label: string;
+    /**
+     * @zh 字段名
+     * @en Field name
+     */
+    field: string;
+    /**
+     * @zh 字段值
+     * @en Field value
+     */
+    value: any;
+    /**
+     * @zh 字段类型
+     * @en Field Type
+     */
+    type: string;
+    /**
+     * @zh 是否为 `required` 错误
+     * @en Is it a `required` error
+     */
+    isRequiredError: boolean;
+    /**
+     * @zh 错误信息
+     * @en Error message
+     */
+    message: string;
+}
+export interface FormItemEventHandler {
+    /**
+     * @zh onChange
+     * @en onChange
+     */
+    onChange?: (ev?: Event) => void;
+    /**
+     * @zh onInput
+     * @en onInput
+     */
+    onInput?: (ev?: Event) => void;
+    /**
+     * @zh onFocus
+     * @en onFocus
+     */
+    onFocus?: (ev?: Event) => void;
+    /**
+     * @zh onBlur
+     * @en onBlur
+     */
+    onBlur?: (ev?: Event) => void;
+}

package/dist/components/form/utils.d.ts

@@ -0,0 +1,9 @@
+import { ValidateStatus } from './interface';
+export declare function getValueByPath(obj: any, path: string, strict: boolean): {
+    o: unknown;
+    k: string;
+    v: unknown;
+};
+export declare const getFinalValidateStatus: (validateStatus: Record<string, ValidateStatus | "">) => "" | "success" | "warning" | "error" | "validating";
+export declare const getFinalValidateMessage: (validateMessage: Record<string, string>) => string[];
+export declare const getFormElementId: (prefix: string | undefined, field: string) => string;

package/dist/components/form/validateMessages.d.ts

@@ -0,0 +1,46 @@
+export declare const validateMessages: {
+    required: string;
+    type: {
+        string: string;
+        number: string;
+        boolean: string;
+        array: string;
+        object: string;
+        url: string;
+        email: string;
+        ip: string;
+    };
+    number: {
+        min: string;
+        max: string;
+        equal: string;
+        range: string;
+        positive: string;
+        negative: string;
+    };
+    array: {
+        length: string;
+        minLength: string;
+        maxLength: string;
+        includes: string;
+        deepEqual: string;
+        empty: string;
+    };
+    string: {
+        minLength: string;
+        maxLength: string;
+        length: string;
+        match: string;
+        uppercase: string;
+        lowercase: string;
+    };
+    object: {
+        deepEqual: string;
+        hasKeys: string;
+        empty: string;
+    };
+    boolean: {
+        true: string;
+        false: string;
+    };
+};

package/dist/components/form-checkbox/Checkbox.d.ts

@@ -0,0 +1,174 @@
+import { PropType } from 'vue';
+import { CheckboxValueList } from './interface';
+import { Size } from '../../_utils/constant';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     * @vModel
+     */
+    modelValue: {
+        type: PropType<boolean | CheckboxValueList>;
+        default: undefined;
+    };
+    /**
+     * @zh 默认是否选中（非受控状态）
+     * @en Whether checked by default (uncontrolled state)
+     */
+    defaultChecked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 选项的 `value`
+     * @en The `value` of the option
+     */
+    value: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+    };
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为半选状态
+     * @en Whether it is half-selected
+     */
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 复选框尺寸
+     * @en Checkbox size
+     * @values 'mini','small','medium','large'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+    uninjectGroupContext: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => VNode, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    'update:modelValue': (value: boolean | CheckboxValueList) => true;
+    /**
+     * @zh 值改变时触发
+     * @en Trigger when the value changes
+     * @param { boolean | CheckboxValueList } value
+     * @param {Event} ev
+     */
+    change: (value: boolean | CheckboxValueList, ev: Event) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     * @vModel
+     */
+    modelValue: {
+        type: PropType<boolean | CheckboxValueList>;
+        default: undefined;
+    };
+    /**
+     * @zh 默认是否选中（非受控状态）
+     * @en Whether checked by default (uncontrolled state)
+     */
+    defaultChecked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 选项的 `value`
+     * @en The `value` of the option
+     */
+    value: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+    };
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为半选状态
+     * @en Whether it is half-selected
+     */
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 复选框尺寸
+     * @en Checkbox size
+     * @values 'mini','small','medium','large'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+    uninjectGroupContext: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onChange?: ((value: boolean | CheckboxValueList, ev: Event) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: boolean | CheckboxValueList) => any) | undefined;
+}>, {
+    disabled: boolean;
+    modelValue: boolean | CheckboxValueList;
+    defaultChecked: boolean;
+    indeterminate: boolean;
+    uninjectGroupContext: boolean;
+}, {}, {
+    IconCheck: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    IconHover: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        prefix: {
+            type: StringConstructor;
+        };
+        size: {
+            type: PropType<"mini" | "small" | "medium" | "large" | "huge">;
+            default: string;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>, {
+        className: {
+            block: string;
+            element: (className: string) => string;
+            modifier: (className: string) => string;
+            is: (className: string) => string;
+        };
+        handleClick: (ev: MouseEvent) => void;
+        handleMousedown: (ev: MouseEvent) => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        click: (ev: MouseEvent) => true;
+        mousedown: (ev: MouseEvent) => true;
+    }, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        prefix: {
+            type: StringConstructor;
+        };
+        size: {
+            type: PropType<"mini" | "small" | "medium" | "large" | "huge">;
+            default: string;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & Readonly<{
+        onClick?: ((ev: MouseEvent) => any) | undefined;
+        onMousedown?: ((ev: MouseEvent) => any) | undefined;
+    }>, {
+        size: "mini" | "small" | "medium" | "large" | "huge";
+        disabled: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/form-checkbox/CheckboxGroup.d.ts

@@ -0,0 +1,138 @@
+import { PropType } from 'vue';
+import { Direction, Size } from '../../_utils/constant';
+import { CheckboxOption, CheckboxValue, CheckboxValueList } from './interface';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     * @vModel
+     */
+    modelValue: {
+        type: PropType<CheckboxValueList>;
+        default: undefined;
+    };
+    /**
+     * @zh 默认值（非受控状态）
+     * @en Default value (uncontrolled state)
+     */
+    defaultValue: {
+        type: PropType<CheckboxValueList>;
+        default: () => never[];
+    };
+    /**
+     * @zh 支持最多选中的数量
+     * @en Support the maximum number of selections
+     * @version 2.36.0
+     */
+    max: {
+        type: NumberConstructor;
+    };
+    /**
+     * @zh 选项
+     * @en Options
+     * @version 2.27.0
+     */
+    options: {
+        type: PropType<Array<CheckboxValue | CheckboxOption>>;
+    };
+    /**
+     * @zh 复选框的排列方向
+     * @en Arrangement direction of checkboxes
+     */
+    direction: {
+        type: PropType<Direction>;
+        default: string;
+    };
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 复选框组尺寸
+     * @en The size of checkbox group
+     * @values 'mini','small','medium','large'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+}>, () => VNode, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    'update:modelValue': (value: CheckboxValueList) => true;
+    /**
+     * @zh 值改变时触发
+     * @en Trigger when the value changes
+     * @param {CheckboxValueList} value
+     * @param {Event} ev
+     */
+    change: (value: CheckboxValueList, ev: Event) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     * @vModel
+     */
+    modelValue: {
+        type: PropType<CheckboxValueList>;
+        default: undefined;
+    };
+    /**
+     * @zh 默认值（非受控状态）
+     * @en Default value (uncontrolled state)
+     */
+    defaultValue: {
+        type: PropType<CheckboxValueList>;
+        default: () => never[];
+    };
+    /**
+     * @zh 支持最多选中的数量
+     * @en Support the maximum number of selections
+     * @version 2.36.0
+     */
+    max: {
+        type: NumberConstructor;
+    };
+    /**
+     * @zh 选项
+     * @en Options
+     * @version 2.27.0
+     */
+    options: {
+        type: PropType<Array<CheckboxValue | CheckboxOption>>;
+    };
+    /**
+     * @zh 复选框的排列方向
+     * @en Arrangement direction of checkboxes
+     */
+    direction: {
+        type: PropType<Direction>;
+        default: string;
+    };
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 复选框组尺寸
+     * @en The size of checkbox group
+     * @values 'mini','small','medium','large'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+}>> & Readonly<{
+    onChange?: ((value: CheckboxValueList, ev: Event) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: CheckboxValueList) => any) | undefined;
+}>, {
+    disabled: boolean;
+    direction: "horizontal" | "vertical";
+    modelValue: CheckboxValueList;
+    defaultValue: CheckboxValueList;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/form-checkbox/context.d.ts

@@ -0,0 +1,13 @@
+import { InjectionKey, Slots } from 'vue';
+import { Size } from '../../_utils/constant';
+import { CheckboxValueList } from './interface';
+export interface CheckboxGroupContext {
+    name: 'XCheckboxGroup';
+    computedValue: CheckboxValueList;
+    size: Size;
+    disabled: boolean;
+    isMaxed: boolean;
+    slots: Slots;
+    handleChange: (value: CheckboxValueList, e: Event) => void;
+}
+export declare const checkboxGroupKey: InjectionKey<CheckboxGroupContext>;

package/dist/components/form-checkbox/icon-check.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;