@tiny-codes/react-easy 1.0.2 → 1.0.4

package/es/components/ModalAction/index.d.ts

@@ -8,7 +8,7 @@ import type { LinkProps } from 'antd/es/typography/Link';
  * **CN:** 提交表单时不关闭弹框的Symbol，在编辑表单组件的`onSave`事件中返回时生效
  */
 export declare const SubmitWithoutClosingSymbol: unique symbol;
-export type ModalActionProps<FD extends object, CP extends FormCompPropsConstraint<FD>, TP extends object, E extends keyof TP, CRef extends object> = Omit<ModalProps, 'onOk'> & ModalActionTrigger<TP, E> & {
+export type ModalActionProps<FD extends object, CP extends FormCompPropsConstraint<FD>, TP extends object, E extends keyof TP, CRef extends object> = Omit<ModalProps, 'onOk'> & ModalActionTrigger<FD, CP, TP, E> & {
     /**
      * **EN:** Form editing component, do not use the Form component inside the component, the form
      * component and form instance are automatically created by the parent component
@@ -102,7 +102,7 @@ export interface FormCompPropsConstraint<FD> {
      */
     triggerEventData?: any[];
 }
-export interface ModalActionTrigger<TP extends object, E extends keyof TP> {
+export interface ModalActionTrigger<FD extends object, CP extends FormCompPropsConstraint<FD>, TP extends object, E extends keyof TP> {
     /**
      * **EN:** Trigger component, click to show the dialog
      *
@@ -114,7 +114,18 @@ export interface ModalActionTrigger<TP extends object, E extends keyof TP> {
      *
      * **CN:** 触发器组件的Props属性
      */
-    triggerProps?: TP;
+    triggerProps?: TP & {
+        /**
+         * **EN:** Set a custom function to determine whether to show the trigger button
+         *
+         * **CN:** 设置一个自定义函数，用于判断是否显示触发器按钮
+         *
+         * @default true
+         *
+         * @param formProps Form component props | 表单组件的props
+         */
+        show?: boolean | ((formProps?: Omit<CP, keyof FormCompPropsConstraint<FD>>) => boolean);
+    };
     /**
      * **EN:** The event name that triggers the dialog
      *
@@ -149,7 +160,7 @@ export declare const genModalActionRenderer: (defaultProps: Partial<ModalActionP
  * @param WrappedComponent ModalAction component | ModalAction组件
  * @param defaultProps Default properties | 默认属性
  */
-export declare const withDefaultModalActionProps: <FD extends object, CP extends FormCompPropsConstraint<FD>, TP extends object, E extends keyof TP, CRef extends object>(WrappedComponent: ComponentType<ModalActionProps<FD, CP, TP, E, CRef> & RefAttributes<ModalActionRef<CRef>>>, defaultProps?: Partial<ModalActionProps<FD, CP, TP, E, CRef>> | (() => Partial<ModalActionProps<FD, CP, TP, E, CRef>>)) => import("react").ForwardRefExoticComponent<Omit<ModalProps, "onOk"> & ModalActionTrigger<TP, E> & {
+export declare const withDefaultModalActionProps: <FD extends object, CP extends FormCompPropsConstraint<FD>, TP extends object, E extends keyof TP, CRef extends object>(WrappedComponent: ComponentType<Omit<ModalProps, "onOk"> & ModalActionTrigger<FD, CP, TP, E> & {
     /**
      * **EN:** Form editing component, do not use the Form component inside the component, the form
      * component and form instance are automatically created by the parent component
@@ -177,7 +188,36 @@ export declare const withDefaultModalActionProps: <FD extends object, CP extends
      *
      * **CN:** 确认事件完成后的回调，失败时不会触发，参数为`onOk`的返回值
      */
-    afterOk?: (data?: any) => void;
+    afterOk?: ((data?: any) => void) | undefined;
+} & RefAttributes<ModalActionRef<CRef>>>, defaultProps?: Partial<ModalActionProps<FD, CP, TP, E, CRef>> | (() => Partial<ModalActionProps<FD, CP, TP, E, CRef>>) | undefined) => import("react").ForwardRefExoticComponent<Omit<ModalProps, "onOk"> & ModalActionTrigger<FD, CP, TP, E> & {
+    /**
+     * **EN:** Form editing component, do not use the Form component inside the component, the form
+     * component and form instance are automatically created by the parent component
+     *
+     * **CN:** 表单编辑组件，组件内部不要使用Form组件，表单组件及表单实例由父组件自动创建
+     */
+    formComp: ComponentType<CP & RefAttributes<CRef>>;
+    /**
+     * **EN:** Props of the form editing component
+     *
+     * **CN:** 表单编辑组件的Props属性
+     */
+    formProps?: Omit<CP, keyof FormCompPropsConstraint<FD_1>> | undefined;
+    /**
+     * **EN:** The callback when clicks the confirmation button, support asynchronous saving, return
+     * `SubmitWithoutClosingSymbol` can prevent the dialog from closing, return other values will be
+     * passed to the `afterOk` event, if any
+     *
+     * **CN:** 点击确认按钮的回调，支持异步保存，返回`SubmitWithoutClosingSymbol`可以阻止弹框关闭，返回其他值会传递给`afterOk`事件，如果有的话
+     */
+    onOk?: ((formData: FD, ...args: Parameters<TP[E]>) => unknown | Promise<unknown>) | undefined;
+    /**
+     * **EN:** The callback after the confirmation event is completed, it will not be triggered when
+     * it fails, the parameter is the return value of `onOk`
+     *
+     * **CN:** 确认事件完成后的回调，失败时不会触发，参数为`onOk`的返回值
+     */
+    afterOk?: ((data?: any) => void) | undefined;
 } & RefAttributes<ModalActionRef<CRef>>>;
 /**
  * **EN:** ModalAction component type