Merge pull request #3644 from marmelab/isloading

[RFR] Rename isLoading to loading everywhere
marmelab · Sep 3, 2019 · d0007d2 · d0007d2
2 parents 9b08ceb + 243beb3
commit d0007d2
Show file tree

Hide file tree

Showing 25 changed files with 78 additions and 76 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -362,9 +362,11 @@ export default (type, params) => {
 }
 ```
 
-## ReferenceInputController isLoading injected props renamed to loading
+## isLoading injected props renamed to loading
 
-When using custom component with ReferenceInputController, you should rename the component `isLoading` prop to `loading`.
+Much of the react-admin controller components that fetch data used to inject an `isLoading` boolean prop, set to true whenever a dataProvider call was pending. this prop was renamed to `loading` everywhere. Use the search and replace feature of your IDE to rename that prop.
+
+For instance:
 
 ```diff
 - <ReferenceInputController {...props}>

diff --git a/examples/demo/src/layout/Login.js b/examples/demo/src/layout/Login.js
@@ -75,7 +75,7 @@ const Login = ({ location }) => {
     const translate = useTranslate();
     const classes = useStyles();
     const dispatch = useDispatch();
-    const isLoading = useSelector(state => state.admin.loading > 0);
+    const loading = useSelector(state => state.admin.loading > 0);
 
     const login = auth =>
         dispatch(
@@ -116,7 +116,7 @@ const Login = ({ location }) => {
                                         name="username"
                                         component={renderInput}
                                         label={translate('ra.auth.username')}
-                                        disabled={isLoading}
+                                        disabled={loading}
                                     />
                                 </div>
                                 <div className={classes.input}>
@@ -125,7 +125,7 @@ const Login = ({ location }) => {
                                         component={renderInput}
                                         label={translate('ra.auth.password')}
                                         type="password"
-                                        disabled={isLoading}
+                                        disabled={loading}
                                     />
                                 </div>
                             </div>
@@ -134,11 +134,11 @@ const Login = ({ location }) => {
                                     variant="contained"
                                     type="submit"
                                     color="primary"
-                                    disabled={isLoading}
+                                    disabled={loading}
                                     className={classes.button}
                                     fullWidth
                                 >
-                                    {isLoading && (
+                                    {loading && (
                                         <CircularProgress
                                             size={25}
                                             thickness={2}

diff --git a/examples/demo/src/reviews/ReviewListMobile.js b/examples/demo/src/reviews/ReviewListMobile.js
@@ -28,10 +28,10 @@ const useStyles = makeStyles({
     },
 });
 
-const ReviewMobileList = ({ basePath, data, ids, isLoading, total }) => {
+const ReviewMobileList = ({ basePath, data, ids, loading, total }) => {
     const classes = useStyles();
     return (
-        (isLoading || total > 0) && (
+        (loading || total > 0) && (
             <List className={classes.root}>
                 {ids.map(id => (
                     <Link

diff --git a/examples/simple/src/comments/CommentList.js b/examples/simple/src/comments/CommentList.js
@@ -66,17 +66,10 @@ const exporter = (records, fetchRelatedRecords) =>
         });
     });
 
-const CommentPagination = ({
-    isLoading,
-    ids,
-    page,
-    perPage,
-    total,
-    setPage,
-}) => {
+const CommentPagination = ({ loading, ids, page, perPage, total, setPage }) => {
     const translate = useTranslate();
     const nbPages = Math.ceil(total / perPage) || 1;
-    if (!isLoading && (total === 0 || (ids && !ids.length))) {
+    if (!loading && (total === 0 || (ids && !ids.length))) {
         return <PaginationLimit total={total} page={page} ids={ids} />;
     }
 

diff --git a/packages/ra-core/src/controller/field/useReferenceManyFieldController.ts b/packages/ra-core/src/controller/field/useReferenceManyFieldController.ts
@@ -55,7 +55,7 @@ const defaultFilter = {};
  *
  * @example
  *
- * const { isLoading, referenceRecord, resourceLinkPath } = useReferenceManyFieldController({
+ * const { loaded, referenceRecord, resourceLinkPath } = useReferenceManyFieldController({
  *     resource
  *     reference: 'users',
  *     record: {

diff --git a/packages/ra-core/src/controller/input/ReferenceArrayInputController.spec.tsx b/packages/ra-core/src/controller/input/ReferenceArrayInputController.spec.tsx
@@ -19,7 +19,7 @@ describe('<ReferenceArrayInputController />', () => {
         translate: x => `*${x}*`,
     };
 
-    it('should set isLoading to true as long as there are no references fetched and no selected references', () => {
+    it('should set loading to true as long as there are no references fetched and no selected references', () => {
         const children = jest.fn();
         shallow(
             <ReferenceArrayInputController
@@ -32,10 +32,10 @@ describe('<ReferenceArrayInputController />', () => {
             </ReferenceArrayInputController>
         );
 
-        assert.equal(children.mock.calls[0][0].isLoading, true);
+        assert.equal(children.mock.calls[0][0].loading, true);
     });
 
-    it('should set isLoading to true as long as there are no references fetched and there are no data found for the references already selected', () => {
+    it('should set loading to true as long as there are no references fetched and there are no data found for the references already selected', () => {
         const children = jest.fn();
         shallow(
             <ReferenceArrayInputController
@@ -49,10 +49,10 @@ describe('<ReferenceArrayInputController />', () => {
                 {children}
             </ReferenceArrayInputController>
         );
-        assert.equal(children.mock.calls[0][0].isLoading, true);
+        assert.equal(children.mock.calls[0][0].loading, true);
     });
 
-    it('should set isLoading to false if the references are being searched but data from at least one selected reference was found', () => {
+    it('should set loading to false if the references are being searched but data from at least one selected reference was found', () => {
         const children = jest.fn();
         shallow(
             <ReferenceArrayInputController
@@ -66,7 +66,7 @@ describe('<ReferenceArrayInputController />', () => {
                 {children}
             </ReferenceArrayInputController>
         );
-        assert.equal(children.mock.calls[0][0].isLoading, false);
+        assert.equal(children.mock.calls[0][0].loading, false);
         assert.deepEqual(children.mock.calls[0][0].choices, [{ id: 1 }]);
     });
 

diff --git a/packages/ra-core/src/controller/input/ReferenceArrayInputController.tsx b/packages/ra-core/src/controller/input/ReferenceArrayInputController.tsx
@@ -27,7 +27,7 @@ const defaultReferenceSource = (resource: string, source: string) =>
 interface ChildrenFuncParams {
     choices: Record[];
     error?: string;
-    isLoading: boolean;
+    loading: boolean;
     onChange: (value: any) => void;
     setFilter: (filter: any) => void;
     setPagination: (pagination: Pagination) => void;
@@ -288,7 +288,7 @@ export class UnconnectedReferenceArrayInputController extends Component<
         return children({
             choices: dataStatus.choices,
             error: dataStatus.error,
-            isLoading: dataStatus.waiting,
+            loading: dataStatus.waiting,
             onChange,
             setFilter: this.debouncedSetFilter,
             setPagination: this.setPagination,

diff --git a/packages/ra-core/src/controller/useCreateController.ts b/packages/ra-core/src/controller/useCreateController.ts
@@ -14,8 +14,9 @@ import { useTranslate } from '../i18n';
 import { useVersion } from '.';
 
 export interface CreateControllerProps {
-    isLoading: boolean;
-    isSaving: boolean;
+    loading: boolean;
+    loaded: boolean;
+    saving: boolean;
     defaultTitle: string;
     save: (record: Partial<Record>, redirect: RedirectionSideEffect) => void;
     resource: string;
@@ -77,7 +78,7 @@ const useCreateController = (props: CreateProps): CreateControllerProps => {
     const recordToUse = getRecord(location, record);
     const version = useVersion();
 
-    const [create, { loading: isSaving }] = useCreate(resource);
+    const [create, { loading: saving }] = useCreate(resource);
 
     const save = useCallback(
         (
@@ -131,8 +132,9 @@ const useCreateController = (props: CreateProps): CreateControllerProps => {
     });
 
     return {
-        isLoading: false,
-        isSaving,
+        loading: false,
+        loaded: true,
+        saving,
         defaultTitle,
         save,
         resource,

diff --git a/packages/ra-core/src/controller/useEditController.ts b/packages/ra-core/src/controller/useEditController.ts
@@ -26,8 +26,9 @@ export interface EditProps {
 }
 
 export interface EditControllerProps {
-    isLoading: boolean;
-    isSaving: boolean;
+    loading: boolean;
+    loaded: boolean;
+    saving: boolean;
     defaultTitle: string;
     save: (data: Record, redirect?: RedirectionSideEffect) => void;
     resource: string;
@@ -62,7 +63,7 @@ const useEditController = (props: EditProps): EditControllerProps => {
     const redirect = useRedirect();
     const refresh = useRefresh();
     const version = useVersion();
-    const { data: record, loading } = useGetOne(resource, id, {
+    const { data: record, loading, loaded } = useGetOne(resource, id, {
         version, // used to force reload
         onFailure: () => {
             notify('ra.notification.item_doesnt_exist', 'warning');
@@ -81,7 +82,7 @@ const useEditController = (props: EditProps): EditControllerProps => {
         record,
     });
 
-    const [update, { loading: isSaving }] = useUpdate(
+    const [update, { loading: saving }] = useUpdate(
         resource,
         id,
         {}, // set by the caller
@@ -119,8 +120,9 @@ const useEditController = (props: EditProps): EditControllerProps => {
     );
 
     return {
-        isLoading: loading,
-        isSaving,
+        loading,
+        loaded,
+        saving,
         defaultTitle,
         save,
         resource,

diff --git a/packages/ra-core/src/controller/useListController.ts b/packages/ra-core/src/controller/useListController.ts
@@ -50,7 +50,7 @@ export interface ListControllerProps {
     hasCreate: boolean;
     hideFilter: (filterName: string) => void;
     ids: Identifier[];
-    isLoading: boolean;
+    loading: boolean;
     loaded: boolean;
     onSelect: (ids: Identifier[]) => void;
     onToggleItem: (id: Identifier) => void;
@@ -174,7 +174,7 @@ const useListController = (props: ListProps): ListControllerProps => {
         filterValues: query.filterValues,
         hasCreate,
         ids,
-        isLoading: loading,
+        loading,
         loaded,
         onSelect: selectionModifiers.select,
         onToggleItem: selectionModifiers.toggle,
@@ -204,7 +204,7 @@ export const injectedProps = [
     'hasCreate',
     'hideFilter',
     'ids',
-    'isLoading',
+    'loading',
     'loaded',
     'onSelect',
     'onToggleItem',

diff --git a/packages/ra-core/src/controller/useShowController.ts b/packages/ra-core/src/controller/useShowController.ts
@@ -20,7 +20,8 @@ export interface ShowProps {
 }
 
 export interface ShowControllerProps {
-    isLoading: boolean;
+    loading: boolean;
+    loaded: boolean;
     defaultTitle: string;
     resource: string;
     basePath: string;
@@ -53,7 +54,7 @@ const useShowController = (props: ShowProps): ShowControllerProps => {
     const redirect = useRedirect();
     const refresh = useRefresh();
     const version = useVersion();
-    const { data: record, loading } = useGetOne(resource, id, {
+    const { data: record, loading, loaded } = useGetOne(resource, id, {
         version, // used to force reload
         onFailure: () => {
             notify('ra.notification.item_doesnt_exist', 'warning');
@@ -73,7 +74,8 @@ const useShowController = (props: ShowProps): ShowControllerProps => {
     });
 
     return {
-        isLoading: loading,
+        loading,
+        loaded,
         defaultTitle,
         resource,
         basePath,

diff --git a/packages/ra-tree-ui-materialui/src/Tree.js b/packages/ra-tree-ui-materialui/src/Tree.js
@@ -31,7 +31,7 @@ const sanitizeRestProps = ({
     hasBulkActions,
     hasCreate,
     hideFilter,
-    isLoading,
+    loading,
     loaded,
     loadedOnce,
     perPage,

diff --git a/packages/ra-ui-materialui/src/auth/LoginForm.tsx b/packages/ra-ui-materialui/src/auth/LoginForm.tsx
@@ -49,9 +49,7 @@ const Input = ({
 
 const LoginForm: SFC<Props> = ({ redirectTo }) => {
     const dispatch = useDispatch();
-    const isLoading = useSelector(
-        (state: ReduxState) => state.admin.loading > 0
-    );
+    const loading = useSelector((state: ReduxState) => state.admin.loading > 0);
     const translate = useTranslate();
     const classes = useStyles({});
 
@@ -85,7 +83,7 @@ const LoginForm: SFC<Props> = ({ redirectTo }) => {
                                 name="username"
                                 component={Input}
                                 label={translate('ra.auth.username')}
-                                disabled={isLoading}
+                                disabled={loading}
                             />
                         </div>
                         <div className={classes.input}>
@@ -95,7 +93,7 @@ const LoginForm: SFC<Props> = ({ redirectTo }) => {
                                 component={Input}
                                 label={translate('ra.auth.password')}
                                 type="password"
-                                disabled={isLoading}
+                                disabled={loading}
                             />
                         </div>
                     </div>
@@ -104,10 +102,10 @@ const LoginForm: SFC<Props> = ({ redirectTo }) => {
                             variant="contained"
                             type="submit"
                             color="primary"
-                            disabled={submitting || isLoading}
+                            disabled={submitting || loading}
                             className={classes.button}
                         >
-                            {isLoading && (
+                            {loading && (
                                 <CircularProgress
                                     className={classes.icon}
                                     size={18}

diff --git a/packages/ra-ui-materialui/src/detail/Create.js b/packages/ra-ui-materialui/src/detail/Create.js
@@ -88,8 +88,9 @@ const sanitizeRestProps = ({
     children,
     className,
     crudCreate,
-    isLoading,
-    isSaving,
+    loading,
+    loaded,
+    saving,
     resource,
     title,
     hasCreate,

diff --git a/packages/ra-ui-materialui/src/detail/Edit.js b/packages/ra-ui-materialui/src/detail/Edit.js
@@ -90,8 +90,9 @@ const sanitizeRestProps = ({
     hasList,
     hasShow,
     id,
-    isLoading,
-    isSaving,
+    loading,
+    loaded,
+    saving,
     resource,
     title,
     version,

diff --git a/packages/ra-ui-materialui/src/detail/Show.js b/packages/ra-ui-materialui/src/detail/Show.js
@@ -88,7 +88,8 @@ const sanitizeRestProps = ({
     className,
     id,
     data,
-    isLoading,
+    loading,
+    loaded,
     resource,
     hasCreate,
     hasEdit,
@@ -114,7 +115,6 @@ export const ShowView = ({
     defaultTitle,
     hasEdit,
     hasList,
-    isLoading,
     record,
     resource,
     title,
@@ -184,7 +184,8 @@ ShowView.propTypes = {
     defaultTitle: PropTypes.any,
     hasEdit: PropTypes.bool,
     hasList: PropTypes.bool,
-    isLoading: PropTypes.bool,
+    loading: PropTypes.bool,
+    loaded: PropTypes.bool,
     record: PropTypes.object,
     resource: PropTypes.string,
     title: PropTypes.any,