Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Demo] Migrate isLoading to isPending #9524

Merged
merged 2 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions examples/crm/src/companies/CompanyShow.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ export const CompanyShow = () => (
);

const CompanyShowContent = () => {
const { record, isLoading } = useShowContext<Company>();
const { record, isPending } = useShowContext<Company>();
const [tabValue, setTabValue] = useState(0);
const handleTabChange = (event: ChangeEvent<{}>, newValue: number) => {
setTabValue(newValue);
};
if (isLoading || !record) return null;
if (isPending || !record) return null;
return (
<Box mt={2} display="flex">
<Box flex="1">
Expand Down Expand Up @@ -146,8 +146,8 @@ const TabPanel = (props: TabPanelProps) => {
};

const ContactsIterator = () => {
const { data: contacts, isLoading } = useListContext<Contact>();
if (isLoading) return null;
const { data: contacts, isPending } = useListContext<Contact>();
if (isPending) return null;

const now = Date.now();
return (
Expand Down Expand Up @@ -214,8 +214,8 @@ const CreateRelatedContactButton = () => {
};

const DealsIterator = () => {
const { data: deals, isLoading } = useListContext<Deal>();
if (isLoading) return null;
const { data: deals, isPending } = useListContext<Deal>();
if (isPending) return null;

const now = Date.now();
return (
Expand Down
8 changes: 4 additions & 4 deletions examples/crm/src/companies/GridList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ const LoadingGridList = () => (
);

const LoadedGridList = () => {
const { data, isLoading } = useListContext<Company>();
const { data, isPending } = useListContext<Company>();

if (isLoading) return null;
if (isPending) return null;

return (
<Box display="flex" flexWrap="wrap" width="100%" gap={1}>
Expand All @@ -42,6 +42,6 @@ const LoadedGridList = () => {
};

export const ImageList = () => {
const { isLoading } = useListContext();
return isLoading ? <LoadingGridList /> : <LoadedGridList />;
const { isPending } = useListContext();
return isPending ? <LoadingGridList /> : <LoadedGridList />;
};
4 changes: 2 additions & 2 deletions examples/crm/src/contacts/ContactEdit.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ export const ContactEdit = () => (
);

const ContactEditContent = () => {
const { isLoading, record } = useEditContext<Contact>();
if (isLoading || !record) return null;
const { isPending, record } = useEditContext<Contact>();
if (isPending || !record) return null;
return (
<Box mt={2} display="flex">
<Box flex="1">
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/contacts/ContactList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ import { Contact } from '../types';
const ContactListContent = () => {
const {
data: contacts,
isLoading,
isPending,
onToggleItem,
selectedIds,
} = useListContext<Contact>();
if (isLoading) {
if (isPending) {
return <SimpleListLoading hasLeftAvatarOrIcon hasSecondaryText />;
}
const now = Date.now();
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/contacts/ContactShow.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ export const ContactShow = () => (
);

const ContactShowContent = () => {
const { record, isLoading } = useShowContext<Contact>();
if (isLoading || !record) return null;
const { record, isPending } = useShowContext<Contact>();
if (isPending || !record) return null;
return (
<Box mt={2} display="flex">
<Box flex="1">
Expand Down
6 changes: 3 additions & 3 deletions examples/crm/src/contacts/TagsListEdit.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ export const TagsListEdit = () => {
const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);
const [disabled, setDisabled] = useState(false);

const { data: allTags, isLoading: isLoadingAllTags } = useGetList<Tag>(
const { data: allTags, isPending: isPendingAllTags } = useGetList<Tag>(
'tags',
{
pagination: { page: 1, perPage: 10 },
sort: { field: 'name', order: 'ASC' },
}
);
const { data: tags, isLoading: isLoadingRecordTags } = useGetMany<Tag>(
const { data: tags, isPending: isPendingRecordTags } = useGetMany<Tag>(
'tags',
{ ids: record.tags },
{ enabled: record && record.tags && record.tags.length > 0 }
Expand Down Expand Up @@ -119,7 +119,7 @@ export const TagsListEdit = () => {
);
};

if (isLoadingRecordTags || isLoadingAllTags) return null;
if (isPendingRecordTags || isPendingAllTags) return null;
return (
<>
{tags?.map(tag => (
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/dashboard/DealsChart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const multiplier = {
};

export const DealsChart = () => {
const { data, isLoading } = useGetList<Deal>('deals', {
const { data, isPending } = useGetList<Deal>('deals', {
pagination: { perPage: 100, page: 1 },
sort: {
field: 'start_at',
Expand Down Expand Up @@ -67,7 +67,7 @@ export const DealsChart = () => {
return amountByMonth;
}, [data]);

if (isLoading) return null; // FIXME return skeleton instead
if (isPending) return null; // FIXME return skeleton instead

const range = months.reduce(
(acc, month) => {
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/dashboard/DealsPipeline.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { Deal } from '../types';

export const DealsPipeline = () => {
const { identity } = useGetIdentity();
const { data, total, isLoading } = useGetList<Deal>(
const { data, total, isPending } = useGetList<Deal>(
'deals',
{
pagination: { page: 1, perPage: 10 },
Expand Down Expand Up @@ -61,7 +61,7 @@ export const DealsPipeline = () => {
linkType="show"
data={getOrderedDeals(data)}
total={total}
isLoading={isLoading}
isPending={isPending}
primaryText={deal => deal.name}
secondaryText={deal =>
`${deal.amount.toLocaleString('en-US', {
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/dashboard/HotContacts.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const HotContacts = () => {
const {
data: contactData,
total: contactTotal,
isLoading: contactsLoading,
isPending: contactsLoading,
} = useGetList<Contact>(
'contacts',
{
Expand Down Expand Up @@ -42,7 +42,7 @@ export const HotContacts = () => {
linkType="show"
data={contactData}
total={contactTotal}
isLoading={contactsLoading}
isPending={contactsLoading}
primaryText={contact =>
`${contact.first_name} ${contact.last_name}`
}
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/dashboard/LatestNotes.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const LatestNotes = () => {
const { identity } = useGetIdentity();
const {
data: contactNotesData,
isLoading: contactNotesLoading,
isPending: contactNotesLoading,
} = useGetList(
'contactNotes',
{
Expand All @@ -26,7 +26,7 @@ export const LatestNotes = () => {
},
{ enabled: Number.isInteger(identity?.id) }
);
const { data: dealNotesData, isLoading: dealNotesLoading } = useGetList(
const { data: dealNotesData, isPending: dealNotesLoading } = useGetList(
'dealNotes',
{
pagination: { page: 1, perPage: 5 },
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/deals/ContactList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import { Box, Link } from '@mui/material';
import { Link as RouterLink } from 'react-router-dom';

export const ContactList = () => {
const { data, isLoading } = useListContext();
const { data, isPending } = useListContext();

if (isLoading) return <div style={{ height: '2em' }} />;
if (isPending) return <div style={{ height: '2em' }} />;
return (
<Box
component="ul"
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/deals/DealListContent.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { DealColumn } from './DealColumn';
import { DealsByStage, getDealsByStage, stages } from './stages';

export const DealListContent = () => {
const { data: unorderedDeals, isLoading, refetch } = useListContext<Deal>();
const { data: unorderedDeals, isPending, refetch } = useListContext<Deal>();
const dataProvider = useDataProvider();

const [dealsByStage, setDealsByStage] = useState<DealsByStage>(
Expand All @@ -26,7 +26,7 @@ export const DealListContent = () => {
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [unorderedDeals]);

if (isLoading) return null;
if (isPending) return null;

const onDragEnd: OnDragEndResponder = result => {
const { destination, source } = result;
Expand Down
4 changes: 2 additions & 2 deletions examples/crm/src/notes/NotesIterator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ export const NotesIterator = ({
showStatus?: boolean;
reference: 'contacts' | 'deals';
}) => {
const { data, isLoading } = useListContext();
if (isLoading) return null;
const { data, isPending } = useListContext();
if (isPending) return null;
return (
<>
<NewNote showStatus={showStatus} reference={reference} />
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/categories/CategoryList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ const CategoryList = () => (
);

const CategoryGrid = () => {
const { data, isLoading } = useListContext<Category>();
if (isLoading) {
const { data, isPending } = useListContext<Category>();
if (isPending) {
return null;
}
return (
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/dashboard/PendingOrder.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ interface Props {
export const PendingOrder = (props: Props) => {
const { order } = props;
const translate = useTranslate();
const { referenceRecord: customer, isLoading } = useReference<Customer>({
const { referenceRecord: customer, isPending } = useReference<Customer>({
reference: 'customers',
id: order.customer_id,
});

return (
<ListItem button component={Link} to={`/commands/${order.id}`}>
<ListItemAvatar>
{isLoading ? (
{isPending ? (
<Avatar />
) : (
<Avatar
Expand Down
6 changes: 3 additions & 3 deletions examples/demo/src/dashboard/PendingReviews.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { Customer, Review } from '../types';

const PendingReviews = () => {
const translate = useTranslate();
const { data: reviews, total, isLoading } = useGetList<Review>('reviews', {
const { data: reviews, total, isPending } = useGetList<Review>('reviews', {
filter: { status: 'pending' },
sort: { field: 'date', order: 'DESC' },
pagination: { page: 1, perPage: 100 },
Expand All @@ -39,9 +39,9 @@ const PendingReviews = () => {
// if the first customer is loaded, then all the customers are loaded.
const isCustomerDataLoaded = useIsDataLoaded(
['customers', 'getMany', { ids: [String(reviews?.[0].customer_id)] }],
{ enabled: !isLoading && reviews && reviews.length > 0 }
{ enabled: !isPending && reviews && reviews.length > 0 }
);
const display = isLoading || !isCustomerDataLoaded ? 'none' : 'block';
const display = isPending || !isCustomerDataLoaded ? 'none' : 'block';

return (
<CardWithIcon
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/orders/Basket.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const Basket = () => {

const productIds = record ? record.basket.map(item => item.product_id) : [];

const { isLoading, data: products } = useGetMany<Product>(
const { isPending, data: products } = useGetMany<Product>(
'products',
{ ids: productIds },
{ enabled: !!record }
Expand All @@ -29,7 +29,7 @@ const Basket = () => {
}, {} as any)
: {};

if (isLoading || !record || !products) return null;
if (isPending || !record || !products) return null;

return (
<Table>
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/orders/MobileGrid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ import CustomerReferenceField from '../visitors/CustomerReferenceField';
import { Order } from '../types';

const MobileGrid = () => {
const { data, isLoading } = useListContext<Order>();
const { data, isPending } = useListContext<Order>();
const translate = useTranslate();
if (isLoading || data.length === 0) {
if (isPending || data.length === 0) {
return null;
}
return (
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/products/GridList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { useCreatePath, NumberField, useListContext } from 'react-admin';
import { Link } from 'react-router-dom';

const GridList = () => {
const { isLoading } = useListContext();
return isLoading ? <LoadingGridList /> : <LoadedGridList />;
const { isPending } = useListContext();
return isPending ? <LoadingGridList /> : <LoadedGridList />;
};

const useColsForWidth = () => {
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/reviews/ReviewListMobile.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import { ReviewItem } from './ReviewItem';
import { Review } from './../types';

const ReviewListMobile = () => {
const { data, isLoading, total } = useListContext<Review>();
if (isLoading || Number(total) === 0) {
const { data, isPending, total } = useListContext<Review>();
if (isPending || Number(total) === 0) {
return null;
}
return (
Expand Down
4 changes: 2 additions & 2 deletions examples/demo/src/visitors/MobileGrid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ import { Customer } from '../types';

const MobileGrid = () => {
const translate = useTranslate();
const { data, isLoading } = useListContext<Customer>();
const { data, isPending } = useListContext<Customer>();

if (isLoading || data.length === 0) {
if (isPending || data.length === 0) {
return null;
}

Expand Down
6 changes: 3 additions & 3 deletions examples/simple/src/customRouteLayout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ const sort = { field: 'published_at', order: 'DESC' } as const;
const CustomRouteLayout = ({ title = 'Posts' }) => {
useAuthenticated();

const { data, total, isLoading } = useGetList('posts', {
const { data, total, isPending } = useGetList('posts', {
pagination: { page: 1, perPage: 10 },
sort,
});

return !isLoading ? (
return !isPending ? (
<div>
<Title title="Example Admin" />
<h1>{title}</h1>
Expand All @@ -27,7 +27,7 @@ const CustomRouteLayout = ({ title = 'Posts' }) => {
<Datagrid
sort={sort}
data={data}
isLoading={isLoading}
isPending={isPending}
total={total}
rowClick="edit"
>
Expand Down
1 change: 1 addition & 0 deletions packages/ra-core/src/controller/list/useListController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,7 @@ export const injectedProps = [
'hideFilter',
'isFetching',
'isLoading',
'isPending',
'onSelect',
'onToggleItem',
'onUnselectItems',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ export interface SimpleListProps<RecordType extends RaRecord = any>
resource?: string;
data?: RecordType[];
isLoading?: boolean;
isPending?: boolean;
isLoaded?: boolean;
total?: number;
}
Expand Down
Loading