@aloudata/aloudata-design 3.1.7 → 3.2.0-beta.0

package/dist/Form/index.d.ts

@@ -1,5 +1,5 @@
-import { FormInstance as RcFormInstance, FormProvider, List, FormProps as RcFormProps } from 'rc-field-form';
-import { Rule, RuleObject, RuleRender, Meta, NamePath } from 'rc-field-form/es/interface';
+import { FormProviderProps as RcFormProviderProps } from 'rc-field-form/es/FormContext.js';
+import { Callbacks, FieldData as RcFieldData, FormInstance as RcFormInstance, Meta, NamePath, Rule, RuleObject, RuleRender, Store, StoreValue, ValidateMessages, ValidatorRule } from 'rc-field-form/es/interface.js';
 import { default as React } from 'react';
 import { ValidateStatus } from './FormItemContext.js';
 /**
@@ -15,6 +15,22 @@ type ColConfig = {
     style?: React.CSSProperties;
     [key: string]: any;
 };
+type RcFormPropsCompat<Values = any> = Omit<React.FormHTMLAttributes<HTMLFormElement>, 'onSubmit' | 'children'> & {
+    initialValues?: Store;
+    form?: RcFormInstance<Values>;
+    children?: ((values: Store, form: RcFormInstance<Values>) => React.ReactNode) | React.ReactNode;
+    component?: false | string | React.FC<any> | React.ComponentClass<any>;
+    fields?: RcFieldData[];
+    name?: string;
+    validateMessages?: ValidateMessages;
+    onValuesChange?: Callbacks<Values>['onValuesChange'];
+    onFieldsChange?: Callbacks<Values>['onFieldsChange'];
+    onFinish?: Callbacks<Values>['onFinish'];
+    onFinishFailed?: Callbacks<Values>['onFinishFailed'];
+    validateTrigger?: string | string[] | false;
+    preserve?: boolean;
+    clearOnDestroy?: boolean;
+};
 /**
  * FormInstance — extends rc-field-form FormInstance with loose-typed overloads
  * to maintain antd v4 backward compatibility. Uses intersection so that both
@@ -42,8 +58,9 @@ export type FormInstance<Values = any> = RcFormInstance<Values> & {
     /** Scroll to field position (antd-compatible extension) */
     scrollToField?(name: LooseNamePath, options?: ScrollIntoViewOptions): void;
 };
-export interface FormProps<Values = any> extends Omit<RcFormProps, 'form'> {
+export interface FormProps<Values = any> extends Omit<RcFormPropsCompat<Values>, 'form' | 'action'> {
     form?: FormInstance<Values>;
+    action?: string;
     layout?: 'horizontal' | 'vertical' | 'inline';
     size?: 'small' | 'middle' | 'large';
     colon?: boolean;
@@ -108,30 +125,29 @@ export type FormListFieldData = {
     isListField: boolean;
 };
 export type FormListOperation = {
-    add: (defaultValue?: any, insertIndex?: number) => void;
+    add: (defaultValue?: StoreValue, insertIndex?: number) => void;
     remove: (index: number | number[]) => void;
     move: (from: number, to: number) => void;
 };
-export type FormListProps = {
-    name: NamePath;
-    rules?: Rule[];
-    children: (fields: FormListFieldData[], operation: FormListOperation, meta: {
-        errors: React.ReactNode[];
-    }) => React.ReactNode;
+export type FormListProps<Values = any> = {
+    name: NamePath<Values>;
+    rules?: ValidatorRule[];
+    validateTrigger?: string | string[] | false;
+    children?: (fields: FormListFieldData[], operation: FormListOperation, meta: Meta) => React.ReactNode;
     initialValue?: any[];
+    /** @private Forwarded by rc-field-form. */
+    isListField?: boolean;
 };
-declare const AldForm: <Values = any>(props: FormProps<Values> & {
-    children?: React.ReactNode;
-} & {
-    ref?: React.Ref<FormInstance<Values>> | undefined;
-    labelWidth?: number | undefined;
+declare const AldForm: <Values = any>(props: React.PropsWithChildren<FormProps<Values>> & {
+    ref?: React.Ref<FormInstance<Values>>;
+    labelWidth?: number;
 }) => React.ReactElement;
 interface IFormItemProps extends FormItemProps {
     labelWidth?: number;
     labelAlign?: 'left' | 'right';
 }
 declare const AldFormItem: {
-    (props: IFormItemProps): import("react/jsx-runtime").JSX.Element;
+    (props: IFormItemProps): React.JSX.Element;
     useStatus: typeof useFormItemStatus;
 };
 declare function useFormItemStatus(): {
@@ -139,7 +155,7 @@ declare function useFormItemStatus(): {
     errors: string[];
     warnings: string[];
 };
-declare function ErrorListComponent(props: ErrorListProps): import("react/jsx-runtime").JSX.Element | null;
+declare function ErrorListComponent(props: ErrorListProps): React.JSX.Element | null;
 declare function useFormInstance<T = any>(): FormInstance<T>;
 type InternalFormType = typeof AldForm;
 type CompoundedComponent = InternalFormType & {
@@ -148,9 +164,9 @@ type CompoundedComponent = InternalFormType & {
     /** Loose-typed useWatch for antd v4 compat */
     useWatch: <T = any>(name: LooseNamePath, form?: FormInstance) => T;
     Item: typeof AldFormItem;
-    List: typeof List;
+    List: <Values = any>(props: FormListProps<Values>) => React.ReactElement;
     ErrorList: typeof ErrorListComponent;
-    Provider: typeof FormProvider;
+    Provider: React.FunctionComponent<RcFormProviderProps>;
     create: () => void;
 };
 declare const Form: CompoundedComponent;