@refinedev/antd 5.37.4 → 6.0.0

package/src/hooks/list/useSimpleList/useSimpleList.ts

@@ -2,33 +2,31 @@ import { Children, createElement, Fragment } from "react";
 import { ListProps, FormProps, Form, Grid } from "antd";
 
 import {
-    BaseRecord,
-    CrudFilters,
-    HttpError,
-    useTable as useTableCore,
-    useTableProps as useTablePropsCore,
-    useTableReturnType,
-    pickNotDeprecated,
+  BaseRecord,
+  CrudFilters,
+  HttpError,
+  useTable as useTableCore,
+  useTableProps as useTablePropsCore,
+  useTableReturnType,
+  pickNotDeprecated,
 } from "@refinedev/core";
 import { useLiveMode } from "@refinedev/core";
 import { PaginationLink } from "@hooks/table/useTable/paginationLink";
 import { PaginationConfig } from "antd/lib/pagination";
 
 export type useSimpleListProps<TQueryFnData, TError, TSearchVariables, TData> =
-    useTablePropsCore<TQueryFnData, TError, TData> & {
-        onSearch?: (
-            data: TSearchVariables,
-        ) => CrudFilters | Promise<CrudFilters>;
-    };
+  useTablePropsCore<TQueryFnData, TError, TData> & {
+    onSearch?: (data: TSearchVariables) => CrudFilters | Promise<CrudFilters>;
+  };
 
 export type useSimpleListReturnType<
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TSearchVariables = unknown,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TSearchVariables = unknown,
+  TData extends BaseRecord = TQueryFnData,
 > = Omit<useTableReturnType<TData>, "tableQueryResult"> & {
-    listProps: ListProps<TData>;
-    queryResult: useTableReturnType["tableQueryResult"];
-    searchFormProps: FormProps<TSearchVariables>;
+  listProps: ListProps<TData>;
+  queryResult: useTableReturnType["tableQueryResult"];
+  searchFormProps: FormProps<TSearchVariables>;
 };
 
 /**
@@ -45,188 +43,184 @@ export type useSimpleListReturnType<
  */
 
 export const useSimpleList = <
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TSearchVariables = unknown,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TSearchVariables = unknown,
+  TData extends BaseRecord = TQueryFnData,
 >({
+  resource,
+  initialCurrent,
+  initialPageSize,
+  pagination,
+  hasPagination = true,
+  initialSorter,
+  permanentSorter,
+  initialFilter,
+  permanentFilter,
+  defaultSetFilterBehavior,
+  filters: filtersFromProp,
+  sorters: sortersFromProp,
+  onSearch,
+  queryOptions,
+  syncWithLocation,
+  successNotification,
+  errorNotification,
+  liveMode: liveModeFromProp,
+  onLiveEvent,
+  liveParams,
+  meta,
+  metaData,
+  dataProviderName,
+}: useSimpleListProps<
+  TQueryFnData,
+  TError,
+  TSearchVariables,
+  TData
+> = {}): useSimpleListReturnType<TData, TSearchVariables> => {
+  const {
+    sorters,
+    sorter,
+    filters,
+    current,
+    pageSize,
+    pageCount,
+    setFilters,
+    setCurrent,
+    setPageSize,
+    setSorter,
+    setSorters,
+    createLinkForSyncWithLocation,
+    tableQueryResult: queryResult,
+    overtime,
+  } = useTableCore({
     resource,
-    initialCurrent,
-    initialPageSize,
-    pagination,
-    hasPagination = true,
     initialSorter,
     permanentSorter,
     initialFilter,
     permanentFilter,
-    defaultSetFilterBehavior,
     filters: filtersFromProp,
     sorters: sortersFromProp,
-    onSearch,
+    defaultSetFilterBehavior,
+    initialCurrent,
+    initialPageSize,
     queryOptions,
-    syncWithLocation,
     successNotification,
     errorNotification,
     liveMode: liveModeFromProp,
     onLiveEvent,
     liveParams,
-    meta,
-    metaData,
+    meta: pickNotDeprecated(meta, metaData),
+    metaData: pickNotDeprecated(meta, metaData),
+    syncWithLocation,
     dataProviderName,
-}: useSimpleListProps<
-    TQueryFnData,
-    TError,
-    TSearchVariables,
-    TData
-> = {}): useSimpleListReturnType<TData, TSearchVariables> => {
-    const {
-        sorters,
-        sorter,
-        filters,
-        current,
-        pageSize,
-        pageCount,
-        setFilters,
-        setCurrent,
-        setPageSize,
-        setSorter,
-        setSorters,
-        createLinkForSyncWithLocation,
-        tableQueryResult: queryResult,
-        overtime,
-    } = useTableCore({
-        resource,
-        initialSorter,
-        permanentSorter,
-        initialFilter,
-        permanentFilter,
-        filters: filtersFromProp,
-        sorters: sortersFromProp,
-        defaultSetFilterBehavior,
-        initialCurrent,
-        initialPageSize,
-        queryOptions,
-        successNotification,
-        errorNotification,
-        liveMode: liveModeFromProp,
-        onLiveEvent,
-        liveParams,
-        meta: pickNotDeprecated(meta, metaData),
-        metaData: pickNotDeprecated(meta, metaData),
-        syncWithLocation,
-        dataProviderName,
-        pagination,
-        hasPagination,
-    });
-
-    const hasPaginationString = hasPagination === false ? "off" : "server";
-    const isPaginationEnabled =
-        (pagination?.mode ?? hasPaginationString) !== "off";
-
-    const breakpoint = Grid.useBreakpoint();
-
-    const liveMode = useLiveMode(liveModeFromProp);
-
-    const [form] = Form.useForm<TSearchVariables>();
-
-    const { data, isFetched, isLoading } = queryResult;
-
-    const onChange = (page: number, pageSize?: number): void => {
-        if (isPaginationEnabled) {
-            setCurrent(page);
-            setPageSize(pageSize || 10);
-        }
-    };
-
-    const onFinish = async (values: TSearchVariables) => {
-        if (onSearch) {
-            const searchFilters = await onSearch(values);
-            if (isPaginationEnabled) {
-                setCurrent?.(1);
-            }
-            return setFilters(searchFilters);
-        }
-    };
-
-    const antdPagination = (): false | PaginationConfig => {
-        if (isPaginationEnabled) {
-            return {
-                itemRender: (page, type, element) => {
-                    const link = createLinkForSyncWithLocation({
-                        pagination: {
-                            pageSize,
-                            current: page,
-                        },
-                        sorters,
-                        filters,
-                    });
-
-                    if (type === "page") {
-                        return createElement(PaginationLink, {
-                            to: link,
-                            element: `${page}`,
-                        });
-                    }
-                    if (type === "next" || type === "prev") {
-                        return createElement(PaginationLink, {
-                            to: link,
-                            element: element,
-                        });
-                    }
-
-                    if (type === "jump-next" || type === "jump-prev") {
-                        const elementChildren = (element as React.ReactElement)
-                            ?.props?.children;
-
-                        return createElement(PaginationLink, {
-                            to: link,
-                            element:
-                                Children.count(elementChildren) > 1
-                                    ? createElement(
-                                          Fragment,
-                                          {},
-                                          elementChildren,
-                                      )
-                                    : elementChildren,
-                        });
-                    }
-
-                    return element;
-                },
-                pageSize,
-                current,
-                simple: !breakpoint.sm,
-                total: data?.total,
-                onChange,
-            };
-        }
-
-        return false;
-    };
-
-    return {
-        searchFormProps: {
-            form,
-            onFinish,
-        },
-        listProps: {
-            dataSource: data?.data,
-            loading: liveMode === "auto" ? isLoading : !isFetched,
-            pagination: antdPagination(),
+    pagination,
+    hasPagination,
+  });
+
+  const hasPaginationString = hasPagination === false ? "off" : "server";
+  const isPaginationEnabled =
+    (pagination?.mode ?? hasPaginationString) !== "off";
+
+  const breakpoint = Grid.useBreakpoint();
+
+  const liveMode = useLiveMode(liveModeFromProp);
+
+  const [form] = Form.useForm<TSearchVariables>();
+
+  const { data, isFetched, isLoading } = queryResult;
+
+  const onChange = (page: number, pageSize?: number): void => {
+    if (isPaginationEnabled) {
+      setCurrent(page);
+      setPageSize(pageSize || 10);
+    }
+  };
+
+  const onFinish = async (values: TSearchVariables) => {
+    if (onSearch) {
+      const searchFilters = await onSearch(values);
+      if (isPaginationEnabled) {
+        setCurrent?.(1);
+      }
+      return setFilters(searchFilters);
+    }
+  };
+
+  const antdPagination = (): false | PaginationConfig => {
+    if (isPaginationEnabled) {
+      return {
+        itemRender: (page, type, element) => {
+          const link = createLinkForSyncWithLocation({
+            pagination: {
+              pageSize,
+              current: page,
+            },
+            sorters,
+            filters,
+          });
+
+          if (type === "page") {
+            return createElement(PaginationLink, {
+              to: link,
+              element: `${page}`,
+            });
+          }
+          if (type === "next" || type === "prev") {
+            return createElement(PaginationLink, {
+              to: link,
+              element: element,
+            });
+          }
+
+          if (type === "jump-next" || type === "jump-prev") {
+            const elementChildren = (element as React.ReactElement)?.props
+              ?.children;
+
+            return createElement(PaginationLink, {
+              to: link,
+              element:
+                Children.count(elementChildren) > 1
+                  ? createElement(Fragment, {}, elementChildren)
+                  : elementChildren,
+            });
+          }
+
+          return element;
         },
-        queryResult,
-        filters,
-        setFilters,
-        sorter,
-        setSorter,
-        sorters,
-        setSorters,
-        current,
-        setCurrent,
         pageSize,
-        setPageSize,
-        pageCount,
-        createLinkForSyncWithLocation,
-        overtime,
-    };
+        current,
+        simple: !breakpoint.sm,
+        total: data?.total,
+        onChange,
+      };
+    }
+
+    return false;
+  };
+
+  return {
+    searchFormProps: {
+      form,
+      onFinish,
+    },
+    listProps: {
+      dataSource: data?.data,
+      loading: liveMode === "auto" ? isLoading : !isFetched,
+      pagination: antdPagination(),
+    },
+    queryResult,
+    filters,
+    setFilters,
+    sorter,
+    setSorter,
+    sorters,
+    setSorters,
+    current,
+    setCurrent,
+    pageSize,
+    setPageSize,
+    pageCount,
+    createLinkForSyncWithLocation,
+    overtime,
+  };
 };

