@kwiz/fluentui 1.0.185 → 1.0.186
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/helpers/block-nav.d.ts +2 -1
- package/dist/helpers/block-nav.js +4 -7
- package/dist/helpers/block-nav.js.map +1 -1
- package/dist/helpers/use-track-changes.d.ts +10 -3
- package/dist/helpers/use-track-changes.js +17 -5
- package/dist/helpers/use-track-changes.js.map +1 -1
- package/package.json +1 -1
|
@@ -3,7 +3,8 @@ export interface iBlockNav {
|
|
|
3
3
|
onNav: (nav: () => void) => void;
|
|
4
4
|
navPrompt?: JSX.Element;
|
|
5
5
|
}
|
|
6
|
-
/**
|
|
6
|
+
/** @deprecated replace with useTrackChanges
|
|
7
|
+
* set block message if you want to block nav.
|
|
7
8
|
* - call setMessage to add a blocker message
|
|
8
9
|
* - call onNav when you have internal navigation (open / close popups)
|
|
9
10
|
* - render the navPrompt control to your page
|
|
@@ -3,12 +3,14 @@ import { isNotEmptyArray, isNullOrEmptyString, jsonClone, objectsEqual } from "@
|
|
|
3
3
|
import { useCallback, useEffect } from "react";
|
|
4
4
|
import { Prompter } from "../controls/prompt";
|
|
5
5
|
import { useEffectOnlyOnMount, useStateEX } from "./hooks";
|
|
6
|
-
/**
|
|
6
|
+
/** @deprecated replace with useTrackChanges
|
|
7
|
+
* set block message if you want to block nav.
|
|
7
8
|
* - call setMessage to add a blocker message
|
|
8
9
|
* - call onNav when you have internal navigation (open / close popups)
|
|
9
10
|
* - render the navPrompt control to your page
|
|
10
11
|
* FYI for page unload, most modern browsers won't show your message but a generic one instead. */
|
|
11
12
|
export function useBlockNav() {
|
|
13
|
+
//todo: once we remove this and replace it with useTrackChanges keep this only for the window unload event registration
|
|
12
14
|
const [, setBlockNavMessages, blockNavMessagesRef] = useStateEX({});
|
|
13
15
|
const [_prompt, setPrompt] = useStateEX(null);
|
|
14
16
|
const getMessagesArr = useCallback(() => {
|
|
@@ -44,7 +46,7 @@ export function useBlockNav() {
|
|
|
44
46
|
}, useEffectOnlyOnMount);
|
|
45
47
|
useEffect(() => {
|
|
46
48
|
function handleBeforeUnload(e) {
|
|
47
|
-
//
|
|
49
|
+
//using blockMessageRef.current so that we don't have to re-register every time message changes.
|
|
48
50
|
//otherwise we would have to add blockMessage as a dependency for this useEffect
|
|
49
51
|
const message = getMessages();
|
|
50
52
|
if (!isNullOrEmptyString(message)) {
|
|
@@ -67,11 +69,6 @@ export function useBlockNav() {
|
|
|
67
69
|
if (!objectsEqual(current, blockNavMessagesRef.current))
|
|
68
70
|
setBlockNavMessages(current);
|
|
69
71
|
},
|
|
70
|
-
// clearMessages: () => {
|
|
71
|
-
// setBlockNavMessages({});
|
|
72
|
-
// },
|
|
73
|
-
// getMessages,
|
|
74
|
-
// getMessagesArr,
|
|
75
72
|
/** single page applications, call this to navigate if ok */
|
|
76
73
|
onNav,
|
|
77
74
|
navPrompt: _prompt ? _jsx(Prompter, Object.assign({}, _prompt)) : undefined
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"block-nav.js","sourceRoot":"","sources":["../../src/helpers/block-nav.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAe,eAAe,EAAE,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC1G,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAkB,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAQ3D
|
|
1
|
+
{"version":3,"file":"block-nav.js","sourceRoot":"","sources":["../../src/helpers/block-nav.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAe,eAAe,EAAE,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC1G,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAkB,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAQ3D;;;;;kGAKkG;AAClG,MAAM,UAAU,WAAW;IACvB,uHAAuH;IACvH,MAAM,CAAC,EAAE,mBAAmB,EAAE,mBAAmB,CAAC,GAAG,UAAU,CAAsB,EAAE,CAAC,CAAC;IACzF,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,UAAU,CAAiB,IAAI,CAAC,CAAC;IAE9D,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE;QACpC,OAAO,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAEzB,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACjC,OAAO,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAEzB,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,GAAe,EAAE,EAAE;QAC1C,IAAI,QAAQ,GAAG,cAAc,EAAE,CAAC;QAChC,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,+CAA+C;YAC/C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBACnB,yCAAyC;gBACzC,SAAS,CAAC;oBACN,YAAY,EAAE,OAAO;oBACrB,gBAAgB,EAAE,QAAQ;oBAC1B,KAAK,EAAE,aAAa;oBACpB,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC;wBACzB,CAAC,CAAC,uBACG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,uBAAmB,CAAC,IAAX,IAAI,CAAC,EAAE,CAAU,CAAC,GAClD;wBACL,CAAC,CAAC,sBAAI,QAAQ,CAAC,CAAC,CAAC,GAAK;oBAC1B,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC/B,IAAI,EAAE,GAAG,EAAE;wBACP,SAAS,CAAC,IAAI,CAAC,CAAC;wBAChB,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAA,gBAAgB;wBACxC,GAAG,EAAE,CAAC;oBACV,CAAC;iBACJ,CAAC,CAAC;YACP,CAAC,EAAE,CAAC,CAAC,CAAC;QACV,CAAC;;YACI,GAAG,EAAE,CAAC;IACf,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAGzB,SAAS,CAAC,GAAG,EAAE;QACX,SAAS,kBAAkB,CAAC,CAAoB;YAC5C,gGAAgG;YAChG,gFAAgF;YAChF,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC;YAC9B,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChC,CAAC,CAAC,cAAc,EAAE,CAAC;gBACnB,CAAC,CAAC,WAAW,GAAG,OAAO,CAAC;YAC5B,CAAC;QACL,CAAC;QACD,qBAAqB;QACrB,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC5D,mCAAmC;QACnC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAChF,CAAC,EAAE,oBAAoB,CAAC,CAAC;IACzB,OAAO;QACH,UAAU,EAAE,CAAC,EAAU,EAAE,OAAgB,EAAE,EAAE;YACzC,IAAI,OAAO,GAAG,SAAS,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YACrD,IAAI,mBAAmB,CAAC,OAAO,CAAC;gBAC5B,OAAO,OAAO,CAAC,EAAE,CAAC,CAAC;;gBAClB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;YAC3B,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;gBACnD,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,4DAA4D;QAC5D,KAAK;QACL,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,KAAC,QAAQ,oBAAK,OAAO,EAAI,CAAC,CAAC,CAAC,SAAS;KAC7D,CAAC;AACN,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { MutableRefObject } from "react";
|
|
2
|
+
import { iPleaseWaitProps } from "../controls/please-wait";
|
|
2
3
|
export interface iTrackChanges {
|
|
3
4
|
hasChanges: boolean;
|
|
4
5
|
hasChangesRef: MutableRefObject<boolean>;
|
|
@@ -6,11 +7,15 @@ export interface iTrackChanges {
|
|
|
6
7
|
onSaveChanges: (worker: () => Promise<{
|
|
7
8
|
success: boolean;
|
|
8
9
|
message?: string;
|
|
9
|
-
}
|
|
10
|
+
}>, props?: {
|
|
11
|
+
waitProps?: iPleaseWaitProps;
|
|
12
|
+
}) => Promise<void>;
|
|
10
13
|
/** if there are changes, prompt the user. otherwise just call handler. */
|
|
11
14
|
doIfNoChanges: <ReturnType>(handler: () => ReturnType) => ReturnType;
|
|
12
15
|
}
|
|
13
|
-
export declare function useTrackChanges(
|
|
16
|
+
export declare function useTrackChanges({ blockNav }?: {
|
|
17
|
+
blockNav?: boolean;
|
|
18
|
+
}): {
|
|
14
19
|
trackChanges: iTrackChanges;
|
|
15
20
|
/** include in your react control */
|
|
16
21
|
trackChangesElement: JSX.Element;
|
|
@@ -24,7 +29,9 @@ export declare function useEditableControl(): {
|
|
|
24
29
|
onSaveChanges: (worker: () => Promise<{
|
|
25
30
|
success: boolean;
|
|
26
31
|
message?: string;
|
|
27
|
-
}
|
|
32
|
+
}>, props?: {
|
|
33
|
+
waitProps?: iPleaseWaitProps;
|
|
34
|
+
}) => Promise<void>;
|
|
28
35
|
/** if there are changes, prompt the user. otherwise just call handler. */
|
|
29
36
|
doIfNoChanges: <ReturnType>(handler: () => ReturnType) => ReturnType;
|
|
30
37
|
};
|
|
@@ -12,17 +12,27 @@ import { Toast, Toaster, ToastTitle, useId, useToastController } from "@fluentui
|
|
|
12
12
|
import { GetError, isBoolean } from "@kwiz/common";
|
|
13
13
|
import { useCallback, useState } from "react";
|
|
14
14
|
import { PleaseWait } from "../controls/please-wait";
|
|
15
|
+
import { useBlockNav } from "./block-nav";
|
|
15
16
|
import { useEffectOnlyOnMount, useStateEX } from "./hooks";
|
|
16
17
|
import { useAlerts } from "./use-alerts";
|
|
17
18
|
/* Provides useful helpers for tracking if control has changes, and handling the save changes with progress bar and on success/fail messages. */
|
|
18
|
-
export function useTrackChanges() {
|
|
19
|
+
export function useTrackChanges({ blockNav } = {}) {
|
|
20
|
+
//todo: translate
|
|
21
|
+
const unsavedChangesPrompt = "You will lose unsaved changes. Continue?";
|
|
19
22
|
const alerts = useAlerts();
|
|
20
23
|
const [showProgress, setShowProgress] = useState(false);
|
|
21
|
-
|
|
24
|
+
//we just need it to register the window unload event... no need for its element or onNav we handle it in this element.
|
|
25
|
+
const navBlockData = useBlockNav();
|
|
26
|
+
const [hasChanges, setHasChanges, hasChangesRef] = useStateEX(false, {
|
|
27
|
+
name: "hasChanges", skipUpdateIfSame: true, onChange: newValue => {
|
|
28
|
+
navBlockData.setMessage("useTrackChanges", (blockNav && newValue === true) ? unsavedChangesPrompt : undefined);
|
|
29
|
+
return newValue;
|
|
30
|
+
}
|
|
31
|
+
});
|
|
22
32
|
const toasterId = useId("toaster");
|
|
23
33
|
const { dispatchToast } = useToastController(toasterId);
|
|
24
|
-
const onSaveChanges = useCallback((worker) => __awaiter(this, void 0, void 0, function* () {
|
|
25
|
-
setShowProgress(true);
|
|
34
|
+
const onSaveChanges = useCallback((worker, props) => __awaiter(this, void 0, void 0, function* () {
|
|
35
|
+
setShowProgress((props === null || props === void 0 ? void 0 : props.waitProps) || true);
|
|
26
36
|
let success;
|
|
27
37
|
try {
|
|
28
38
|
success = yield worker();
|
|
@@ -32,16 +42,18 @@ export function useTrackChanges() {
|
|
|
32
42
|
}
|
|
33
43
|
setShowProgress(false);
|
|
34
44
|
if (success.success !== true) {
|
|
45
|
+
//todo: translate
|
|
35
46
|
dispatchToast(_jsx(Toast, { children: _jsx(ToastTitle, { children: success.message || "Could not save your changes." }) }), { intent: "warning", timeout: 10000 });
|
|
36
47
|
}
|
|
37
48
|
else {
|
|
38
49
|
setHasChanges(false);
|
|
50
|
+
//todo: trasnlate
|
|
39
51
|
dispatchToast(_jsx(Toast, { children: _jsx(ToastTitle, { children: success.message || "Changes saved!" }) }), { intent: "success", timeout: 2000 });
|
|
40
52
|
}
|
|
41
53
|
}), useEffectOnlyOnMount);
|
|
42
54
|
const doIfNoChanges = useCallback((handler, prompt) => {
|
|
43
55
|
if (hasChanges)
|
|
44
|
-
alerts.confirmEX(prompt ||
|
|
56
|
+
alerts.confirmEX(prompt || unsavedChangesPrompt, { okProps: { variant: "danger" } }).then(result => {
|
|
45
57
|
if (result) {
|
|
46
58
|
setHasChanges(false);
|
|
47
59
|
return handler();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-track-changes.js","sourceRoot":"","sources":["../../src/helpers/use-track-changes.tsx"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAoB,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAoB,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAczC,gJAAgJ;AAChJ,MAAM,UAAU,eAAe;
|
|
1
|
+
{"version":3,"file":"use-track-changes.js","sourceRoot":"","sources":["../../src/helpers/use-track-changes.tsx"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAoB,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAoB,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAczC,gJAAgJ;AAChJ,MAAM,UAAU,eAAe,CAAC,EAAE,QAAQ,KAA8B,EAAE;IAKtE,iBAAiB;IACjB,MAAM,oBAAoB,GAAG,0CAA0C,CAAC;IACxE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAA6B,KAAK,CAAC,CAAC;IACpF,uHAAuH;IACvH,MAAM,YAAY,GAAG,WAAW,EAAE,CAAC;IACnC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,aAAa,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE;QACjE,IAAI,EAAE,YAAY,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE;YAC7D,YAAY,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC/G,OAAO,QAAQ,CAAC;QACpB,CAAC;KACJ,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,EAAE,aAAa,EAAE,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAExD,MAAM,aAAa,GAAmC,WAAW,CAAC,CAAO,MAAM,EAAE,KAAK,EAAE,EAAE;QACtF,eAAe,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,KAAI,IAAI,CAAC,CAAC;QAC1C,IAAI,OAAgD,CAAC;QACrD,IAAI,CAAC;YACD,OAAO,GAAG,MAAM,MAAM,EAAE,CAAC;QAC7B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,yBAAyB,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAClF,CAAC;QACD,eAAe,CAAC,KAAK,CAAC,CAAC;QAEvB,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YAC3B,iBAAiB;YACjB,aAAa,CAAC,KAAC,KAAK,cAChB,KAAC,UAAU,cAAE,OAAO,CAAC,OAAO,IAAI,8BAA8B,GAAc,GACxE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACrD,CAAC;aACI,CAAC;YACF,aAAa,CAAC,KAAK,CAAC,CAAC;YACrB,iBAAiB;YACjB,aAAa,CAAC,KAAC,KAAK,cAChB,KAAC,UAAU,cAAE,OAAO,CAAC,OAAO,IAAI,gBAAgB,GAAc,GAC1D,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,CAAC;IACL,CAAC,CAAA,EAAE,oBAAoB,CAAC,CAAC;IAEzB,MAAM,aAAa,GAAG,WAAW,CAAC,CAAc,OAAyB,EAAE,MAAe,EAAE,EAAE;QAC1F,IAAI,UAAU;YACV,MAAM,CAAC,SAAS,CAAC,MAAM,IAAI,oBAAoB,EAAE,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAC/F,IAAI,MAAM,EAAE,CAAC;oBACT,aAAa,CAAC,KAAK,CAAC,CAAC;oBACrB,OAAO,OAAO,EAAE,CAAC;gBACrB,CAAC;YACL,CAAC,CAAC,CAAC;;YACF,OAAO,OAAO,EAAE,CAAC;IAC1B,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAEzB,OAAO;QACH,YAAY,EAAE;YACV,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa;SACzE;QACD,mBAAmB,EAAE,8BAChB,MAAM,CAAC,WAAW,EAClB,YAAY,IAAI,KAAC,UAAU,oBAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAI,EAClF,KAAC,OAAO,IAAC,SAAS,EAAE,SAAS,GAAI,IAClC;KACN,CAAC;AACN,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,kBAAkB;IAC9B,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,GAAG,eAAe,EAAE,CAAC;IAChE,uCAAY,YAAY,KAAE,mBAAmB,EAAE,mBAAmB,IAAG;AACzE,CAAC"}
|