@xh/hoist 75.0.0-SNAPSHOT.1749666833237 → 75.0.0-SNAPSHOT.1750963411217

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## v75.0.0-SNAPSHOT - unreleased
 
+### 🎁 New Features
+* Added props to `ViewManager` to customize icons used for different types of views, and modified
+  default icons for Global and Shared views.
+
 ## v74.0.0 - 2025-06-11
 
 ### 💥 Breaking Changes (upgrade difficulty: 🟢 LOW - minor changes to ViewManagerModel, ChartModel)

package/build/types/cmp/viewmanager/ViewInfo.d.ts

@@ -15,15 +15,19 @@ export declare class ViewInfo {
     readonly description: string;
     /** User owning this view. Null if the view is global.*/
     readonly owner: string;
-    /** Is the owner making this view accessible to others? Always true for global views. */
+    /**
+     * True if the owner (which can be the current user) has made this view accessible to all other
+     * users. Note always `false` for global views, to better distinguish the two sharing models.
+     */
     readonly isShared: boolean;
     /** True if this view is global and visible to all users. */
     readonly isGlobal: boolean;
     /** Optional group name used for bucketing this view in display. */
     readonly group: string;
     /**
-     * Should this view be pinned by users by default?
-     * This value is intended to be used for global views only.
+     * True if this view should be pinned by default to all users' menus, where it will appear
+     * unless the user has explicitly unpinned it. Only applicable for global views, can be enabled
+     * by view managers to promote especially important global views and ensure users see them.
      */
     readonly isDefaultPinned: boolean;
     /**

package/build/types/desktop/cmp/viewmanager/ViewManager.d.ts

@@ -1,26 +1,35 @@
 import { HoistProps } from '@xh/hoist/core';
 import { ViewManagerModel } from '@xh/hoist/cmp/viewmanager';
 import { ButtonProps } from '@xh/hoist/desktop/cmp/button';
+import { ReactElement } from 'react';
 import './ViewManager.scss';
-/**
- * Visibility options for save/revert button.
- *
- * 'never' to hide button.
- * 'whenDirty' to only show when persistence state is dirty and button is therefore enabled.
- * 'always' will always show button.
- */
-export type ViewManagerStateButtonMode = 'whenDirty' | 'always' | 'never';
 export interface ViewManagerProps extends HoistProps<ViewManagerModel> {
     menuButtonProps?: Partial<ButtonProps>;
     saveButtonProps?: Partial<ButtonProps>;
     revertButtonProps?: Partial<ButtonProps>;
+    /** Button icon when on the default (in-code state) view. Default `Icon.bookmark`. */
+    defaultViewIcon?: ReactElement;
+    /** Button icon when the selected view is owned by the current user. Default `Icon.bookmark`. */
+    ownedViewIcon?: ReactElement;
+    /** Button icon when the selected view is shared by another user. Default `Icon.users`. */
+    sharedViewIcon?: ReactElement;
+    /** Button icon when the selected view is globally shared. Default `Icon.globe`. */
+    globalViewIcon?: ReactElement;
     /** Default 'whenDirty' */
     showSaveButton?: ViewManagerStateButtonMode;
     /** Default 'never' */
     showRevertButton?: ViewManagerStateButtonMode;
-    /** Side the save and revert buttons should appear on (default 'right') */
+    /** Side relative to the menu on which save/revert buttons should render. Default 'right'. */
     buttonSide?: 'left' | 'right';
 }
+/**
+ * Visibility options for save/revert buttons inlined next to the ViewManager menu:
+ *      'never' to always hide - user must save/revert via menu.
+ *      'whenDirty' (default) to show only when view state is dirty and the button is enabled.
+ *      'always' to always show, including when view not dirty and the button is disabled.
+ *          Useful to avoid jumpiness in toolbar layouts.
+ */
+export type ViewManagerStateButtonMode = 'whenDirty' | 'always' | 'never';
 /**
  * Desktop ViewManager component - a button-based menu for saving and swapping between named
  * bundles of persisted component state (e.g. grid views, dashboards, and similar).

package/cmp/viewmanager/ViewInfo.ts

@@ -29,7 +29,10 @@ export class ViewInfo {
     /** User owning this view. Null if the view is global.*/
     readonly owner: string;
 
-    /** Is the owner making this view accessible to others? Always true for global views. */
+    /**
+     * True if the owner (which can be the current user) has made this view accessible to all other
+     * users. Note always `false` for global views, to better distinguish the two sharing models.
+     */
     readonly isShared: boolean;
 
     /** True if this view is global and visible to all users. */
@@ -39,8 +42,9 @@ export class ViewInfo {
     readonly group: string;
 
     /**
-     * Should this view be pinned by users by default?
-     * This value is intended to be used for global views only.
+     * True if this view should be pinned by default to all users' menus, where it will appear
+     * unless the user has explicitly unpinned it. Only applicable for global views, can be enabled
+     * by view managers to promote especially important global views and ensure users see them.
      */
     readonly isDefaultPinned: boolean;
 

package/desktop/cmp/viewmanager/ViewManager.ts

@@ -14,6 +14,7 @@ import {Icon} from '@xh/hoist/icon';
 import {popover} from '@xh/hoist/kit/blueprint';
 import {useOnVisibleChange} from '@xh/hoist/utils/react';
 import {startCase} from 'lodash';
+import {ReactElement} from 'react';
 import {viewMenu} from './ViewMenu';
 import {ViewManagerLocalModel} from './ViewManagerLocalModel';
 import {manageDialog} from './dialog/ManageDialog';
@@ -21,28 +22,37 @@ import {saveAsDialog} from './dialog/SaveAsDialog';
 
 import './ViewManager.scss';
 
-/**
- * Visibility options for save/revert button.
- *
- * 'never' to hide button.
- * 'whenDirty' to only show when persistence state is dirty and button is therefore enabled.
- * 'always' will always show button.
- */
-export type ViewManagerStateButtonMode = 'whenDirty' | 'always' | 'never';
-
 export interface ViewManagerProps extends HoistProps<ViewManagerModel> {
     menuButtonProps?: Partial<ButtonProps>;
     saveButtonProps?: Partial<ButtonProps>;
     revertButtonProps?: Partial<ButtonProps>;
 
+    /** Button icon when on the default (in-code state) view. Default `Icon.bookmark`. */
+    defaultViewIcon?: ReactElement;
+    /** Button icon when the selected view is owned by the current user. Default `Icon.bookmark`. */
+    ownedViewIcon?: ReactElement;
+    /** Button icon when the selected view is shared by another user. Default `Icon.users`. */
+    sharedViewIcon?: ReactElement;
+    /** Button icon when the selected view is globally shared. Default `Icon.globe`. */
+    globalViewIcon?: ReactElement;
+
     /** Default 'whenDirty' */
     showSaveButton?: ViewManagerStateButtonMode;
     /** Default 'never' */
     showRevertButton?: ViewManagerStateButtonMode;
-    /** Side the save and revert buttons should appear on (default 'right') */
+    /** Side relative to the menu on which save/revert buttons should render. Default 'right'. */
     buttonSide?: 'left' | 'right';
 }
 
+/**
+ * Visibility options for save/revert buttons inlined next to the ViewManager menu:
+ *      'never' to always hide - user must save/revert via menu.
+ *      'whenDirty' (default) to show only when view state is dirty and the button is enabled.
+ *      'always' to always show, including when view not dirty and the button is disabled.
+ *          Useful to avoid jumpiness in toolbar layouts.
+ */
+export type ViewManagerStateButtonMode = 'whenDirty' | 'always' | 'never';
+
 /**
  * Desktop ViewManager component - a button-based menu for saving and swapping between named
  * bundles of persisted component state (e.g. grid views, dashboards, and similar).
@@ -60,6 +70,10 @@ export const [ViewManager, viewManager] = hoistCmp.withFactory<ViewManagerProps>
         menuButtonProps,
         saveButtonProps,
         revertButtonProps,
+        defaultViewIcon = Icon.bookmark(),
+        ownedViewIcon = Icon.bookmark(),
+        sharedViewIcon = Icon.users(),
+        globalViewIcon = Icon.globe(),
         showSaveButton = 'whenDirty',
         showRevertButton = 'never',
         buttonSide = 'right'
@@ -70,7 +84,17 @@ export const [ViewManager, viewManager] = hoistCmp.withFactory<ViewManagerProps>
             revert = revertButton({model: locModel, mode: showRevertButton, ...revertButtonProps}),
             menu = popover({
                 disabled: !locModel.isVisible, // Prevent orphaned popover menu
-                item: menuButton({model: locModel, ...menuButtonProps}),
+                item: menuButton({
+                    model: locModel,
+                    icon: buttonIcon({
+                        model: locModel,
+                        defaultViewIcon,
+                        ownedViewIcon,
+                        sharedViewIcon,
+                        globalViewIcon
+                    }),
+                    ...menuButtonProps
+                }),
                 content: loadModel.isPending
                     ? box({
                           item: spinner({compact: true}),
@@ -97,13 +121,13 @@ export const [ViewManager, viewManager] = hoistCmp.withFactory<ViewManagerProps>
 });
 
 const menuButton = hoistCmp.factory<ViewManagerLocalModel>({
-    render({model, ...rest}) {
+    render({model, icon, ...rest}) {
         const {view, typeDisplayName, isLoading} = model.parent;
         return button({
             className: 'xh-view-manager__menu-button',
             text: view.isDefault ? `Default ${startCase(typeDisplayName)}` : view.name,
             icon: !isLoading
-                ? Icon.bookmark()
+                ? icon
                 : box({
                       item: spinner({width: 13, height: 13, style: {margin: 'auto'}}),
                       width: 16.25
@@ -115,6 +139,16 @@ const menuButton = hoistCmp.factory<ViewManagerLocalModel>({
     }
 });
 
+const buttonIcon = hoistCmp.factory<ViewManagerLocalModel>({
+    render({model, ownedViewIcon, sharedViewIcon, globalViewIcon, defaultViewIcon}) {
+        const {view} = model.parent;
+        if (view.isOwned) return ownedViewIcon;
+        if (view.isShared) return sharedViewIcon;
+        if (view.isGlobal) return globalViewIcon;
+        return defaultViewIcon;
+    }
+});
+
 const saveButton = hoistCmp.factory<ViewManagerLocalModel>({
     render({model, mode, ...rest}) {
         if (hideStateButton(model, mode)) return null;

package/package.json

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