[WC-3035]: Gallery refresh indicator

packages/modules/data-widgets/src/themesource/datawidgets/web/_datagrid.scss

@@ -429,86 +429,6 @@ $root: ".widget-datagrid";
         display: contents;
     }
 
-    &-refresh-container {
-        grid-column: 1 / -1;
-        padding: 0;
-        position: relative;
-    }
-
-    &-refresh-indicator {
-        -webkit-appearance: none;
-        -moz-appearance: none;
-        appearance: none;
-        background-color: var(--border-color-default, #ced0d3);
-        border: none;
-        border-radius: 2px;
-        color: var(--brand-primary, $dg-brand-primary);
-        height: 4px;
-        width: 100%;
-        position: absolute;
-        left: 0;
-        right: 0;
-
-        &::-webkit-progress-bar {
-            background-color: transparent;
-        }
-
-        &::-webkit-progress-value {
-            background-color: currentColor;
-            transition: all 0.2s;
-        }
-
-        &::-moz-progress-bar {
-            background-color: currentColor;
-            transition: all 0.2s;
-        }
-
-        &::-ms-fill {
-            border: none;
-            background-color: currentColor;
-            transition: all 0.2s;
-        }
-
-        &:indeterminate {
-            background-size: 200% 100%;
-            background-image: linear-gradient(
-                to right,
-                transparent 50%,
-                currentColor 50%,
-                currentColor 60%,
-                transparent 60%,
-                transparent 71.5%,
-                currentColor 71.5%,
-                currentColor 84%,
-                transparent 84%
-            );
-            animation: progress-linear 3s infinite linear;
-        }
-
-        &:indeterminate::-moz-progress-bar {
-            background-color: transparent;
-        }
-
-        &:indeterminate::-ms-fill {
-            animation-name: none;
-        }
-
-        @keyframes progress-linear {
-            0% {
-                background-size: 200% 100%;
-                background-position: left -31.25% top 0%;
-            }
-            50% {
-                background-size: 800% 100%;
-                background-position: left -49% top 0%;
-            }
-            100% {
-                background-size: 400% 100%;
-                background-position: left -102% top 0%;
-            }
-        }
-    }
-
     &.widget-datagrid-selection-method-click {
         .tr.tr-selected .td {
             background-color: $dg-grid-selected-row-background;

packages/modules/data-widgets/src/themesource/datawidgets/web/_refresh-indicator.scss

@@ -0,0 +1,83 @@
+.mx-refresh-container {
+    grid-column: 1 / -1;
+    padding: 0;
+    position: relative;
+
+    &-padding {
+        padding: var(--spacing-small) 0;
+    }
+}
+
+.mx-refresh-indicator {
+    -webkit-appearance: none;
+    -moz-appearance: none;
+    appearance: none;
+    background-color: var(--border-color-default, #ced0d3);
+    border: none;
+    border-radius: 2px;
+    color: var(--brand-primary, $dg-brand-primary);
+    height: 4px;
+    width: 100%;
+    position: absolute;
+    left: 0;
+    right: 0;
+
+    &::-webkit-progress-bar {
+        background-color: transparent;
+    }
+
+    &::-webkit-progress-value {
+        background-color: currentColor;
+        transition: all 0.2s;
+    }
+
+    &::-moz-progress-bar {
+        background-color: currentColor;
+        transition: all 0.2s;
+    }
+
+    &::-ms-fill {
+        border: none;
+        background-color: currentColor;
+        transition: all 0.2s;
+    }
+
+    &:indeterminate {
+        background-size: 200% 100%;
+        background-image: linear-gradient(
+            to right,
+            transparent 50%,
+            currentColor 50%,
+            currentColor 60%,
+            transparent 60%,
+            transparent 71.5%,
+            currentColor 71.5%,
+            currentColor 84%,
+            transparent 84%
+        );
+        animation: progress-linear 3s infinite linear;
+    }
+
+    &:indeterminate::-moz-progress-bar {
+        background-color: transparent;
+    }
+
+    &:indeterminate::-ms-fill {
+        animation-name: none;
+    }
+
+    @keyframes progress-linear {
+        0% {
+            background-size: 200% 100%;
+            background-position: left -31.25% top 0%;
+        }
+        50% {
+            background-size: 800% 100%;
+            background-position: left -49% top 0%;
+        }
+        100% {
+            background-size: 400% 100%;
+            background-position: left -102% top 0%;
+        }
+    }
+}

packages/modules/data-widgets/src/themesource/datawidgets/web/main.scss

@@ -6,6 +6,7 @@
 @import "drop-down-sort";
 @import "gallery";
 @import "gallery-design-properties";
+@import "refresh-indicator";
 @import "three-state-checkbox";
 @import "tree-node";
 @import "tree-node-design-properties";

packages/pluggableWidgets/datagrid-web/src/components/Widget.tsx

@@ -1,3 +1,4 @@
+import { RefreshIndicator } from "@mendix/widget-plugin-component-kit/RefreshIndicator";
 import { Pagination } from "@mendix/widget-plugin-grid/components/Pagination";
 import { SelectionStatus } from "@mendix/widget-plugin-grid/selection";
 import classNames from "classnames";
@@ -25,7 +26,6 @@ import { FocusTargetController } from "@mendix/widget-plugin-grid/keyboard-navig
 import { observer } from "mobx-react-lite";
 import { RowsRenderer } from "./RowsRenderer";
 import { GridHeader } from "./GridHeader";
-import { RefreshIndicator } from "./RefreshIndicator";
 
 export interface WidgetProps<C extends GridColumn, T extends ObjectItem = ObjectItem> {
     CellComponent: CellComponent<C>;

packages/pluggableWidgets/gallery-web/src/Gallery.editorPreview.tsx

@@ -104,6 +104,7 @@ function Preview(props: GalleryPreviewProps): ReactElement {
             itemEventsController={itemEventsController}
             focusController={focusController}
             getPosition={getPositionCallback}
+            showRefreshIndicator={false}
             preview
         />
     );

packages/pluggableWidgets/gallery-web/src/Gallery.tsx

@@ -91,6 +91,7 @@ const Container = observer(function GalleryContainer(props: GalleryContainerProp
             focusController={focusController}
             getPosition={getPositionCallback}
             loadMoreButtonCaption={props.loadMoreButtonCaption?.value}
+            showRefreshIndicator={rootStore.loaderCtrl.showRefreshIndicator}
         />
     );
 });

packages/pluggableWidgets/gallery-web/src/Gallery.xml

@@ -37,6 +37,10 @@
                     <caption>Content placeholder</caption>
                     <description />
                 </property>
+                <property key="refreshIndicator" type="boolean" defaultValue="false">
+                    <caption>Show refresh indicator</caption>
+                    <description>Show a refresh indicator when the data is being loaded.</description>
+                </property>
             </propertyGroup>
             <propertyGroup caption="Columns">
                 <property key="desktopItems" type="integer" defaultValue="1">

packages/pluggableWidgets/gallery-web/src/components/Gallery.tsx

@@ -1,3 +1,4 @@
+import { RefreshIndicator } from "@mendix/widget-plugin-component-kit/RefreshIndicator";
 import { Pagination } from "@mendix/widget-plugin-grid/components/Pagination";
 import { KeyNavProvider } from "@mendix/widget-plugin-grid/keyboard-navigation/context";
 import { FocusTargetController } from "@mendix/widget-plugin-grid/keyboard-navigation/FocusTargetController";
@@ -51,6 +52,7 @@ export interface GalleryProps<T extends ObjectItem> {
     selectHelper: SelectActionHandler;
     getPosition: (index: number) => PositionInGrid;
     loadMoreButtonCaption?: string;
+    showRefreshIndicator: boolean;
 }
 
 export function Gallery<T extends ObjectItem>(props: GalleryProps<T>): ReactElement {
@@ -86,6 +88,7 @@ export function Gallery<T extends ObjectItem>(props: GalleryProps<T>): ReactElem
         >
             <GalleryTopBar>{showTopPagination && pagination}</GalleryTopBar>
             {props.showHeader && <GalleryHeader aria-label={props.headerTitle}>{props.header}</GalleryHeader>}
+            {props.showRefreshIndicator ? <RefreshIndicator className="mx-refresh-container-padding" /> : null}
             <GalleryContent
                 hasMoreItems={props.hasMoreItems}
                 setPage={props.setPage}

packages/pluggableWidgets/gallery-web/src/controllers/DerivedLoaderController.ts

@@ -0,0 +1,23 @@
+import { DatasourceController } from "@mendix/widget-plugin-grid/query/DatasourceController";
+import { makeObservable, computed } from "mobx";
+
+export class DerivedLoaderController {
+    constructor(
+        private datasourceController: DatasourceController,
+        private refreshIndicator: boolean
+    ) {
+        makeObservable(this, {
+            isRefreshing: computed,
+            showRefreshIndicator: computed
+        });
+    }
+
+    get isRefreshing(): boolean {
+        const { isSilentRefresh, isRefreshing } = this.datasourceController;
+        return !isSilentRefresh && isRefreshing;
+    }
+
+    get showRefreshIndicator(): boolean {
+        return this.refreshIndicator && this.isRefreshing;
+    }
+}

packages/pluggableWidgets/gallery-web/src/stores/GalleryStore.ts

@@ -11,6 +11,7 @@ import { SortAPI } from "@mendix/widget-plugin-sorting/react/context";
 import { SortStoreHost } from "@mendix/widget-plugin-sorting/stores/SortStoreHost";
 import { EditableValue, ListValue } from "mendix";
 import { PaginationEnum, StateStorageTypeEnum } from "../../typings/GalleryProps";
+import { DerivedLoaderController } from "../controllers/DerivedLoaderController";
 import { QueryParamsController } from "../controllers/QueryParamsController";
 import { ObservableStorage } from "../typings/storage";
 import { AttributeStorage } from "./AttributeStorage";
@@ -31,6 +32,7 @@ interface StaticProps {
     stateStorageType: StateStorageTypeEnum;
     storeFilters: boolean;
     storeSort: boolean;
+    refreshIndicator: boolean;
 }
 
 export type GalleryPropsGate = DerivedPropsGate<DynamicProps>;
@@ -50,6 +52,7 @@ export class GalleryStore extends BaseControllerHost {
     readonly paging: PaginationController;
     readonly filterAPI: FilterAPI;
     readonly sortAPI: SortAPI;
+    loaderCtrl: DerivedLoaderController;
 
     constructor(spec: GalleryStoreSpec) {
         super();
@@ -86,6 +89,8 @@ export class GalleryStore extends BaseControllerHost {
             host: this._sortHost
         };
 
+        this.loaderCtrl = new DerivedLoaderController(this._query, spec.refreshIndicator);
+
         new RefreshController(this, {
             delay: 0,
             query: this._query.derivedQuery

packages/pluggableWidgets/gallery-web/src/utils/test-utils.tsx

@@ -55,7 +55,8 @@ export function createMockGalleryContext(): GalleryRootScope {
         onClickTrigger: "single",
         stateStorageType: "localStorage",
         storeFilters: false,
-        storeSort: false
+        storeSort: false,
+        refreshIndicator: false
     };
 
     // Create a proper gate provider and gate
@@ -72,7 +73,8 @@ export function createMockGalleryContext(): GalleryRootScope {
         pageSize: 10,
         stateStorageType: "localStorage",
         storeFilters: false,
-        storeSort: false
+        storeSort: false,
+        refreshIndicator: false
     });
 
     const mockSelectHelper = new SelectActionHandler("None", undefined);
@@ -148,6 +150,7 @@ export function mockProps(params: Helpers & Mocks = {}): GalleryProps<ObjectItem
         header: <input />,
         itemEventsController,
         focusController,
-        getPosition: (index: number) => getColumnAndRowBasedOnIndex(3, 3, index)
+        getPosition: (index: number) => getColumnAndRowBasedOnIndex(3, 3, index),
+        showRefreshIndicator: false
     };
 }

packages/pluggableWidgets/gallery-web/typings/GalleryProps.d.ts

@@ -30,6 +30,7 @@ export interface GalleryContainerProps {
     itemSelection?: SelectionSingleValue | SelectionMultiValue;
     itemSelectionMode: ItemSelectionModeEnum;
     content?: ListWidgetValue;
+    refreshIndicator: boolean;
     desktopItems: number;
     tabletItems: number;
     phoneItems: number;
@@ -71,6 +72,7 @@ export interface GalleryPreviewProps {
     itemSelection: "None" | "Single" | "Multi";
     itemSelectionMode: ItemSelectionModeEnum;
     content: { widgetCount: number; renderer: ComponentType<{ children: ReactNode; caption?: string }> };
+    refreshIndicator: boolean;
     desktopItems: number | null;
     tabletItems: number | null;
     phoneItems: number | null;

packages/shared/widget-plugin-component-kit/src/RefreshIndicator.tsx

@@ -0,0 +1,16 @@
+import classNames from "classnames";
+import { createElement, ReactElement } from "react";
+
+type RefreshIndicatorProps = {
+    className?: string;
+};
+
+export function RefreshIndicator({ className }: RefreshIndicatorProps): ReactElement {
+    return (
+        <div className="tr" role="row">
+            <div className={classNames("th mx-refresh-container", className)}>
+                <progress className="mx-refresh-indicator" />
+            </div>
+        </div>
+    );
+}