x-next 0.0.0-alpha.52 → 0.0.0-alpha.53

package/dist/_hooks/use-cursor.d.ts

@@ -0,0 +1,2 @@
+import { Ref } from 'vue';
+export declare function useCursor(input: Ref<HTMLInputElement | undefined>): [() => void, () => void];

package/dist/_hooks/use-form-item.d.ts

@@ -0,0 +1,16 @@
+import { Ref } from 'vue';
+import { FormItemContext } from '../components/form/context';
+import { Size } from '../_utils/constant';
+export declare const useFormItem: ({ size, disabled, error, uninject, }?: {
+    size?: Ref<Size | undefined>;
+    disabled?: Ref<boolean>;
+    error?: Ref<boolean>;
+    uninject?: boolean;
+}) => {
+    formItemCtx: FormItemContext;
+    mergedSize: import('vue').ComputedRef<"mini" | "small" | "medium" | "large" | undefined>;
+    mergedDisabled: import('vue').ComputedRef<boolean>;
+    mergedError: import('vue').ComputedRef<boolean>;
+    feedback: Ref<string | undefined, string | undefined>;
+    eventHandlers: Ref<import('../components/form/interface').FormItemEventHandler, import('../components/form/interface').FormItemEventHandler>;
+};

package/dist/_utils/get-value-by-path.d.ts

@@ -0,0 +1,5 @@
+import { Data } from './types';
+export declare const getValueByPath: <T = any>(obj: Data | undefined, path: string | undefined) => T | undefined;
+export declare const setValueByPath: (obj: Data | undefined, path: string | undefined, value: any, { addPath }?: {
+    addPath?: boolean;
+}) => void;

package/dist/_utils/keycode.d.ts

@@ -0,0 +1,36 @@
+export declare const Enter: {
+    key: string;
+    code: string;
+};
+export declare const Esc: {
+    key: string;
+    code: string;
+};
+export declare const Backspace: {
+    key: string;
+    code: string;
+};
+export declare const Tab: {
+    key: string;
+    code: string;
+};
+export declare const Space: {
+    key: string;
+    code: string;
+};
+export declare const ArrowUp: {
+    key: string;
+    code: string;
+};
+export declare const ArrowDown: {
+    key: string;
+    code: string;
+};
+export declare const ArrowLeft: {
+    key: string;
+    code: string;
+};
+export declare const ArrowRight: {
+    key: string;
+    code: string;
+};

package/dist/_utils/pick.d.ts

@@ -0,0 +1 @@
+export default function pick<T extends object, K extends keyof T>(obj: T, keys: Array<K | string>): Pick<T, K>;

package/dist/_utils/responsive-observe.d.ts

@@ -0,0 +1,24 @@
+export type Breakpoint = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
+export type BreakpointMap = Partial<Record<Breakpoint, string>>;
+export type ScreenMap = Partial<Record<Breakpoint, boolean>>;
+export declare const responsiveArray: Breakpoint[];
+export declare const responsiveMap: BreakpointMap;
+type SubscribeFunc = (screens: ScreenMap, breakpointChecked: Breakpoint) => void;
+type MediaQueryResult = {
+    matches: boolean;
+};
+type MediaQueryListener = (matches: MediaQueryResult) => void;
+declare const responsiveObserve: {
+    matchHandlers: {
+        [key: string]: {
+            mql: MediaQueryList;
+            listener: MediaQueryListener;
+        };
+    };
+    dispatch(pointMap: ScreenMap, breakpointChecked: Breakpoint): boolean;
+    subscribe(func: SubscribeFunc): string;
+    unsubscribe(token: string): void;
+    unregister(): void;
+    register(): void;
+};
+export default responsiveObserve;

package/dist/components/form/Form.vue.d.ts