package/src/hooks/modal/useModal/index.tsx

@@ -1,18 +1,18 @@
 import { ModalProps } from "antd";
 import {
-    useModal as useCoreModal,
-    useModalReturnType as useCoreModelReturnType,
+  useModal as useCoreModal,
+  useModalReturnType as useCoreModelReturnType,
 } from "@refinedev/core";
 
 export type useModalReturnType = {
-    modalProps: ModalProps;
+  modalProps: ModalProps;
 } & Omit<useCoreModelReturnType, "visible">;
 
 export type useModalProps = {
-    /**
-     * Default props for Ant Design {@link https://ant.design/components/modal/ `<Modal>`} component.
-     */
-    modalProps?: ModalProps;
+  /**
+   * Default props for Ant Design {@link https://ant.design/components/modal/ `<Modal>`} component.
+   */
+  modalProps?: ModalProps;
 };
 
 /**
@@ -21,23 +21,23 @@ export type useModalProps = {
  * @see {@link https://refine.dev/docs/api-reference/antd/hooks/ui/useModal} for more details.
  */
 export const useModal = ({
-    modalProps = {},
+  modalProps = {},
 }: useModalProps = {}): useModalReturnType => {
-    const { show, close, visible } = useCoreModal({
-        defaultVisible: modalProps.open,
-    });
+  const { show, close, visible } = useCoreModal({
+    defaultVisible: modalProps.open,
+  });
 
-    return {
-        modalProps: {
-            ...modalProps,
-            onCancel: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
-                modalProps.onCancel?.(e);
-                close();
-            },
-            open: visible,
-            visible,
-        },
-        show,
-        close,
-    };
+  return {
+    modalProps: {
+      ...modalProps,
+      onCancel: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
+        modalProps.onCancel?.(e);
+        close();
+      },
+      open: visible,
+      visible,
+    },
+    show,
+    close,
+  };
 };

