Add ReferenceManyCountBase #10808
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| import * as React from 'react'; | ||
| import { QueryClientProvider, QueryClient } from '@tanstack/react-query'; | ||
| import { RecordContextProvider } from '../record'; | ||
| import { DataProviderContext } from '../../dataProvider'; | ||
| import { ResourceContextProvider } from '../../core'; | ||
| import { TestMemoryRouter } from '../../routing'; | ||
| import { ReferenceManyCountBase } from './ReferenceManyCountBase'; | ||
|
|
||
| export default { | ||
| title: 'ra-core/controller/field/ReferenceManyCountBase', | ||
| excludeStories: ['Wrapper'], | ||
| }; | ||
|
|
||
| const post = { | ||
| id: 1, | ||
| title: 'Lorem Ipsum', | ||
| }; | ||
| const comments = [ | ||
| { id: 1, post_id: 1, is_published: true }, | ||
| { id: 2, post_id: 1, is_published: true }, | ||
| { id: 3, post_id: 1, is_published: false }, | ||
| { id: 4, post_id: 2, is_published: true }, | ||
| { id: 5, post_id: 2, is_published: false }, | ||
| ]; | ||
|
|
||
| export const Wrapper = ({ dataProvider, children }) => ( | ||
| <TestMemoryRouter> | ||
| <DataProviderContext.Provider value={dataProvider}> | ||
| <QueryClientProvider | ||
| client={ | ||
| new QueryClient({ | ||
| defaultOptions: { | ||
| queries: { | ||
| retry: false, | ||
| }, | ||
| }, | ||
| }) | ||
| } | ||
| > | ||
| <ResourceContextProvider value="posts"> | ||
| <RecordContextProvider value={post}> | ||
| {children} | ||
| </RecordContextProvider> | ||
| </ResourceContextProvider> | ||
| </QueryClientProvider> | ||
| </DataProviderContext.Provider> | ||
| </TestMemoryRouter> | ||
| ); | ||
|
|
||
| export const Basic = () => ( | ||
| <Wrapper | ||
| dataProvider={{ | ||
| getManyReference: () => | ||
| Promise.resolve({ | ||
| data: [comments.filter(c => c.post_id === 1)[0]], | ||
| total: comments.filter(c => c.post_id === 1).length, | ||
| }), | ||
| }} | ||
| > | ||
| <ReferenceManyCountBase reference="comments" target="post_id" /> | ||
| </Wrapper> | ||
| ); | ||
|
|
||
| export const LoadingState = () => ( | ||
| <Wrapper dataProvider={{ getManyReference: () => new Promise(() => {}) }}> | ||
| <ReferenceManyCountBase | ||
| reference="comments" | ||
| target="post_id" | ||
| loading="loading..." | ||
| /> | ||
| </Wrapper> | ||
| ); | ||
|
|
||
| export const ErrorState = () => ( | ||
| <Wrapper | ||
| dataProvider={{ | ||
| getManyReference: () => Promise.reject(new Error('problem')), | ||
| }} | ||
| > | ||
| <ReferenceManyCountBase | ||
| reference="comments" | ||
| target="post_id" | ||
| error="Error!" | ||
| /> | ||
| </Wrapper> | ||
| ); | ||
|
|
||
| export const Filter = () => ( | ||
| <Wrapper | ||
| dataProvider={{ | ||
| getManyReference: (resource, params) => | ||
| Promise.resolve({ | ||
| data: comments | ||
| .filter(c => c.post_id === 1) | ||
| .filter(post => | ||
| Object.keys(params.filter).every( | ||
| key => post[key] === params.filter[key] | ||
| ) | ||
| ), | ||
| total: comments | ||
| .filter(c => c.post_id === 1) | ||
| .filter(post => | ||
| Object.keys(params.filter).every( | ||
| key => post[key] === params.filter[key] | ||
| ) | ||
| ).length, | ||
| }), | ||
| }} | ||
| > | ||
| <ReferenceManyCountBase | ||
| reference="comments" | ||
| target="post_id" | ||
| filter={{ is_published: true }} | ||
| /> | ||
| </Wrapper> | ||
| ); | ||
|
|
||
| export const Slow = () => ( | ||
| <Wrapper | ||
| dataProvider={{ | ||
| getManyReference: () => | ||
| new Promise(resolve => | ||
| setTimeout( | ||
| () => | ||
| resolve({ | ||
| data: [ | ||
| comments.filter(c => c.post_id === 1)[0], | ||
| ], | ||
| total: comments.filter(c => c.post_id === 1) | ||
| .length, | ||
| }), | ||
| 2000 | ||
| ) | ||
| ), | ||
| }} | ||
| > | ||
| <ReferenceManyCountBase | ||
| reference="comments" | ||
| target="post_id" | ||
| loading="Loading..." | ||
| /> | ||
| </Wrapper> | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| import React from 'react'; | ||
| import { | ||
| useReferenceManyFieldController, | ||
| type UseReferenceManyFieldControllerParams, | ||
| } from './useReferenceManyFieldController'; | ||
| import { useTimeout } from '../../util/hooks'; | ||
|
|
||
| /** | ||
| * Fetch and render the number of records related to the current one | ||
| * | ||
| * Relies on dataProvider.getManyReference() returning a total property | ||
| * | ||
| * @example // Display the number of comments for the current post | ||
| * <ReferenceManyCountBase reference="comments" target="post_id" /> | ||
| * | ||
| * @example // Display the number of published comments for the current post | ||
| * <ReferenceManyCountBase reference="comments" target="post_id" filter={{ is_published: true }} /> | ||
| */ | ||
| export const ReferenceManyCountBase = (props: ReferenceManyCountBaseProps) => { | ||
| const { loading = null, error = null, timeout = 1000, ...rest } = props; | ||
| const oneSecondHasPassed = useTimeout(timeout); | ||
|
|
||
| const { | ||
| isPending, | ||
| error: fetchError, | ||
| total, | ||
| } = useReferenceManyFieldController<any, any>({ | ||
| ...rest, | ||
| page: 1, | ||
| perPage: 1, | ||
| }); | ||
|
|
||
| return ( | ||
| <> | ||
| {isPending | ||
| ? oneSecondHasPassed | ||
| ? loading | ||
| : null | ||
| : fetchError | ||
| ? error | ||
| : total} | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export interface ReferenceManyCountBaseProps | ||
| extends UseReferenceManyFieldControllerParams { | ||
| timeout?: number; | ||
| loading?: React.ReactNode; | ||
| error?: React.ReactNode; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was done by callers of the hook. This logic should better be in ra-core.