@@ -0,0 +1,313 @@
+import { PropType } from 'vue';
+import { Options as ScrollIntoViewOptions } from 'scroll-into-view-if-needed';
+import { Size } from '../../_utils/constant';
+import { FieldData, FieldRule, ValidatedError } from './interface';
+declare const FORM_LAYOUTS: readonly ["horizontal", "vertical", "inline"];
+type FormLayout = (typeof FORM_LAYOUTS)[number];
+declare const FORM_LABEL_ALIGNS: readonly ["left", "right"];
+type FormLabelAlign = (typeof FORM_LABEL_ALIGNS)[number];
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 表单数据对象
+     * @en Form data object
+     */
+    model: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * @zh 表单的布局方式，包括水平、垂直、多列
+     * @en The layout of the form, including horizontal, vertical, and multi-column
+     * @values 'horizontal', 'vertical', 'inline'
+     */
+    layout: {
+        type: PropType<FormLayout>;
+        default: string;
+    };
+    /**
+     * @zh 表单控件的尺寸
+     * @en The size of the form
+     * @values 'mini','small','medium','large'
+     * @defaultValue 'medium'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+    /**
+     * @zh 标签元素布局选项。参数同 `<col>` 组件一致
+     * @en Label element layout options. The parameters are the same as the `<col>` component
+     */
+    labelColProps: {
+        type: ObjectConstructor;
+        default: () => {
+            span: number;
+            offset: number;
+        };
+    };
+    /**
+     * @zh 表单控件布局选项。参数同 `<col>` 组件一致
+     * @en Form control layout options. The parameters are the same as the `<col>` component
+     */
+    wrapperColProps: {
+        type: ObjectConstructor;
+        default: () => {
+            span: number;
+            offset: number;
+        };
+    };
+    labelColStyle: ObjectConstructor;
+    wrapperColStyle: ObjectConstructor;
+    /**
+     * @zh 标签的对齐方向
+     * @en Alignment direction of the label
+     * @values 'left', 'right'
+     */
+    labelAlign: {
+        type: PropType<FormLabelAlign>;
+        default: string;
+    };
+    /**
+     * @zh 是否禁用表单
+     * @en Whether to disable the form
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /**
+     * @zh 表单项校验规则
+     * @en Form item validation rules
+     */
+    rules: {
+        type: PropType<Record<string, FieldRule | FieldRule[]>>;
+    };
+    /**
+     * @zh 是否开启自动标签宽度，仅在 `layout="horizontal"` 下生效。
+     * @en Whether to enable automatic label width, it only takes effect under `layout="horizontal"`.
+     * @version 2.13.0
+     */
+    autoLabelWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 表单控件 `id` 的前缀
+     */
+    id: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh 验证失败后滚动到第一个错误字段
+     * @en Scroll to the first error field after verification fails
+     * @version 2.51.0
+     */
+    scrollToFirstError: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    cls: import('vue').ComputedRef<(string | {
+        [x: string]: boolean;
+    })[]>;
+    formRef: import('vue').Ref<HTMLFormElement | undefined, HTMLFormElement | undefined>;
+    handleSubmit: (e: Event) => void;
+    innerValidate: (callback?: (errors: undefined | Record<string, ValidatedError>) => void) => Promise<undefined | Record<string, ValidatedError>>;
+    innerValidateField: (field: string | string[], callback?: (errors: undefined | Record<string, ValidatedError>) => void) => Promise<Record<string, ValidatedError> | undefined>;
+    innerResetFields: (field?: string | string[]) => void;
+    innerClearValidate: (field?: string | string[]) => void;
+    innerSetFields: (data: Record<string, FieldData>) => void;
+    innerScrollToField: (field: string, options?: ScrollIntoViewOptions) => void;
+}, {}, {}, {
+    /**
+     * @zh 校验全部表单数据
+     * @en Verify all form data
+     * @public
+     * @param {(errors: undefined | Record<string, ValidatedError>) => void} callback
+     * @returns {Promise<undefined | Record<string, ValidatedError>>}
+     */
+    validate(callback?: (errors: undefined | Record<string, ValidatedError>) => void): Promise<undefined | Record<string, ValidatedError>>;
+    /**
+     * @zh 校验部分表单数据
+     * @en Validate part of the form data
+     * @public
+     * @param {string | string[]} field
+     * @param {(errors: undefined | Record<string, ValidatedError>) => void} callback
+     * @returns {Promise<undefined | Record<string, ValidatedError>>}
+     */
+    validateField(field: string | string[], callback?: (errors: undefined | Record<string, ValidatedError>) => void): Promise<undefined | Record<string, ValidatedError>>;
+    /**
+     * @zh 重置表单数据
+     * @en Reset form data
+     * @public
+     * @param {string | string[]} field
+     */
+    resetFields(field?: string | string[]): void;
+    /**
+     * @zh 清除校验状态
+     * @en Clear verification status
+     * @public
+     * @param {string | string[]} field
+     */
+    clearValidate(field?: string | string[]): void;
+    /**
+     * @zh 设置表单项的值和状态
+     * @en Set the value and status of the form item
+     * @param {Record<string, FieldData>} data
+     * @public
+     */
+    setFields(data: Record<string, FieldData>): void;
+    /**
+     * @zh 滚动到指定表单项
+     * @en Scroll to the specified form item
+     * @param {string} field
+     * @public
+     * @version 2.51.0
+     */
+    scrollToField(field: string): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    /**
+     * @zh 表单提交时触发
+     * @en Triggered when the form is submitted
+     * @param {{values: Record<string, any>; errors: Record<string, ValidatedError> | undefined}} data
+     * @param {Event} ev
+     */
+    submit: (data: {
+        values: Record<string, any>;
+        errors: Record<string, ValidatedError> | undefined;
+    }, ev: Event) => true;
+    /**
+     * @zh 验证成功时触发
+     * @en Triggered when verification is successful
+     * @param {Record<string, any>} values
+     * @param {Event} ev
+     */
+    submitSuccess: (values: Record<string, any>, ev: Event) => true;
+    /**
+     * @zh 验证失败时触发
+     * @en Triggered when verification failed
+     * @param {{values: Record<string, any>; errors: Record<string, ValidatedError>}} data
+     * @param {Event} ev
+     */
+    submitFailed: (data: {
+        values: Record<string, any>;
+        errors: Record<string, ValidatedError>;
+    }, ev: Event) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 表单数据对象
+     * @en Form data object
+     */
+    model: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * @zh 表单的布局方式，包括水平、垂直、多列
+     * @en The layout of the form, including horizontal, vertical, and multi-column
+     * @values 'horizontal', 'vertical', 'inline'
+     */
+    layout: {
+        type: PropType<FormLayout>;
+        default: string;
+    };
+    /**
+     * @zh 表单控件的尺寸
+     * @en The size of the form
+     * @values 'mini','small','medium','large'
+     * @defaultValue 'medium'
+     */
+    size: {
+        type: PropType<Size>;
+    };
+    /**
+     * @zh 标签元素布局选项。参数同 `<col>` 组件一致
+     * @en Label element layout options. The parameters are the same as the `<col>` component
+     */
+    labelColProps: {
+        type: ObjectConstructor;
+        default: () => {
+            span: number;
+            offset: number;
+        };
+    };
+    /**
+     * @zh 表单控件布局选项。参数同 `<col>` 组件一致
+     * @en Form control layout options. The parameters are the same as the `<col>` component
+     */
+    wrapperColProps: {
+        type: ObjectConstructor;
+        default: () => {
+            span: number;
+            offset: number;
+        };
+    };
+    labelColStyle: ObjectConstructor;
+    wrapperColStyle: ObjectConstructor;
+    /**
+     * @zh 标签的对齐方向
+     * @en Alignment direction of the label
+     * @values 'left', 'right'
+     */
+    labelAlign: {
+        type: PropType<FormLabelAlign>;
+        default: string;
+    };
+    /**
+     * @zh 是否禁用表单
+     * @en Whether to disable the form
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /**
+     * @zh 表单项校验规则
+     * @en Form item validation rules
+     */
+    rules: {
+        type: PropType<Record<string, FieldRule | FieldRule[]>>;
+    };
+    /**
+     * @zh 是否开启自动标签宽度，仅在 `layout="horizontal"` 下生效。
+     * @en Whether to enable automatic label width, it only takes effect under `layout="horizontal"`.
+     * @version 2.13.0
+     */
+    autoLabelWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 表单控件 `id` 的前缀
+     */
+    id: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh 验证失败后滚动到第一个错误字段
+     * @en Scroll to the first error field after verification fails
+     * @version 2.51.0
+     */
+    scrollToFirstError: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onSubmit?: ((data: {
+        values: Record<string, any>;
+        errors: Record<string, ValidatedError> | undefined;
+    }, ev: Event) => any) | undefined;
+    onSubmitSuccess?: ((values: Record<string, any>, ev: Event) => any) | undefined;
+    onSubmitFailed?: ((data: {
+        values: Record<string, any>;
+        errors: Record<string, ValidatedError>;
+    }, ev: Event) => any) | undefined;
+}>, {
+    disabled: boolean;
+    layout: "horizontal" | "vertical" | "inline";
+    labelColProps: Record<string, any>;
+    wrapperColProps: Record<string, any>;
+    labelAlign: "left" | "right";
+    autoLabelWidth: boolean;
+    scrollToFirstError: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;