[RFR] Use reference input #3313

ThieryMichel · 2019-06-06T07:18:36Z

No description provided.

packages/ra-core/src/controller/input/useMatchingReferences.ts

packages/ra-core/src/controller/useReference.spec.ts

packages/ra-core/src/controller/usePaginationState.spec.ts

packages/ra-core/src/controller/useFilterState.ts

packages/ra-core/src/controller/useFilterState.spec.ts

fzaninotto

Awesome, almost there! Love the unit test coverage, great job on that.

fzaninotto · 2019-07-12T11:45:11Z

docs/Inputs.md

@@ -922,7 +922,7 @@ The child component may further filter results (that's the case, for instance, f

 The child component receives the following props from `<ReferenceInput>`:

- `isLoading`: whether the request for possible values is loading or not
+- `loading`: whether the request for possible values is loading or not


this is a BC break ; please add a migration guide in the UPDATE.md file

And btw, why renaming it ?

fzaninotto · 2019-07-12T11:47:19Z

packages/ra-core/src/controller/field/getResourceLinkPath.ts

@@ -64,26 +55,16 @@ export interface UseReferenceProps {
 *
 * @returns {ReferenceProps} The reference props
 */
-export const useReference = ({
-    allowEmpty = false,
+export const getResourceLinkPath = ({


no need to export it, it's the default export

fzaninotto · 2019-07-12T11:51:44Z

packages/ra-core/src/controller/field/getResourceLinkPath.ts

 * @property {Object} referenceRecord: the referenced record.
 * @property {string | false} resourceLinkPath link to the page of the related record (depends on link) (false is no link)
 */

 /**
- * Fetch reference record, and return it when avaliable
+ * Fetch reference record, and return it when available also provide link toward the referenced resource


bad jsDoc, it is now getResourceLinkPath

fzaninotto · 2019-07-12T11:55:01Z

packages/ra-core/src/controller/input/ReferenceInputController.tsx

+    ...props
+}) => {
+    return children({
+        ...props,


it's weird to pass the props there, in other controllers (e.g. useEditController), it's the caller's job to pass the initial props

fzaninotto · 2019-07-12T11:55:42Z

packages/ra-core/src/controller/input/useGetMatchingReferences.spec.tsx

+            },
+        });
+
+        rerender(() => {


this should not be in this test, which says 'on mount'

fzaninotto · 2019-07-12T11:59:28Z

packages/ra-core/src/controller/input/useReferenceInput.ts

+ *      source: 'post_id',
+ * });
+ *
+ * The hook alos allow to filter results. it returns a `setFilter`


Suggested change

* The hook alos allow to filter results. it returns a `setFilter`

* The hook also allow to filter results. It returns a `setFilter`

fzaninotto · 2019-07-12T12:08:04Z

Also, needs rebase

…rence

…ce hooks

…t from it

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

….spec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

djhi · 2019-07-22T07:26:28Z

UPGRADE.md

+
+## ReferenceInputController isLoading injected props renamed to loading
+
+When using custom component with ReferenceInputController, you should rename the component `isLoading` props to `loading`.


s/props/prop/

djhi · 2019-07-22T07:26:55Z

docs/Inputs.md

@@ -922,7 +922,7 @@ The child component may further filter results (that's the case, for instance, f

 The child component receives the following props from `<ReferenceInput>`:

- `isLoading`: whether the request for possible values is loading or not
+- `loading`: whether the request for possible values is loading or not


And btw, why renaming it ?

As requested by djhi at #3313 (comment)

fzaninotto · 2019-07-22T20:57:17Z

And btw, why renaming it ?

Because I asked for it, for consistency with the dataProvider hooks.

djhi added this to the 3.0.0 milestone Jun 10, 2019

ThieryMichel force-pushed the useReferenceInput branch from 822e9a9 to b7c8498 Compare June 19, 2019 16:23

ThieryMichel force-pushed the useReferenceInput branch 2 times, most recently from e650393 to 2d63f10 Compare July 1, 2019 11:32

ThieryMichel changed the title ~~[WIP] Use reference input~~ [RFR] Use reference input Jul 1, 2019

ThieryMichel changed the title ~~[RFR] Use reference input~~ [WIP] Use reference input Jul 1, 2019

ThieryMichel changed the title ~~[WIP] Use reference input~~ [RFR] Use reference input Jul 4, 2019

ThieryMichel force-pushed the useReferenceInput branch from 25489e9 to 87c0d65 Compare July 4, 2019 12:52

fzaninotto requested changes Jul 7, 2019

View reviewed changes

ThieryMichel force-pushed the useReferenceInput branch 2 times, most recently from 3548e8d to d11e9ed Compare July 10, 2019 15:00

fzaninotto requested changes Jul 12, 2019

View reviewed changes

ThieryMichel added 17 commits July 18, 2019 20:46

refactor ReferenceInputController into a function component

02c488b

replace hoc by hook

4b3f748

extract useFilterState in its own file

a9acc8a

rename useReference to useReferenceField and add more generic useRefe…

1caedca

…rence

add useReferenceSearch hook

7c59c95

sipmler useReferenceSearch hook

8d00d20

rename useReferenceSearch to useMatchingReferences

d60bc81

initialize selector on mount for useMatchingReferences and useReferen…

cab8d99

…ce hooks

WIP

d63e242

fix TestContext to not mutate its default store

72deb25

add test on useReference and useMatchingReferences

9ae131b

add test on usePaginationState hook

3e9e879

move hooks helper in util and use UsePrevious and useDeepCompareEffec…

96ad01f

…t from it

add test on useSortState

a55ca2f

add test on useFilterState

f152f8a

update ReferenceInputCOntroller test

970ebe8

fix test

9513bd8

ThieryMichel and others added 22 commits July 18, 2019 20:48

Update packages/ra-core/src/controller/input/useMatchingReferences.sp…

a6209f3

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/input/useMatchingReferences.sp…

2d76d39

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/input/useMatchingReferences.sp…

0d3f70f

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/input/useMatchingReferences.sp…

6586b7f

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/input/useMatchingReferences.sp…

3ce3cdf

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/input/useMatchingReferences.sp…

44e8f9d

…ec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/input/ReferenceInputController…

c01c08d

….spec.tsx Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

Update packages/ra-core/src/controller/usePaginationState.spec.ts

352aadc

Co-Authored-By: Francois Zaninotto <francois@marmelab.com>

code review

753a7ff

merge renderHookWIthRedux with renderHook

ffd69d5

add jsdoc on renderHook

d4653df

update useReference and useReferenceField hook doc

11b0683

add useReferenceInput hook

79b11f6

code review

7a1fd18

have sort reducer use action

7f33c2f

add setSort usage in jsdoc

1d69a5c

replace useReferenceField by getResourceLinkPath without useReference

0a3535d

code review

03da9bb

refactor useGetMatchingReference to stop using createSelector

d71b5ab

fix ReferenceManyField

0f51d8a

fix ReferenceFieldCOntroller

4bcb951

code review

173cb12

ThieryMichel force-pushed the useReferenceInput branch from 347ef96 to 173cb12 Compare July 18, 2019 18:49

djhi requested changes Jul 22, 2019

View reviewed changes

Typo fix s/props/prop/

70b1358

As requested by djhi at #3313 (comment)

fzaninotto approved these changes Jul 22, 2019

View reviewed changes

fzaninotto merged commit 7902574 into next Jul 22, 2019

fzaninotto deleted the useReferenceInput branch July 22, 2019 20:59

fzaninotto mentioned this pull request Jul 23, 2019

[RFR] [BC Break] Reference hooks cleanup #3446

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RFR] Use reference input #3313

[RFR] Use reference input #3313

ThieryMichel commented Jun 6, 2019

fzaninotto left a comment

fzaninotto Jul 12, 2019

djhi Jul 22, 2019

fzaninotto Jul 12, 2019

fzaninotto Jul 12, 2019

fzaninotto Jul 12, 2019

fzaninotto Jul 12, 2019

fzaninotto Jul 12, 2019

fzaninotto commented Jul 12, 2019

djhi Jul 22, 2019

djhi Jul 22, 2019

fzaninotto commented Jul 22, 2019

	* The hook alos allow to filter results. it returns a `setFilter`
	* The hook also allow to filter results. It returns a `setFilter`


		## ReferenceInputController isLoading injected props renamed to loading

		When using custom component with ReferenceInputController, you should rename the component `isLoading` props to `loading`.

[RFR] Use reference input #3313

[RFR] Use reference input #3313

Conversation

ThieryMichel commented Jun 6, 2019

fzaninotto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fzaninotto commented Jul 12, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fzaninotto commented Jul 22, 2019