@xh/hoist 75.0.0-SNAPSHOT.1753490062755 → 75.0.0-SNAPSHOT.1753720955374

package/CHANGELOG.md

@@ -21,6 +21,8 @@
 * Deprecated the `RelativeTimestamp.options` prop - all the same options are now top-level props.
 * Added new `GroupingChooserModel.sortDimensions` config. Set to `false` to respect the order in
   which `dimensions` are provided to the model.
+* Added new `ClipboardButton.errorMessage` prop to customize or suppress a toast alert if the copy
+  operation fails. Set to `false` to fail silently (the behavior prior to this change).
 
 ### 🐞 Bug Fixes
 

package/build/types/desktop/cmp/clipboard/ClipboardButton.d.ts

@@ -3,8 +3,16 @@ import '@xh/hoist/desktop/register';
 export interface ClipboardButtonProps extends ButtonProps {
     /** Function returning the text to copy. May be async. */
     getCopyText: () => string | Promise<string>;
-    /** Message to be displayed in a toast when copy is complete. */
-    successMessage?: string;
+    /**
+     * Message to be displayed in a toast should the copy operation fail, or `true` (default) to
+     * show a toast-based alert from `XH.handleException`. Spec `false` to fail silently.
+     */
+    errorMessage?: string | boolean;
+    /**
+     * Message to be displayed in a toast when copy is complete, or `true` for a default success
+     * confirmation. Default `false`
+     */
+    successMessage?: string | boolean;
 }
 /**
  * Button to copy text to the clipboard.

package/desktop/cmp/clipboard/ClipboardButton.ts

@@ -10,12 +10,23 @@ import '@xh/hoist/desktop/register';
 import {Icon} from '@xh/hoist/icon';
 import {withDefault} from '@xh/hoist/utils/js';
 import copy from 'clipboard-copy';
+import {isString} from 'lodash';
 
 export interface ClipboardButtonProps extends ButtonProps {
     /** Function returning the text to copy. May be async. */
     getCopyText: () => string | Promise<string>;
-    /** Message to be displayed in a toast when copy is complete. */
-    successMessage?: string;
+
+    /**
+     * Message to be displayed in a toast should the copy operation fail, or `true` (default) to
+     * show a toast-based alert from `XH.handleException`. Spec `false` to fail silently.
+     */
+    errorMessage?: string | boolean;
+
+    /**
+     * Message to be displayed in a toast when copy is complete, or `true` for a default success
+     * confirmation. Default `false`
+     */
+    successMessage?: string | boolean;
 }
 
 /**
@@ -24,24 +35,36 @@ export interface ClipboardButtonProps extends ButtonProps {
 export const [ClipboardButton, clipboardButton] = hoistCmp.withFactory<ClipboardButtonProps>({
     displayName: 'ClipboardButton',
     model: false,
+
     render(props) {
-        let {icon, onClick, text, getCopyText, successMessage, ...rest} = props;
+        let {icon, onClick, text, getCopyText, errorMessage, successMessage, ...rest} = props;
+        let errMsg = withDefault(errorMessage, true),
+            successMsg = withDefault(successMessage, false);
 
         if (!onClick) {
             onClick = async () => {
-                const {successMessage, getCopyText} = props;
-
                 try {
-                    const text = await getCopyText();
-                    await copy(text);
-                    if (successMessage) {
+                    const copyText = await getCopyText();
+                    await copy(copyText);
+                    if (successMsg) {
+                        successMsg = isString(successMsg) ? successMsg : 'Copied to clipboard';
                         XH.toast({
-                            message: successMessage,
-                            icon: Icon.clipboard()
+                            icon: Icon.clipboard(),
+                            message: successMsg
                         });
                     }
                 } catch (e) {
-                    XH.handleException(e, {showAlert: false});
+                    if (errMsg) {
+                        errMsg = isString(errMsg) ? errMsg : 'Error copying to clipboard';
+                        XH.dangerToast({
+                            icon: Icon.clipboard(),
+                            message: errMsg
+                        });
+                    }
+                    XH.handleException(e, {
+                        message: 'Error copying to clipboard',
+                        showAlert: false
+                    });
                 }
             };
         }

package/package.json

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