@refinedev/antd 5.5.1 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +37 -0
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/hooks/fields/useCheckboxGroup/index.d.ts +11 -9
- package/dist/hooks/fields/useCheckboxGroup/index.d.ts.map +1 -1
- package/dist/hooks/fields/useRadioGroup/index.d.ts +11 -9
- package/dist/hooks/fields/useRadioGroup/index.d.ts.map +1 -1
- package/dist/hooks/fields/useSelect/index.d.ts +5 -3
- package/dist/hooks/fields/useSelect/index.d.ts.map +1 -1
- package/dist/hooks/form/useDrawerForm/useDrawerForm.d.ts +3 -3
- package/dist/hooks/form/useDrawerForm/useDrawerForm.d.ts.map +1 -1
- package/dist/hooks/form/useForm.d.ts +3 -3
- package/dist/hooks/form/useForm.d.ts.map +1 -1
- package/dist/hooks/form/useModalForm/useModalForm.d.ts +3 -3
- package/dist/hooks/form/useModalForm/useModalForm.d.ts.map +1 -1
- package/dist/hooks/form/useStepsForm/useStepsForm.d.ts +3 -3
- package/dist/hooks/form/useStepsForm/useStepsForm.d.ts.map +1 -1
- package/dist/hooks/list/useSimpleList/useSimpleList.d.ts +6 -5
- package/dist/hooks/list/useSimpleList/useSimpleList.d.ts.map +1 -1
- package/dist/hooks/table/useEditableTable/useEditableTable.d.ts +12 -5
- package/dist/hooks/table/useEditableTable/useEditableTable.d.ts.map +1 -1
- package/dist/hooks/table/useTable/useTable.d.ts +9 -3
- package/dist/hooks/table/useTable/useTable.d.ts.map +1 -1
- package/dist/iife/index.js +6 -6
- package/dist/iife/index.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/src/hooks/fields/useCheckboxGroup/index.ts +20 -13
- package/src/hooks/fields/useRadioGroup/index.ts +20 -13
- package/src/hooks/fields/useSelect/index.ts +8 -4
- package/src/hooks/form/useDrawerForm/useDrawerForm.ts +11 -7
- package/src/hooks/form/useForm.ts +15 -6
- package/src/hooks/form/useModalForm/useModalForm.ts +13 -9
- package/src/hooks/form/useStepsForm/useStepsForm.ts +13 -8
- package/src/hooks/list/useSimpleList/useSimpleList.ts +12 -8
- package/src/hooks/table/useEditableTable/useEditableTable.ts +30 -13
- package/src/hooks/table/useTable/useTable.ts +21 -14
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@refinedev/antd",
|
3
|
-
"version": "5.
|
3
|
+
"version": "5.6.0",
|
4
4
|
"description": "refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.",
|
5
5
|
"private": false,
|
6
6
|
"main": "dist/index.js",
|
@@ -25,7 +25,7 @@
|
|
25
25
|
"devDependencies": {
|
26
26
|
"@refinedev/cli": "^2.1.0",
|
27
27
|
"@refinedev/ui-tests": "^1.3.2",
|
28
|
-
"@refinedev/core": "^4.
|
28
|
+
"@refinedev/core": "^4.8.0",
|
29
29
|
"@esbuild-plugins/node-resolve": "^0.1.4",
|
30
30
|
"@testing-library/jest-dom": "^5.16.4",
|
31
31
|
"@testing-library/react": "^13.1.1",
|
@@ -17,17 +17,8 @@ export type UseCheckboxGroupReturnType<TData extends BaseRecord = BaseRecord> =
|
|
17
17
|
queryResult: QueryObserverResult<GetListResponse<TData>>;
|
18
18
|
};
|
19
19
|
|
20
|
-
|
21
|
-
|
22
|
-
*
|
23
|
-
* @see {@link https://refine.dev/docs/ui-framewors/antd/hooks/field/useCheckboxGroup} for more details.
|
24
|
-
*
|
25
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-references/interfaceReferences#baserecord `BaseRecord`}
|
26
|
-
*
|
27
|
-
*/
|
28
|
-
|
29
|
-
type UseCheckboxGroupProps<TData, TError> = Omit<
|
30
|
-
UseSelectProps<TData, TError>,
|
20
|
+
type UseCheckboxGroupProps<TQueryFnData, TError, TData> = Omit<
|
21
|
+
UseSelectProps<TQueryFnData, TError, TData>,
|
31
22
|
"defaultValue"
|
32
23
|
> & {
|
33
24
|
/**
|
@@ -36,9 +27,21 @@ type UseCheckboxGroupProps<TData, TError> = Omit<
|
|
36
27
|
defaultValue?: BaseKey[];
|
37
28
|
};
|
38
29
|
|
30
|
+
/**
|
31
|
+
* `useCheckboxGroup` hook allows you to manage an Ant Design {@link https://ant.design/components/checkbox/#components-checkbox-demo-group Checkbox.Group} component when records in a resource needs to be used as checkbox options.
|
32
|
+
*
|
33
|
+
* @see {@link https://refine.dev/docs/api-reference/antd/hooks/field/useCheckboxGroup/} for more details
|
34
|
+
*
|
35
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
36
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
37
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
38
|
+
*
|
39
|
+
*/
|
40
|
+
|
39
41
|
export const useCheckboxGroup = <
|
40
|
-
|
42
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
41
43
|
TError extends HttpError = HttpError,
|
44
|
+
TData extends BaseRecord = TQueryFnData,
|
42
45
|
>({
|
43
46
|
resource,
|
44
47
|
sort,
|
@@ -56,7 +59,11 @@ export const useCheckboxGroup = <
|
|
56
59
|
meta,
|
57
60
|
metaData,
|
58
61
|
dataProviderName,
|
59
|
-
}: UseCheckboxGroupProps<
|
62
|
+
}: UseCheckboxGroupProps<
|
63
|
+
TQueryFnData,
|
64
|
+
TError,
|
65
|
+
TData
|
66
|
+
>): UseCheckboxGroupReturnType<TData> => {
|
60
67
|
const { queryResult, options } = useSelect({
|
61
68
|
resource,
|
62
69
|
sort,
|
@@ -16,17 +16,8 @@ export type UseRadioGroupReturnType<TData extends BaseRecord = BaseRecord> = {
|
|
16
16
|
queryResult: QueryObserverResult<GetListResponse<TData>>;
|
17
17
|
};
|
18
18
|
|
19
|
-
|
20
|
-
|
21
|
-
*
|
22
|
-
* @see {@link https://refine.dev/docs/ui-frameworks/antd/hooks/field/useRadioGroup} for more details.
|
23
|
-
*
|
24
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/core/interfaceReferences#baserecord `BaseRecord`}
|
25
|
-
*
|
26
|
-
*/
|
27
|
-
|
28
|
-
type UseRadioGroupProps<TData, TError> = Omit<
|
29
|
-
UseSelectProps<TData, TError>,
|
19
|
+
type UseRadioGroupProps<TQueryFnData, TError, TData> = Omit<
|
20
|
+
UseSelectProps<TQueryFnData, TError, TData>,
|
30
21
|
"defaultValue"
|
31
22
|
> & {
|
32
23
|
/**
|
@@ -35,9 +26,21 @@ type UseRadioGroupProps<TData, TError> = Omit<
|
|
35
26
|
defaultValue?: BaseKey;
|
36
27
|
};
|
37
28
|
|
29
|
+
/**
|
30
|
+
* `useRadioGroup` hook allows you to manage an Ant Design {@link https://ant.design/components/radio/#components-radio-demo-radiogroup-with-name Radio.Group} component when records in a resource needs to be used as radio options.
|
31
|
+
*
|
32
|
+
* @see {@link https://refine.dev/docs/api-reference/antd/hooks/field/useRadioGroup/} for more details.
|
33
|
+
*
|
34
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
35
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
36
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
37
|
+
*
|
38
|
+
*/
|
39
|
+
|
38
40
|
export const useRadioGroup = <
|
39
|
-
|
41
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
40
42
|
TError extends HttpError = HttpError,
|
43
|
+
TData extends BaseRecord = TQueryFnData,
|
41
44
|
>({
|
42
45
|
resource,
|
43
46
|
sort,
|
@@ -55,7 +58,11 @@ export const useRadioGroup = <
|
|
55
58
|
meta,
|
56
59
|
metaData,
|
57
60
|
dataProviderName,
|
58
|
-
}: UseRadioGroupProps<
|
61
|
+
}: UseRadioGroupProps<
|
62
|
+
TQueryFnData,
|
63
|
+
TError,
|
64
|
+
TData
|
65
|
+
>): UseRadioGroupReturnType<TData> => {
|
59
66
|
const { queryResult, options } = useSelect({
|
60
67
|
resource,
|
61
68
|
sort,
|
@@ -19,16 +19,20 @@ export type UseSelectReturnType<TData extends BaseRecord = BaseRecord> = {
|
|
19
19
|
/**
|
20
20
|
* `useSelect` hook allows you to manage an Ant Design {@link https://ant.design/components/select/ Select} component when records in a resource needs to be used as select options.
|
21
21
|
*
|
22
|
-
* @see {@link https://refine.dev/docs/api-
|
22
|
+
* @see {@link https://refine.dev/docs/api-reference/antd/hooks/field/useSelect/} for more details.
|
23
23
|
*
|
24
|
-
* @typeParam
|
24
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
25
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
26
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
25
27
|
*
|
26
28
|
*/
|
29
|
+
|
27
30
|
export const useSelect = <
|
28
|
-
|
31
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
29
32
|
TError extends HttpError = HttpError,
|
33
|
+
TData extends BaseRecord = TQueryFnData,
|
30
34
|
>(
|
31
|
-
props: UseSelectProps<
|
35
|
+
props: UseSelectProps<TQueryFnData, TError, TData>,
|
32
36
|
): UseSelectReturnType<TData> => {
|
33
37
|
const { queryResult, defaultValueQueryResult, onSearch, options } =
|
34
38
|
useSelectCore(props);
|
@@ -27,8 +27,9 @@ export type UseDrawerFormProps<
|
|
27
27
|
TData extends BaseRecord = BaseRecord,
|
28
28
|
TError extends HttpError = HttpError,
|
29
29
|
TVariables = {},
|
30
|
-
|
31
|
-
|
30
|
+
TSelectData extends BaseRecord = TData,
|
31
|
+
> = UseFormPropsCore<TData, TError, TVariables, TSelectData> &
|
32
|
+
UseFormProps<TData, TError, TVariables, TSelectData> &
|
32
33
|
UseDrawerFormConfig &
|
33
34
|
LiveModeProps &
|
34
35
|
FormWithSyncWithLocationParams & {
|
@@ -41,7 +42,8 @@ export type UseDrawerFormReturnType<
|
|
41
42
|
TData extends BaseRecord = BaseRecord,
|
42
43
|
TError extends HttpError = HttpError,
|
43
44
|
TVariables = {},
|
44
|
-
|
45
|
+
TSelectData extends BaseRecord = TData,
|
46
|
+
> = UseFormReturnType<TData, TError, TVariables, TSelectData> & {
|
45
47
|
formProps: FormProps<TVariables> & {
|
46
48
|
form: FormInstance<TVariables>;
|
47
49
|
};
|
@@ -69,24 +71,26 @@ export const useDrawerForm = <
|
|
69
71
|
TData extends BaseRecord = BaseRecord,
|
70
72
|
TError extends HttpError = HttpError,
|
71
73
|
TVariables = {},
|
74
|
+
TSelectData extends BaseRecord = TData,
|
72
75
|
>({
|
73
76
|
syncWithLocation,
|
74
77
|
defaultVisible = false,
|
75
78
|
autoSubmitClose = true,
|
76
79
|
autoResetForm = true,
|
77
80
|
...rest
|
78
|
-
}: UseDrawerFormProps<
|
81
|
+
}: UseDrawerFormProps<
|
79
82
|
TData,
|
80
83
|
TError,
|
81
|
-
TVariables
|
82
|
-
|
84
|
+
TVariables,
|
85
|
+
TSelectData
|
86
|
+
>): UseDrawerFormReturnType<TData, TError, TVariables, TSelectData> => {
|
83
87
|
const initiallySynced = React.useRef(false);
|
84
88
|
|
85
89
|
const { visible, show, close } = useModal({
|
86
90
|
defaultVisible,
|
87
91
|
});
|
88
92
|
|
89
|
-
const useFormProps = useForm<TData, TError, TVariables>({
|
93
|
+
const useFormProps = useForm<TData, TError, TVariables, TSelectData>({
|
90
94
|
...rest,
|
91
95
|
});
|
92
96
|
|
@@ -19,7 +19,8 @@ export type UseFormProps<
|
|
19
19
|
TData extends BaseRecord = BaseRecord,
|
20
20
|
TError extends HttpError = HttpError,
|
21
21
|
TVariables = {},
|
22
|
-
|
22
|
+
TSelectData extends BaseRecord = TData,
|
23
|
+
> = UseFormPropsCore<TData, TError, TVariables, TSelectData> & {
|
23
24
|
submitOnEnter?: boolean;
|
24
25
|
/**
|
25
26
|
* Shows notification when unsaved changes exist
|
@@ -31,7 +32,8 @@ export type UseFormReturnType<
|
|
31
32
|
TData extends BaseRecord = BaseRecord,
|
32
33
|
TError extends HttpError = HttpError,
|
33
34
|
TVariables = {},
|
34
|
-
|
35
|
+
TSelectData extends BaseRecord = TData,
|
36
|
+
> = UseFormReturnTypeCore<TData, TError, TVariables, TSelectData> & {
|
35
37
|
form: FormInstance<TVariables>;
|
36
38
|
formProps: FormProps<TVariables>;
|
37
39
|
saveButtonProps: ButtonProps & {
|
@@ -57,6 +59,7 @@ export const useForm = <
|
|
57
59
|
TData extends BaseRecord = BaseRecord,
|
58
60
|
TError extends HttpError = HttpError,
|
59
61
|
TVariables = {},
|
62
|
+
TSelectData extends BaseRecord = TData,
|
60
63
|
>({
|
61
64
|
action,
|
62
65
|
resource,
|
@@ -80,18 +83,24 @@ export const useForm = <
|
|
80
83
|
createMutationOptions,
|
81
84
|
updateMutationOptions,
|
82
85
|
id: idFromProps,
|
83
|
-
}: UseFormProps<
|
86
|
+
}: UseFormProps<
|
84
87
|
TData,
|
85
88
|
TError,
|
86
|
-
TVariables
|
87
|
-
|
89
|
+
TVariables,
|
90
|
+
TSelectData
|
91
|
+
> = {}): UseFormReturnType<TData, TError, TVariables, TSelectData> => {
|
88
92
|
const [formAnt] = Form.useForm();
|
89
93
|
const formSF = useFormSF<TData, TVariables>({
|
90
94
|
form: formAnt,
|
91
95
|
});
|
92
96
|
const { form } = formSF;
|
93
97
|
|
94
|
-
const useFormCoreResult = useFormCore<
|
98
|
+
const useFormCoreResult = useFormCore<
|
99
|
+
TData,
|
100
|
+
TError,
|
101
|
+
TVariables,
|
102
|
+
TSelectData
|
103
|
+
>({
|
95
104
|
onMutationSuccess: onMutationSuccessProp
|
96
105
|
? onMutationSuccessProp
|
97
106
|
: undefined,
|
@@ -46,18 +46,20 @@ export type UseModalFormReturnType<
|
|
46
46
|
TData extends BaseRecord = BaseRecord,
|
47
47
|
TError extends HttpError = HttpError,
|
48
48
|
TVariables = {},
|
49
|
+
TSelectData extends BaseRecord = TData,
|
49
50
|
> = Omit<
|
50
|
-
UseFormReturnType<TData, TError, TVariables>,
|
51
|
+
UseFormReturnType<TData, TError, TVariables, TSelectData>,
|
51
52
|
"saveButtonProps" | "deleteButtonProps"
|
52
53
|
> &
|
53
|
-
useModalFormFromSFReturnType<
|
54
|
+
useModalFormFromSFReturnType<TSelectData, TVariables>;
|
54
55
|
|
55
56
|
export type UseModalFormProps<
|
56
57
|
TData extends BaseRecord = BaseRecord,
|
57
58
|
TError extends HttpError = HttpError,
|
58
59
|
TVariables = {},
|
59
|
-
|
60
|
-
|
60
|
+
TSelectData extends BaseRecord = TData,
|
61
|
+
> = UseFormPropsCore<TData, TError, TVariables, TSelectData> &
|
62
|
+
UseFormProps<TData, TError, TVariables, TSelectData> &
|
61
63
|
UseModalFormConfigSF &
|
62
64
|
useModalFormConfig &
|
63
65
|
LiveModeProps &
|
@@ -77,17 +79,19 @@ export const useModalForm = <
|
|
77
79
|
TData extends BaseRecord = BaseRecord,
|
78
80
|
TError extends HttpError = HttpError,
|
79
81
|
TVariables = {},
|
82
|
+
TSelectData extends BaseRecord = TData,
|
80
83
|
>({
|
81
84
|
syncWithLocation,
|
82
85
|
...rest
|
83
|
-
}: UseModalFormProps<
|
86
|
+
}: UseModalFormProps<
|
84
87
|
TData,
|
85
88
|
TError,
|
86
|
-
TVariables
|
87
|
-
|
89
|
+
TVariables,
|
90
|
+
TSelectData
|
91
|
+
>): UseModalFormReturnType<TData, TError, TVariables, TSelectData> => {
|
88
92
|
const initiallySynced = React.useRef(false);
|
89
93
|
|
90
|
-
const useFormProps = useForm<TData, TError, TVariables>({
|
94
|
+
const useFormProps = useForm<TData, TError, TVariables, TSelectData>({
|
91
95
|
...rest,
|
92
96
|
});
|
93
97
|
|
@@ -114,7 +118,7 @@ export const useModalForm = <
|
|
114
118
|
|
115
119
|
const { warnWhen, setWarnWhen } = useWarnAboutChange();
|
116
120
|
|
117
|
-
const sunflowerUseModal = useModalFormSF<
|
121
|
+
const sunflowerUseModal = useModalFormSF<TSelectData, TVariables>({
|
118
122
|
...rest,
|
119
123
|
form: form,
|
120
124
|
submit: onFinish as any,
|
@@ -33,15 +33,17 @@ export type UseStepsFormReturnType<
|
|
33
33
|
TData extends BaseRecord = BaseRecord,
|
34
34
|
TError extends HttpError = HttpError,
|
35
35
|
TVariables = {},
|
36
|
-
|
37
|
-
|
36
|
+
TSelectData extends BaseRecord = TData,
|
37
|
+
> = UseFormReturnType<TData, TError, TVariables, TSelectData> &
|
38
|
+
UseStepsFormFromSFReturnType<TSelectData, TVariables>;
|
38
39
|
|
39
40
|
export type UseStepsFormProps<
|
40
41
|
TData extends BaseRecord = BaseRecord,
|
41
42
|
TError extends HttpError = HttpError,
|
42
43
|
TVariables = {},
|
43
|
-
|
44
|
-
|
44
|
+
TSelectData extends BaseRecord = TData,
|
45
|
+
> = UseFormPropsCore<TData, TError, TVariables, TSelectData> &
|
46
|
+
UseFormProps<TData, TError, TVariables, TSelectData> &
|
45
47
|
UseStepsFormConfig;
|
46
48
|
|
47
49
|
/**
|
@@ -59,13 +61,16 @@ export const useStepsForm = <
|
|
59
61
|
TData extends BaseRecord = BaseRecord,
|
60
62
|
TError extends HttpError = HttpError,
|
61
63
|
TVariables = {},
|
64
|
+
TSelectData extends BaseRecord = TData,
|
62
65
|
>(
|
63
|
-
props: UseStepsFormProps<TData, TError, TVariables> = {},
|
64
|
-
): UseStepsFormReturnType<TData, TError, TVariables> => {
|
65
|
-
const useFormProps = useForm<TData, TError, TVariables>({
|
66
|
+
props: UseStepsFormProps<TData, TError, TVariables, TSelectData> = {},
|
67
|
+
): UseStepsFormReturnType<TData, TError, TVariables, TSelectData> => {
|
68
|
+
const useFormProps = useForm<TData, TError, TVariables, TSelectData>({
|
69
|
+
...props,
|
70
|
+
});
|
66
71
|
const { form, formProps } = useFormProps;
|
67
72
|
|
68
|
-
const stepsPropsSunflower = useStepsFormSF<
|
73
|
+
const stepsPropsSunflower = useStepsFormSF<TSelectData, TVariables>({
|
69
74
|
isBackValidate: false,
|
70
75
|
form: form,
|
71
76
|
submit: (values: any) => {
|
@@ -14,16 +14,17 @@ import { useLiveMode } from "@refinedev/core";
|
|
14
14
|
import { PaginationLink } from "@hooks/table/useTable/paginationLink";
|
15
15
|
import { PaginationConfig } from "antd/lib/pagination";
|
16
16
|
|
17
|
-
export type useSimpleListProps<
|
18
|
-
useTablePropsCore<
|
17
|
+
export type useSimpleListProps<TQueryFnData, TError, TSearchVariables, TData> =
|
18
|
+
useTablePropsCore<TQueryFnData, TError, TData> & {
|
19
19
|
onSearch?: (
|
20
20
|
data: TSearchVariables,
|
21
21
|
) => CrudFilters | Promise<CrudFilters>;
|
22
22
|
};
|
23
23
|
|
24
24
|
export type useSimpleListReturnType<
|
25
|
-
|
25
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
26
26
|
TSearchVariables = unknown,
|
27
|
+
TData extends BaseRecord = TQueryFnData,
|
27
28
|
> = Omit<useTableReturnType<TData>, "tableQueryResult"> & {
|
28
29
|
listProps: ListProps<TData>;
|
29
30
|
queryResult: useTableReturnType["tableQueryResult"];
|
@@ -36,16 +37,18 @@ export type useSimpleListReturnType<
|
|
36
37
|
*
|
37
38
|
* @see {@link https://refine.dev/docs/ui-frameworks/antd/hooks/list/useSimpleList} for more details.
|
38
39
|
*
|
39
|
-
* @typeParam
|
40
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
40
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
41
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
41
42
|
* @typeParam TSearchVariables - Antd form values
|
43
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
42
44
|
*
|
43
45
|
*/
|
44
46
|
|
45
47
|
export const useSimpleList = <
|
46
|
-
|
48
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
47
49
|
TError extends HttpError = HttpError,
|
48
50
|
TSearchVariables = unknown,
|
51
|
+
TData extends BaseRecord = TQueryFnData,
|
49
52
|
>({
|
50
53
|
resource,
|
51
54
|
initialCurrent,
|
@@ -71,9 +74,10 @@ export const useSimpleList = <
|
|
71
74
|
metaData,
|
72
75
|
dataProviderName,
|
73
76
|
}: useSimpleListProps<
|
74
|
-
|
77
|
+
TQueryFnData,
|
75
78
|
TError,
|
76
|
-
TSearchVariables
|
79
|
+
TSearchVariables,
|
80
|
+
TData
|
77
81
|
> = {}): useSimpleListReturnType<TData, TSearchVariables> => {
|
78
82
|
const {
|
79
83
|
sorters,
|
@@ -6,12 +6,13 @@ import { useTableProps, useTableReturnType } from "../useTable";
|
|
6
6
|
import { UseFormReturnType, useForm } from "../../form/useForm";
|
7
7
|
|
8
8
|
export type useEditableTableReturnType<
|
9
|
-
|
9
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
10
10
|
TError extends HttpError = HttpError,
|
11
11
|
TVariables = {},
|
12
12
|
TSearchVariables = unknown,
|
13
|
+
TData extends BaseRecord = TQueryFnData,
|
13
14
|
> = useTableReturnType<TData, TError, TSearchVariables> &
|
14
|
-
UseFormReturnType<
|
15
|
+
UseFormReturnType<TQueryFnData, TError, TVariables> & {
|
15
16
|
saveButtonProps: ButtonProps & {
|
16
17
|
onClick: () => void;
|
17
18
|
};
|
@@ -25,43 +26,59 @@ export type useEditableTableReturnType<
|
|
25
26
|
};
|
26
27
|
|
27
28
|
type useEditableTableProps<
|
28
|
-
|
29
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
29
30
|
TError extends HttpError = HttpError,
|
30
31
|
TVariables = {},
|
31
32
|
TSearchVariables = unknown,
|
33
|
+
TData extends BaseRecord = TQueryFnData,
|
32
34
|
> = Omit<
|
33
|
-
useTableProps<
|
35
|
+
useTableProps<TQueryFnData, TError, TSearchVariables, TData>,
|
34
36
|
"successNotification" | "errorNotification"
|
35
37
|
> &
|
36
|
-
UseFormProps<
|
38
|
+
UseFormProps<TQueryFnData, TError, TVariables>;
|
37
39
|
|
38
40
|
/**
|
39
41
|
* `useEditeableTable` allows you to implement edit feature on the table with ease,
|
40
|
-
* on top of all the features that {@link https://refine.dev/docs/api-
|
42
|
+
* on top of all the features that {@link https://refine.dev/docs/api-reference/core/hooks/useTable/ `useTable`} provides.
|
41
43
|
* `useEditableTable` return properties that can be used on Ant Design's {@link https://ant.design/components/table/ `<Table>`}
|
42
44
|
* and {@link https://ant.design/components/form/ `<Form>`} components.
|
43
45
|
*
|
44
|
-
* @see {@link https://refine.dev/docs/
|
46
|
+
* @see {@link https://refine.dev/docs/api-reference/antd/hooks/table/useTable/} for more details.
|
47
|
+
*
|
48
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
49
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
50
|
+
* @typeParam TVariables - Values for params
|
51
|
+
* @typeParam TSearchVariables - Values for search params
|
52
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
53
|
+
*
|
45
54
|
*/
|
46
55
|
export const useEditableTable = <
|
47
|
-
|
56
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
48
57
|
TError extends HttpError = HttpError,
|
49
58
|
TVariables = {},
|
50
59
|
TSearchVariables = unknown,
|
60
|
+
TData extends BaseRecord = TQueryFnData,
|
51
61
|
>(
|
52
62
|
props: useEditableTableProps<
|
53
|
-
|
63
|
+
TQueryFnData,
|
54
64
|
TError,
|
55
65
|
TVariables,
|
56
|
-
TSearchVariables
|
66
|
+
TSearchVariables,
|
67
|
+
TData
|
57
68
|
> = {},
|
58
|
-
): useEditableTableReturnType<
|
59
|
-
|
69
|
+
): useEditableTableReturnType<
|
70
|
+
TQueryFnData,
|
71
|
+
TError,
|
72
|
+
TVariables,
|
73
|
+
TSearchVariables,
|
74
|
+
TData
|
75
|
+
> => {
|
76
|
+
const table = useTable<TQueryFnData, TError, TSearchVariables, TData>({
|
60
77
|
...props,
|
61
78
|
successNotification: undefined,
|
62
79
|
errorNotification: undefined,
|
63
80
|
});
|
64
|
-
const edit = useForm<
|
81
|
+
const edit = useForm<TQueryFnData, TError, TVariables>({
|
65
82
|
...props,
|
66
83
|
action: "edit",
|
67
84
|
redirect: false,
|
@@ -21,13 +21,12 @@ import {
|
|
21
21
|
} from "@definitions/table";
|
22
22
|
import { PaginationLink } from "./paginationLink";
|
23
23
|
|
24
|
-
export type useTableProps<
|
25
|
-
TData
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
};
|
24
|
+
export type useTableProps<TQueryFnData, TError, TSearchVariables, TData> =
|
25
|
+
useTablePropsCore<TQueryFnData, TError, TData> & {
|
26
|
+
onSearch?: (
|
27
|
+
data: TSearchVariables,
|
28
|
+
) => CrudFilters | Promise<CrudFilters>;
|
29
|
+
};
|
31
30
|
|
32
31
|
export type useTableReturnType<
|
33
32
|
TData extends BaseRecord = BaseRecord,
|
@@ -43,13 +42,20 @@ export type useTableReturnType<
|
|
43
42
|
* Ant Design {@link https://ant.design/components/table/ `<Table>`} component.
|
44
43
|
* All features such as sorting, filtering and pagination comes as out of box.
|
45
44
|
*
|
46
|
-
* @see {@link https://refine.dev/docs/api-
|
45
|
+
* @see {@link https://refine.dev/docs/api-reference/antd/hooks/table/useTable/} for more details.
|
46
|
+
*
|
47
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
48
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
49
|
+
* @typeParam TSearchVariables - Values for search params
|
50
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
51
|
+
*
|
47
52
|
*/
|
48
53
|
|
49
54
|
export const useTable = <
|
50
|
-
|
55
|
+
TQueryFnData extends BaseRecord = BaseRecord,
|
51
56
|
TError extends HttpError = HttpError,
|
52
57
|
TSearchVariables = unknown,
|
58
|
+
TData extends BaseRecord = TQueryFnData,
|
53
59
|
>({
|
54
60
|
onSearch,
|
55
61
|
initialCurrent,
|
@@ -74,11 +80,12 @@ export const useTable = <
|
|
74
80
|
meta,
|
75
81
|
metaData,
|
76
82
|
dataProviderName,
|
77
|
-
}: useTableProps<
|
78
|
-
|
83
|
+
}: useTableProps<
|
84
|
+
TQueryFnData,
|
79
85
|
TError,
|
80
|
-
TSearchVariables
|
81
|
-
|
86
|
+
TSearchVariables,
|
87
|
+
TData
|
88
|
+
> = {}): useTableReturnType<TData, TError, TSearchVariables> => {
|
82
89
|
const {
|
83
90
|
tableQueryResult,
|
84
91
|
current,
|
@@ -93,7 +100,7 @@ export const useTable = <
|
|
93
100
|
setSorter,
|
94
101
|
createLinkForSyncWithLocation,
|
95
102
|
pageCount,
|
96
|
-
} = useTableCore<
|
103
|
+
} = useTableCore<TQueryFnData, TError, TData>({
|
97
104
|
permanentSorter,
|
98
105
|
permanentFilter,
|
99
106
|
initialCurrent,
|