@xh/hoist 69.0.0-SNAPSHOT.1728424290087 → 69.0.0-SNAPSHOT.1728431598764

package/CHANGELOG.md

@@ -11,6 +11,7 @@ is not expected to affect any applications.
 * Added new AppStates `AUTHENTICATING`, `INITIALIZING_HOIST`, and `INITIALIZING_APP` to support
 more granular tracking and timing of app startup lifecycle.
 * Improved the default "Loaded App" activity tracking entry with more granular data on load timing.
+* `RestGrid` now displays an optional refresh button in its toolbar.
 
 ### ⚙️ Technical
 

package/admin/tabs/cluster/logs/levels/LogLevelDialogModel.ts

@@ -48,6 +48,7 @@ export class LogLevelDialogModel extends HoistModel {
             enableExport: true,
             exportOptions: {filename: exportFilenameWithDate('log-levels')},
             readonly: AppModel.readonly,
+            showRefreshButton: true,
             store: {
                 url: 'rest/logLevelAdmin',
                 fieldDefaults: {disableXssProtection: true},

package/admin/tabs/userData/prefs/editor/PrefEditorModel.ts

@@ -43,6 +43,7 @@ export class PrefEditorModel extends HoistModel {
             enableExport: true,
             exportOptions: {filename: exportFilenameWithDate('prefs')},
             selModel: 'multiple',
+            showRefreshButton: true,
             store: {
                 url: 'rest/preferenceAdmin',
                 reloadLookupsOnLoad: true,

package/build/types/desktop/cmp/rest/RestGridModel.d.ts

@@ -18,7 +18,9 @@ export interface RestGridConfig extends GridConfig {
     menuActions?: Array<RecordAction | RecordActionSpec | '-'>;
     /** Actions to display in the form toolbar. Defaults to delete. */
     formActions?: Array<RecordAction | RecordActionSpec>;
-    /** Warning to display before actions on a selection of  records. */
+    /** Show a refresh button in the toolbar. Defaults to false. **/
+    showRefreshButton?: boolean;
+    /** Warning to display before actions on a selection of records. */
     actionWarning?: {
         add?: string | ((recs: StoreRecord[]) => string);
         del?: string | ((recs: StoreRecord[]) => string);
@@ -70,6 +72,7 @@ export declare class RestGridModel extends HoistModel {
     toolbarActions: Array<RecordAction | RecordActionSpec>;
     menuActions: Array<RecordAction | RecordActionSpec | '-'>;
     formActions: Array<RecordAction | RecordActionSpec>;
+    showRefreshButton: boolean;
     prepareCloneFn: (input: {
         record: StoreRecord;
         clone: PlainObject;
@@ -83,7 +86,7 @@ export declare class RestGridModel extends HoistModel {
     get selModel(): import("@xh/hoist/data").StoreSelectionModel;
     get selectedRecords(): StoreRecord[];
     get selectedRecord(): StoreRecord;
-    constructor({ readonly, toolbarActions, menuActions, formActions, actionWarning, prepareCloneFn, unit, filterFields, editors, onRowDoubleClicked, store, appData, ...rest }: RestGridConfig);
+    constructor({ readonly, toolbarActions, menuActions, formActions, showRefreshButton, actionWarning, prepareCloneFn, unit, filterFields, editors, onRowDoubleClicked, store, appData, ...rest }: RestGridConfig);
     /** Load the underlying store. */
     doLoadAsync(loadSpec: any): Promise<void>;
     /** Load the underlying store. */

package/desktop/cmp/rest/RestGridModel.ts

@@ -34,7 +34,10 @@ export interface RestGridConfig extends GridConfig {
     /** Actions to display in the form toolbar. Defaults to delete. */
     formActions?: Array<RecordAction | RecordActionSpec>;
 
-    /** Warning to display before actions on a selection of  records. */
+    /** Show a refresh button in the toolbar. Defaults to false. **/
+    showRefreshButton?: boolean;
+
+    /** Warning to display before actions on a selection of records. */
     actionWarning?: {
         add?: string | ((recs: StoreRecord[]) => string);
         del?: string | ((recs: StoreRecord[]) => string);
@@ -97,6 +100,7 @@ export class RestGridModel extends HoistModel {
     toolbarActions: Array<RecordAction | RecordActionSpec>;
     menuActions: Array<RecordAction | RecordActionSpec | '-'>;
     formActions: Array<RecordAction | RecordActionSpec>;
+    showRefreshButton: boolean;
     prepareCloneFn: (input: {record: StoreRecord; clone: PlainObject}) => void;
     unit: string;
     filterFields: string[] = null;
@@ -133,6 +137,7 @@ export class RestGridModel extends HoistModel {
         toolbarActions = !readonly ? [addAction, editAction, deleteAction] : [viewAction],
         menuActions = !readonly ? [addAction, editAction, deleteAction] : [viewAction],
         formActions = !readonly ? [deleteAction] : [],
+        showRefreshButton = false,
         actionWarning,
         prepareCloneFn,
         unit = 'record',
@@ -149,6 +154,7 @@ export class RestGridModel extends HoistModel {
         this.toolbarActions = toolbarActions;
         this.menuActions = menuActions;
         this.formActions = formActions;
+        this.showRefreshButton = showRefreshButton;
 
         this.actionWarning = Object.assign(this.actionWarning, actionWarning);
 

package/desktop/cmp/rest/impl/RestGridToolbar.ts

@@ -54,7 +54,10 @@ export const restGridToolbar = hoistCmp.factory({
                 gridModel,
                 omit: !model.gridModel.enableExport
             }),
-            refreshButton({model})
+            refreshButton({
+                model,
+                omit: !model.showRefreshButton
+            })
         );
     }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "69.0.0-SNAPSHOT.1728424290087",
+  "version": "69.0.0-SNAPSHOT.1728431598764",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",