package/src/hooks/table/useEditableTable/useEditableTable.ts

@@ -6,41 +6,41 @@ import { useTableProps, useTableReturnType } from "../useTable";
 import { UseFormReturnType, useForm } from "../../form/useForm";
 
 export type useEditableTableReturnType<
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
-    TSearchVariables = unknown,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
+  TSearchVariables = unknown,
+  TData extends BaseRecord = TQueryFnData,
 > = useTableReturnType<TData, TError, TSearchVariables> &
-    UseFormReturnType<TQueryFnData, TError, TVariables> & {
-        saveButtonProps: ButtonProps & {
-            onClick: () => void;
-        };
-        cancelButtonProps: ButtonProps & {
-            onClick: () => void;
-        };
-        editButtonProps: (id: BaseKey) => ButtonProps & {
-            onClick: () => void;
-        };
-        isEditing: (id: BaseKey) => boolean;
+  UseFormReturnType<TQueryFnData, TError, TVariables> & {
+    saveButtonProps: ButtonProps & {
+      onClick: () => void;
     };
+    cancelButtonProps: ButtonProps & {
+      onClick: () => void;
+    };
+    editButtonProps: (id: BaseKey) => ButtonProps & {
+      onClick: () => void;
+    };
+    isEditing: (id: BaseKey) => boolean;
+  };
 
 type useEditableTableProps<
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
-    TSearchVariables = unknown,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
+  TSearchVariables = unknown,
+  TData extends BaseRecord = TQueryFnData,
 > = Omit<
-    useTableProps<TQueryFnData, TError, TSearchVariables, TData>,
-    "successNotification" | "errorNotification"
+  useTableProps<TQueryFnData, TError, TSearchVariables, TData>,
+  "successNotification" | "errorNotification"
 > &
-    UseFormProps<TQueryFnData, TError, TVariables> & {
-        /**
-         * When true, row will be closed after successful submit.
-         */
-        autoSubmitClose?: boolean;
-    };
+  UseFormProps<TQueryFnData, TError, TVariables> & {
+    /**
+     * When true, row will be closed after successful submit.
+     */
+    autoSubmitClose?: boolean;
+  };
 
 /**
  * `useEditeableTable` allows you to implement edit feature on the table with ease,
@@ -58,70 +58,70 @@ type useEditableTableProps<
  *
  */
 export const useEditableTable = <
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
-    TSearchVariables = unknown,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
+  TSearchVariables = unknown,
+  TData extends BaseRecord = TQueryFnData,
 >({
-    autoSubmitClose = true,
-    ...props
+  autoSubmitClose = true,
+  ...props
 }: useEditableTableProps<
-    TQueryFnData,
-    TError,
-    TVariables,
-    TSearchVariables,
-    TData
+  TQueryFnData,
+  TError,
+  TVariables,
+  TSearchVariables,
+  TData
 > = {}): useEditableTableReturnType<
-    TQueryFnData,
-    TError,
-    TVariables,
-    TSearchVariables,
-    TData
+  TQueryFnData,
+  TError,
+  TVariables,
+  TSearchVariables,
+  TData
 > => {
-    const table = useTable<TQueryFnData, TError, TSearchVariables, TData>({
-        ...props,
-        successNotification: undefined,
-        errorNotification: undefined,
-    });
-    const edit = useForm<TQueryFnData, TError, TVariables>({
-        ...props,
-        action: "edit",
-        redirect: false,
-    });
+  const table = useTable<TQueryFnData, TError, TSearchVariables, TData>({
+    ...props,
+    successNotification: undefined,
+    errorNotification: undefined,
+  });
+  const edit = useForm<TQueryFnData, TError, TVariables>({
+    ...props,
+    action: "edit",
+    redirect: false,
+  });
 
-    const { id: editId, setId, saveButtonProps } = edit;
+  const { id: editId, setId, saveButtonProps } = edit;
 
-    const cancelButtonProps = {
-        onClick: () => {
-            setId(undefined);
-        },
-    };
+  const cancelButtonProps = {
+    onClick: () => {
+      setId(undefined);
+    },
+  };
 
-    const editButtonProps = (id: BaseKey) => {
-        return {
-            onClick: () => setId(id),
-        };
+  const editButtonProps = (id: BaseKey) => {
+    return {
+      onClick: () => setId(id),
     };
+  };
 
-    const isEditing = (id: BaseKey) => id === editId;
+  const isEditing = (id: BaseKey) => id === editId;
 
-    return {
-        ...table,
-        ...edit,
-        formProps: {
-            ...edit.formProps,
-            onFinish: async (values) => {
-                const result = await edit.onFinish(values);
-                if (autoSubmitClose) {
-                    setId(undefined);
-                }
-                return result;
-            },
-        },
-        saveButtonProps,
-        cancelButtonProps,
-        editButtonProps,
-        isEditing,
-    };
+  return {
+    ...table,
+    ...edit,
+    formProps: {
+      ...edit.formProps,
+      onFinish: async (values) => {
+        const result = await edit.onFinish(values);
+        if (autoSubmitClose) {
+          setId(undefined);
+        }
+        return result;
+      },
+    },
+    saveButtonProps,
+    cancelButtonProps,
+    editButtonProps,
+    isEditing,
+  };
 };