@mittwald/flow-react-components 1.5.40 → 1.5.41
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/assets/component-index.json +1 -1
- package/dist/assets/doc-properties.json +1 -1
- package/dist/js/packages/components/src/components/Action/models/ActionState.mjs +2 -2
- package/dist/js/packages/components/src/components/Calendar/components/RangeCalendar/helpers/useCalendarDateRangePresets.mjs +1 -1
- package/dist/js/packages/components/src/components/List/model/ListViewMode.mjs +2 -2
- package/dist/js/packages/components/src/components/List/model/ReactTable.mjs +2 -2
- package/dist/js/packages/components/src/components/List/model/loading/IncrementalLoaderState.mjs +2 -2
- package/dist/js/packages/components/src/lib/controller/overlay/OverlayController.mjs +10 -158
- package/dist/js/packages/components/src/lib/controller/overlay/OverlayController.mjs.map +1 -1
- package/dist/js/packages/components-base/src/index.mjs +2 -1
- package/dist/js/packages/components-base/src/overlay/OverlayState.mjs +178 -0
- package/dist/js/packages/components-base/src/overlay/OverlayState.mjs.map +1 -0
- package/dist/types/_bundled/flow-components-base/index.d.ts +1 -0
- package/dist/types/_bundled/flow-components-base/overlay/OverlayState.d.ts +90 -0
- package/dist/types/lib/controller/overlay/OverlayController.d.ts +8 -74
- package/package.json +10 -10
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use client"
|
|
2
2
|
/* */
|
|
3
|
-
import useSelector from "../../../lib/mobx/useSelector.mjs";
|
|
4
|
-
import { useStatic } from "../../../lib/hooks/useStatic.mjs";
|
|
5
3
|
import { ActionState as ActionState$1, actionStateDurations } from "../../../../../components-base/src/action/ActionState.mjs";
|
|
6
4
|
import "../../../../../components-base/src/index.mjs";
|
|
5
|
+
import useSelector from "../../../lib/mobx/useSelector.mjs";
|
|
6
|
+
import { useStatic } from "../../../lib/hooks/useStatic.mjs";
|
|
7
7
|
//#region src/components/Action/models/ActionState.ts
|
|
8
8
|
var duration = actionStateDurations;
|
|
9
9
|
/**
|
|
@@ -4,9 +4,9 @@ import { useLocalizedStringFormatter } from "../../../../TranslationProvider/use
|
|
|
4
4
|
import __locale_default from "../../../../../../../../_virtual/_7.locale.mjs";
|
|
5
5
|
import { useContext, useMemo } from "react";
|
|
6
6
|
import { RangeCalendarStateContext } from "react-aria-components";
|
|
7
|
-
import invariant from "invariant";
|
|
8
7
|
import { CalendarDate, toCalendarDate } from "@internationalized/date";
|
|
9
8
|
import { DateTime } from "luxon";
|
|
9
|
+
import invariant from "invariant";
|
|
10
10
|
//#region src/components/Calendar/components/RangeCalendar/helpers/useCalendarDateRangePresets.ts
|
|
11
11
|
var clampCalendarDate = (date, minDate, maxDate) => {
|
|
12
12
|
if (minDate && date.compare(minDate) < 0) return minDate;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use client"
|
|
2
2
|
/* */
|
|
3
|
-
import useSelector from "../../../lib/mobx/useSelector.mjs";
|
|
4
|
-
import { useStatic } from "../../../lib/hooks/useStatic.mjs";
|
|
5
3
|
import { ListViewMode as ListViewMode$1 } from "../../../../../components-base/src/list/viewMode/ListViewMode.mjs";
|
|
6
4
|
import "../../../../../components-base/src/index.mjs";
|
|
5
|
+
import useSelector from "../../../lib/mobx/useSelector.mjs";
|
|
6
|
+
import { useStatic } from "../../../lib/hooks/useStatic.mjs";
|
|
7
7
|
//#region src/components/List/model/ListViewMode.ts
|
|
8
8
|
/**
|
|
9
9
|
* React's view of the list's layout mode.
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
"use client"
|
|
2
2
|
/* */
|
|
3
|
-
import useSelector from "../../../lib/mobx/useSelector.mjs";
|
|
4
|
-
import { useStatic } from "../../../lib/hooks/useStatic.mjs";
|
|
5
3
|
import { getListColumn } from "../../../../../components-base/src/list/ListModelContext.mjs";
|
|
6
4
|
import { mergeHiddenSorting } from "../../../../../components-base/src/list/sorting/ListSorting.mjs";
|
|
7
5
|
import { ListTable } from "../../../../../components-base/src/list/table/ListTable.mjs";
|
|
8
6
|
import "../../../../../components-base/src/index.mjs";
|
|
7
|
+
import useSelector from "../../../lib/mobx/useSelector.mjs";
|
|
8
|
+
import { useStatic } from "../../../lib/hooks/useStatic.mjs";
|
|
9
9
|
import { Filter } from "./filter/Filter.mjs";
|
|
10
10
|
import { useEffect, useEffectEvent, useState } from "react";
|
|
11
11
|
import { getCoreRowModel, getFacetedUniqueValues, getFilteredRowModel, getPaginationRowModel, getSortedRowModel } from "@tanstack/table-core";
|
package/dist/js/packages/components/src/components/List/model/loading/IncrementalLoaderState.mjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use client"
|
|
2
2
|
/* */
|
|
3
|
-
import useSelector from "../../../../lib/mobx/useSelector.mjs";
|
|
4
|
-
import { useStatic } from "../../../../lib/hooks/useStatic.mjs";
|
|
5
3
|
import { ListLoaderState } from "../../../../../../components-base/src/list/loading/ListLoaderState.mjs";
|
|
6
4
|
import "../../../../../../components-base/src/index.mjs";
|
|
5
|
+
import useSelector from "../../../../lib/mobx/useSelector.mjs";
|
|
6
|
+
import { useStatic } from "../../../../lib/hooks/useStatic.mjs";
|
|
7
7
|
//#region src/components/List/model/loading/IncrementalLoaderState.ts
|
|
8
8
|
/**
|
|
9
9
|
* React's view of the list's loading state.
|
|
@@ -1,70 +1,22 @@
|
|
|
1
1
|
"use client"
|
|
2
2
|
/* */
|
|
3
|
+
import { OverlayState } from "../../../../../components-base/src/overlay/OverlayState.mjs";
|
|
4
|
+
import "../../../../../components-base/src/index.mjs";
|
|
3
5
|
import useSelector from "../../mobx/useSelector.mjs";
|
|
4
6
|
import { useStatic } from "../../hooks/useStatic.mjs";
|
|
5
7
|
import { useCloseOverlayConfirmationController } from "./useCloseOverlayConfirmationController.mjs";
|
|
6
8
|
import { useEffect, useRef } from "react";
|
|
7
|
-
import { action, computed, makeObservable, observable, runInAction } from "mobx";
|
|
8
9
|
//#region src/lib/controller/overlay/OverlayController.ts
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
onOpenChangeHandlers = /* @__PURE__ */ new Set();
|
|
15
|
-
showConfirmationModal = false;
|
|
16
|
-
closeIsConfirmed = false;
|
|
17
|
-
confirmOnCloseFromOptions;
|
|
18
|
-
/**
|
|
19
|
-
* Every mounted component that has an opinion on close confirmation
|
|
20
|
-
* contributes one entry here – e.g. a `Modal` with a `confirmOnClose` prop
|
|
21
|
-
* and a `Form` tracking its dirty state. Combining them instead of assigning
|
|
22
|
-
* a single flag keeps them from overwriting each other.
|
|
23
|
-
*/
|
|
24
|
-
confirmOnCloseSources = observable.map();
|
|
25
|
-
/**
|
|
26
|
-
* Active grants that allow closing without a confirmation. Each entry is
|
|
27
|
-
* scoped to an ongoing operation that legitimately closes the overlay – e.g.
|
|
28
|
-
* a `Form` submit – and is dropped again when that operation has finished, so
|
|
29
|
-
* an operation that does _not_ close the overlay leaves the confirmation
|
|
30
|
-
* armed.
|
|
31
|
-
*/
|
|
32
|
-
closeWithoutConfirmationGrants = /* @__PURE__ */ new Set();
|
|
33
|
-
/**
|
|
34
|
-
* The open state a `setOpen` call is currently applying. Handlers run before
|
|
35
|
-
* `isOpen` is assigned, so a handler that calls `setOpen` again would not be
|
|
36
|
-
* caught by the equality check at the top and would recurse.
|
|
37
|
-
*/
|
|
38
|
-
openStateInFlight;
|
|
39
|
-
constructor(options = {}) {
|
|
40
|
-
makeObservable(this, {
|
|
41
|
-
isOpen: observable,
|
|
42
|
-
isContentSuspended: observable,
|
|
43
|
-
showConfirmationModal: observable,
|
|
44
|
-
confirmOnCloseEnabled: computed,
|
|
45
|
-
open: action.bound,
|
|
46
|
-
close: action.bound,
|
|
47
|
-
toggle: action.bound,
|
|
48
|
-
setOpen: action.bound,
|
|
49
|
-
syncOpen: action.bound,
|
|
50
|
-
setIsContentSuspended: action.bound,
|
|
51
|
-
confirmClose: action.bound,
|
|
52
|
-
cancelConfirmation: action.bound
|
|
53
|
-
});
|
|
54
|
-
const { isDefaultOpen = false, confirmOnClose = false } = options;
|
|
55
|
-
this.isOpen = isDefaultOpen;
|
|
56
|
-
this.confirmOnCloseFromOptions = confirmOnClose;
|
|
57
|
-
}
|
|
58
|
-
/** Whether closing this overlay currently requires a confirmation. */
|
|
59
|
-
get confirmOnCloseEnabled() {
|
|
60
|
-
if (this.confirmOnCloseSources.size === 0) return this.confirmOnCloseFromOptions;
|
|
61
|
-
return Array.from(this.confirmOnCloseSources.values()).some(Boolean);
|
|
62
|
-
}
|
|
10
|
+
/**
|
|
11
|
+
* The state is `OverlayState` from `@mittwald/flow-components-base`, shared
|
|
12
|
+
* with every remote binding; this adds the hooks.
|
|
13
|
+
*/
|
|
14
|
+
var OverlayController = class OverlayController extends OverlayState {
|
|
63
15
|
useUpdateOptions(options = {}) {
|
|
64
16
|
const { onOpen, onClose, onOpenChange, confirmOnClose } = options;
|
|
65
|
-
this.useOnHandler(onOpen, (h) => this.
|
|
66
|
-
this.useOnHandler(onClose, (h) => this.
|
|
67
|
-
this.useOnHandler(onOpenChange, (h) => this.
|
|
17
|
+
this.useOnHandler(onOpen, (h) => this.addOnOpen(h));
|
|
18
|
+
this.useOnHandler(onClose, (h) => this.addOnClose(h));
|
|
19
|
+
this.useOnHandler(onOpenChange, (h) => this.addOnOpenChange(h));
|
|
68
20
|
this.useConfirmOnCloseSource(confirmOnClose);
|
|
69
21
|
}
|
|
70
22
|
/**
|
|
@@ -86,12 +38,6 @@ var OverlayController = class OverlayController {
|
|
|
86
38
|
confirmOnClose
|
|
87
39
|
]);
|
|
88
40
|
}
|
|
89
|
-
setConfirmOnCloseSource(source, confirmOnClose) {
|
|
90
|
-
runInAction(() => this.confirmOnCloseSources.set(source, confirmOnClose));
|
|
91
|
-
}
|
|
92
|
-
removeConfirmOnCloseSource(source) {
|
|
93
|
-
runInAction(() => this.confirmOnCloseSources.delete(source));
|
|
94
|
-
}
|
|
95
41
|
/**
|
|
96
42
|
* Can be used to execute a callback when the Overlay has unmounted – means
|
|
97
43
|
* after any closing animation.
|
|
@@ -119,81 +65,9 @@ var OverlayController = class OverlayController {
|
|
|
119
65
|
controller.useUpdateOptions(options);
|
|
120
66
|
return controller;
|
|
121
67
|
}
|
|
122
|
-
addOpenStateHandler(handler, handlersSet) {
|
|
123
|
-
handlersSet.add(handler);
|
|
124
|
-
return () => {
|
|
125
|
-
handlersSet.delete(handler);
|
|
126
|
-
};
|
|
127
|
-
}
|
|
128
68
|
useOnHandler(handler, addHandlerFn) {
|
|
129
69
|
useEffect(() => handler ? addHandlerFn(handler) : void 0, [handler, this]);
|
|
130
70
|
}
|
|
131
|
-
executeHandlers(isOpen, handlers) {
|
|
132
|
-
return Array.from(handlers).map((handler) => handler(isOpen)).some((result) => result === false);
|
|
133
|
-
}
|
|
134
|
-
executeOnClose() {
|
|
135
|
-
return this.executeHandlers(false, this.onCloseHandlers);
|
|
136
|
-
}
|
|
137
|
-
executeOnOpen() {
|
|
138
|
-
return this.executeHandlers(true, this.onOpenHandlers);
|
|
139
|
-
}
|
|
140
|
-
executeOnOpenChange(isOpen) {
|
|
141
|
-
return this.executeHandlers(isOpen, this.onOpenChangeHandlers);
|
|
142
|
-
}
|
|
143
|
-
addOnClose(handler) {
|
|
144
|
-
return this.addOpenStateHandler(handler, this.onCloseHandlers);
|
|
145
|
-
}
|
|
146
|
-
addOnOpen(handler) {
|
|
147
|
-
return this.addOpenStateHandler(handler, this.onOpenHandlers);
|
|
148
|
-
}
|
|
149
|
-
addOnOpenChange(handler) {
|
|
150
|
-
return this.addOpenStateHandler(handler, this.onOpenChangeHandlers);
|
|
151
|
-
}
|
|
152
|
-
open() {
|
|
153
|
-
this.setOpen(true);
|
|
154
|
-
}
|
|
155
|
-
close(options) {
|
|
156
|
-
this.setOpen(false, options);
|
|
157
|
-
}
|
|
158
|
-
toggle() {
|
|
159
|
-
this.setOpen(!this.isOpen);
|
|
160
|
-
}
|
|
161
|
-
setOpen(toOpen, options = {}) {
|
|
162
|
-
if (this.isOpen === toOpen || this.openStateInFlight === toOpen) return;
|
|
163
|
-
this.openStateInFlight = toOpen;
|
|
164
|
-
try {
|
|
165
|
-
this.applyOpenState(toOpen, options);
|
|
166
|
-
} finally {
|
|
167
|
-
this.openStateInFlight = void 0;
|
|
168
|
-
}
|
|
169
|
-
}
|
|
170
|
-
/**
|
|
171
|
-
* Sets the open state without running any handler. Use it to mirror a
|
|
172
|
-
* controlled `isOpen` prop, whose change comes from the consumer – notifying
|
|
173
|
-
* them of their own state would echo it back.
|
|
174
|
-
*/
|
|
175
|
-
syncOpen(toOpen) {
|
|
176
|
-
this.isOpen = toOpen;
|
|
177
|
-
}
|
|
178
|
-
applyOpenState(toOpen, options) {
|
|
179
|
-
const { bypassConfirmation = false } = options;
|
|
180
|
-
if (toOpen === false) {
|
|
181
|
-
const closeIsConfirmed = this.closeIsConfirmed;
|
|
182
|
-
this.closeIsConfirmed = false;
|
|
183
|
-
if (this.confirmOnCloseEnabled && !closeIsConfirmed && this.closeWithoutConfirmationGrants.size === 0 && !bypassConfirmation) {
|
|
184
|
-
this.showConfirmationModal = true;
|
|
185
|
-
return;
|
|
186
|
-
}
|
|
187
|
-
}
|
|
188
|
-
let aborted;
|
|
189
|
-
if (toOpen) aborted = this.executeOnOpen();
|
|
190
|
-
else aborted = this.executeOnClose();
|
|
191
|
-
if (!aborted) aborted = this.executeOnOpenChange(toOpen);
|
|
192
|
-
if (!aborted) this.isOpen = toOpen;
|
|
193
|
-
}
|
|
194
|
-
setIsContentSuspended(to) {
|
|
195
|
-
this.isContentSuspended = to;
|
|
196
|
-
}
|
|
197
71
|
useIsOpen() {
|
|
198
72
|
return useSelector(() => this.isOpen);
|
|
199
73
|
}
|
|
@@ -209,28 +83,6 @@ var OverlayController = class OverlayController {
|
|
|
209
83
|
useConfirmationController() {
|
|
210
84
|
return useCloseOverlayConfirmationController(this);
|
|
211
85
|
}
|
|
212
|
-
/**
|
|
213
|
-
* Allows closing this overlay without a confirmation until the returned
|
|
214
|
-
* disposer is called. Use it around an operation that may legitimately close
|
|
215
|
-
* the overlay – e.g. a `Form` submit, where a "discard unsaved changes?"
|
|
216
|
-
* prompt would be nonsense – and dispose it as soon as that operation has
|
|
217
|
-
* finished. An operation that ends without closing the overlay therefore
|
|
218
|
-
* leaves the confirmation armed (#2775).
|
|
219
|
-
*/
|
|
220
|
-
grantCloseWithoutConfirmation() {
|
|
221
|
-
const grant = {};
|
|
222
|
-
this.closeWithoutConfirmationGrants.add(grant);
|
|
223
|
-
return () => {
|
|
224
|
-
this.closeWithoutConfirmationGrants.delete(grant);
|
|
225
|
-
};
|
|
226
|
-
}
|
|
227
|
-
confirmClose() {
|
|
228
|
-
this.closeIsConfirmed = true;
|
|
229
|
-
this.showConfirmationModal = false;
|
|
230
|
-
}
|
|
231
|
-
cancelConfirmation() {
|
|
232
|
-
this.showConfirmationModal = false;
|
|
233
|
-
}
|
|
234
86
|
};
|
|
235
87
|
//#endregion
|
|
236
88
|
export { OverlayController };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OverlayController.mjs","names":[],"sources":["../../../../../../../../src/lib/controller/overlay/OverlayController.ts"],"sourcesContent":["import {\n action,\n computed,\n makeObservable,\n observable,\n runInAction,\n} from \"mobx\";\nimport useSelector from \"@/lib/mobx/useSelector\";\nimport { useStatic } from \"@/lib/hooks/useStatic\";\nimport { useEffect, useRef, type DependencyList } from \"react\";\nimport { useCloseOverlayConfirmationController } from \"@/lib/controller/overlay/useCloseOverlayConfirmationController\";\nimport type { FlowComponentName } from \"@/components/propTypes\";\n\nexport type OverlayOpenHandler = () => unknown;\nexport type OverlayCloseHandler = () => unknown;\nexport type OverlayOpenStateHandler = (isOpen: boolean) => unknown;\ntype AnyOverlayOpenStateHandler =\n OverlayOpenHandler | OverlayCloseHandler | OverlayOpenStateHandler;\n\ntype DisposerFn = () => void;\n\nexport interface CloseOverlayOptions {\n /**\n * The overlay to close. Omitted, the nearest enclosing overlay is closed –\n * the same thing `closeOverlay={true}` means.\n */\n overlay?: FlowComponentName | OverlayController;\n bypassConfirmation?: boolean;\n}\n\nexport interface OnOverlayClosedOptions {\n dependencies?: DependencyList;\n}\n\nexport type CloseModalOptions = Omit<CloseOverlayOptions, \"overlay\">;\n\n/**\n * Every way an action can point at an overlay: by the Flow component name it\n * registers under, by controller, by options, or with `true` – the nearest\n * enclosing overlay, whatever its name.\n */\nexport type OverlayReference =\n FlowComponentName | OverlayController | CloseOverlayOptions | true;\n\ntype CloseOptions = CloseOverlayOptions | CloseModalOptions;\n\nexport interface OverlayControllerOptions {\n isDefaultOpen?: boolean;\n onOpen?: OverlayOpenHandler;\n onClose?: OverlayCloseHandler;\n onOpenChange?: OverlayOpenStateHandler;\n /**\n * Whether closing the overlay must be confirmed. `undefined` means \"no\n * opinion\": the value is not contributed at all, so other sources (e.g. a\n * `Modal`'s `confirmOnClose` prop or a dirty `Form`) still decide.\n */\n confirmOnClose?: boolean;\n}\n\ntype ConstructorOptions = Pick<\n OverlayControllerOptions,\n \"isDefaultOpen\" | \"confirmOnClose\"\n>;\n\nexport class OverlayController {\n public isOpen = false;\n public isContentSuspended = false;\n private onOpenHandlers = new Set<OverlayOpenHandler>();\n private onCloseHandlers = new Set<OverlayCloseHandler>();\n private onOpenChangeHandlers = new Set<OverlayOpenStateHandler>();\n\n public showConfirmationModal = false;\n public closeIsConfirmed = false;\n private readonly confirmOnCloseFromOptions: boolean;\n /**\n * Every mounted component that has an opinion on close confirmation\n * contributes one entry here – e.g. a `Modal` with a `confirmOnClose` prop\n * and a `Form` tracking its dirty state. Combining them instead of assigning\n * a single flag keeps them from overwriting each other.\n */\n private confirmOnCloseSources = observable.map<object, boolean>();\n /**\n * Active grants that allow closing without a confirmation. Each entry is\n * scoped to an ongoing operation that legitimately closes the overlay – e.g.\n * a `Form` submit – and is dropped again when that operation has finished, so\n * an operation that does _not_ close the overlay leaves the confirmation\n * armed.\n */\n private closeWithoutConfirmationGrants = new Set<object>();\n /**\n * The open state a `setOpen` call is currently applying. Handlers run before\n * `isOpen` is assigned, so a handler that calls `setOpen` again would not be\n * caught by the equality check at the top and would recurse.\n */\n private openStateInFlight: boolean | undefined;\n\n public constructor(options: ConstructorOptions = {}) {\n makeObservable(this, {\n isOpen: observable,\n isContentSuspended: observable,\n showConfirmationModal: observable,\n confirmOnCloseEnabled: computed,\n open: action.bound,\n close: action.bound,\n toggle: action.bound,\n setOpen: action.bound,\n syncOpen: action.bound,\n setIsContentSuspended: action.bound,\n confirmClose: action.bound,\n cancelConfirmation: action.bound,\n });\n const { isDefaultOpen = false, confirmOnClose = false } = options;\n this.isOpen = isDefaultOpen;\n this.confirmOnCloseFromOptions = confirmOnClose;\n }\n\n /** Whether closing this overlay currently requires a confirmation. */\n public get confirmOnCloseEnabled(): boolean {\n if (this.confirmOnCloseSources.size === 0) {\n return this.confirmOnCloseFromOptions;\n }\n return Array.from(this.confirmOnCloseSources.values()).some(Boolean);\n }\n\n public useUpdateOptions(options: OverlayControllerOptions = {}): void {\n const { onOpen, onClose, onOpenChange, confirmOnClose } = options;\n\n this.useOnHandler(onOpen, (h) =>\n this.addOpenStateHandler(h, this.onOpenHandlers),\n );\n this.useOnHandler(onClose, (h) =>\n this.addOpenStateHandler(h, this.onCloseHandlers),\n );\n this.useOnHandler(onOpenChange, (h) =>\n this.addOpenStateHandler(h, this.onOpenChangeHandlers),\n );\n\n this.useConfirmOnCloseSource(confirmOnClose);\n }\n\n /**\n * Registers the calling component as a close confirmation source for as long\n * as it is mounted. `undefined` contributes nothing at all.\n */\n private useConfirmOnCloseSource(confirmOnClose: boolean | undefined): void {\n const source = useStatic((): object => ({}));\n\n useEffect(() => {\n if (confirmOnClose === undefined) {\n this.removeConfirmOnCloseSource(source);\n return;\n }\n this.setConfirmOnCloseSource(source, confirmOnClose);\n return () => this.removeConfirmOnCloseSource(source);\n }, [this, source, confirmOnClose]);\n }\n\n private setConfirmOnCloseSource(source: object, confirmOnClose: boolean) {\n runInAction(() => this.confirmOnCloseSources.set(source, confirmOnClose));\n }\n\n private removeConfirmOnCloseSource(source: object) {\n runInAction(() => this.confirmOnCloseSources.delete(source));\n }\n\n /**\n * Can be used to execute a callback when the Overlay has unmounted – means\n * after any closing animation.\n *\n * NOTICE: This hook only works inside the corresponding Overlay!\n */\n public useOnClosed(\n callback: () => unknown,\n options: OnOverlayClosedOptions = {},\n ) {\n const { dependencies = [] } = options;\n const isOpen = this.useIsOpen();\n const wasOpen = useRef(this.isOpen);\n\n this.useUpdateOptions({\n onOpen: () => {\n wasOpen.current = true;\n },\n });\n\n useEffect(() => {\n return () => {\n if (!isOpen && wasOpen.current) {\n wasOpen.current = false;\n callback();\n }\n };\n }, [isOpen, ...dependencies]);\n }\n\n public static useNew(\n options: OverlayControllerOptions = {},\n ): OverlayController {\n const controller = useStatic(() => new OverlayController(options));\n controller.useUpdateOptions(options);\n return controller;\n }\n\n private addOpenStateHandler<T extends AnyOverlayOpenStateHandler>(\n handler: T,\n handlersSet: Set<T>,\n ): DisposerFn {\n handlersSet.add(handler);\n return () => {\n handlersSet.delete(handler);\n };\n }\n\n private useOnHandler<T extends AnyOverlayOpenStateHandler>(\n handler: T | undefined,\n addHandlerFn: (handler: T) => DisposerFn,\n ) {\n useEffect(\n () => (handler ? addHandlerFn(handler) : undefined),\n [handler, this],\n );\n }\n\n private executeHandlers(\n isOpen: boolean,\n handlers: Set<\n OverlayOpenHandler | OverlayCloseHandler | OverlayOpenStateHandler\n >,\n ): boolean {\n const handlerResult = Array.from(handlers).map((handler) =>\n handler(isOpen),\n );\n return handlerResult.some((result) => result === false);\n }\n\n private executeOnClose(): boolean {\n return this.executeHandlers(false, this.onCloseHandlers);\n }\n\n private executeOnOpen(): boolean {\n return this.executeHandlers(true, this.onOpenHandlers);\n }\n\n private executeOnOpenChange(isOpen: boolean): boolean {\n return this.executeHandlers(isOpen, this.onOpenChangeHandlers);\n }\n\n public addOnClose(handler: OverlayCloseHandler) {\n return this.addOpenStateHandler(handler, this.onCloseHandlers);\n }\n\n public addOnOpen(handler: OverlayOpenHandler) {\n return this.addOpenStateHandler(handler, this.onOpenHandlers);\n }\n\n public addOnOpenChange(handler: OverlayOpenStateHandler) {\n return this.addOpenStateHandler(handler, this.onOpenChangeHandlers);\n }\n\n public open(): void {\n this.setOpen(true);\n }\n\n public close(options?: CloseOptions): void {\n this.setOpen(false, options);\n }\n\n public toggle(): void {\n this.setOpen(!this.isOpen);\n }\n\n public setOpen(toOpen: boolean, options: CloseOptions = {}): void {\n if (this.isOpen === toOpen || this.openStateInFlight === toOpen) {\n return;\n }\n\n this.openStateInFlight = toOpen;\n try {\n this.applyOpenState(toOpen, options);\n } finally {\n this.openStateInFlight = undefined;\n }\n }\n\n /**\n * Sets the open state without running any handler. Use it to mirror a\n * controlled `isOpen` prop, whose change comes from the consumer – notifying\n * them of their own state would echo it back.\n */\n public syncOpen(toOpen: boolean): void {\n this.isOpen = toOpen;\n }\n\n private applyOpenState(toOpen: boolean, options: CloseOptions): void {\n const { bypassConfirmation = false } = options;\n\n if (toOpen === false) {\n // The confirmation is a one-shot permission for exactly this close\n // attempt – consume it here instead of only when a close succeeds, so it\n // cannot survive an aborted close and disarm later attempts.\n const closeIsConfirmed = this.closeIsConfirmed;\n this.closeIsConfirmed = false;\n\n if (\n this.confirmOnCloseEnabled &&\n !closeIsConfirmed &&\n this.closeWithoutConfirmationGrants.size === 0 &&\n !bypassConfirmation\n ) {\n this.showConfirmationModal = true;\n return;\n }\n }\n\n let aborted: boolean;\n if (toOpen) {\n aborted = this.executeOnOpen();\n } else {\n aborted = this.executeOnClose();\n }\n if (!aborted) {\n aborted = this.executeOnOpenChange(toOpen);\n }\n\n if (!aborted) {\n this.isOpen = toOpen;\n }\n }\n\n public setIsContentSuspended(to: boolean): void {\n this.isContentSuspended = to;\n }\n\n public useIsOpen() {\n return useSelector(() => this.isOpen);\n }\n\n public useIsContentSuspended() {\n return useSelector(() => this.isContentSuspended);\n }\n\n public useShowConfirmationModal() {\n return useSelector(() => this.showConfirmationModal);\n }\n\n public useConfirmOnCloseEnabled() {\n return useSelector(() => this.confirmOnCloseEnabled);\n }\n\n public useConfirmationController() {\n return useCloseOverlayConfirmationController(this);\n }\n\n /**\n * Allows closing this overlay without a confirmation until the returned\n * disposer is called. Use it around an operation that may legitimately close\n * the overlay – e.g. a `Form` submit, where a \"discard unsaved changes?\"\n * prompt would be nonsense – and dispose it as soon as that operation has\n * finished. An operation that ends without closing the overlay therefore\n * leaves the confirmation armed (#2775).\n */\n public grantCloseWithoutConfirmation(): DisposerFn {\n const grant = {};\n this.closeWithoutConfirmationGrants.add(grant);\n return () => {\n this.closeWithoutConfirmationGrants.delete(grant);\n };\n }\n\n public confirmClose(): void {\n this.closeIsConfirmed = true;\n this.showConfirmationModal = false;\n }\n\n public cancelConfirmation(): void {\n this.showConfirmationModal = false;\n }\n}\n"],"mappings":";;;;;;;;AAgEA,IAAa,oBAAb,MAAa,kBAAkB;CAC7B,SAAgB;CAChB,qBAA4B;CAC5B,iCAAyB,IAAI,IAAwB;CACrD,kCAA0B,IAAI,IAAyB;CACvD,uCAA+B,IAAI,IAA6B;CAEhE,wBAA+B;CAC/B,mBAA0B;CAC1B;;;;;;;CAOA,wBAAgC,WAAW,IAAqB;;;;;;;;CAQhE,iDAAyC,IAAI,IAAY;;;;;;CAMzD;CAEA,YAAmB,UAA8B,CAAC,GAAG;EACnD,eAAe,MAAM;GACnB,QAAQ;GACR,oBAAoB;GACpB,uBAAuB;GACvB,uBAAuB;GACvB,MAAM,OAAO;GACb,OAAO,OAAO;GACd,QAAQ,OAAO;GACf,SAAS,OAAO;GAChB,UAAU,OAAO;GACjB,uBAAuB,OAAO;GAC9B,cAAc,OAAO;GACrB,oBAAoB,OAAO;EAC7B,CAAC;EACD,MAAM,EAAE,gBAAgB,OAAO,iBAAiB,UAAU;EAC1D,KAAK,SAAS;EACd,KAAK,4BAA4B;CACnC;;CAGA,IAAW,wBAAiC;EAC1C,IAAI,KAAK,sBAAsB,SAAS,GACtC,OAAO,KAAK;EAEd,OAAO,MAAM,KAAK,KAAK,sBAAsB,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO;CACrE;CAEA,iBAAwB,UAAoC,CAAC,GAAS;EACpE,MAAM,EAAE,QAAQ,SAAS,cAAc,mBAAmB;EAE1D,KAAK,aAAa,SAAS,MACzB,KAAK,oBAAoB,GAAG,KAAK,cAAc,CACjD;EACA,KAAK,aAAa,UAAU,MAC1B,KAAK,oBAAoB,GAAG,KAAK,eAAe,CAClD;EACA,KAAK,aAAa,eAAe,MAC/B,KAAK,oBAAoB,GAAG,KAAK,oBAAoB,CACvD;EAEA,KAAK,wBAAwB,cAAc;CAC7C;;;;;CAMA,wBAAgC,gBAA2C;EACzE,MAAM,SAAS,iBAAyB,CAAC,EAAE;EAE3C,gBAAgB;GACd,IAAI,mBAAmB,KAAA,GAAW;IAChC,KAAK,2BAA2B,MAAM;IACtC;GACF;GACA,KAAK,wBAAwB,QAAQ,cAAc;GACnD,aAAa,KAAK,2BAA2B,MAAM;EACrD,GAAG;GAAC;GAAM;GAAQ;EAAc,CAAC;CACnC;CAEA,wBAAgC,QAAgB,gBAAyB;EACvE,kBAAkB,KAAK,sBAAsB,IAAI,QAAQ,cAAc,CAAC;CAC1E;CAEA,2BAAmC,QAAgB;EACjD,kBAAkB,KAAK,sBAAsB,OAAO,MAAM,CAAC;CAC7D;;;;;;;CAQA,YACE,UACA,UAAkC,CAAC,GACnC;EACA,MAAM,EAAE,eAAe,CAAC,MAAM;EAC9B,MAAM,SAAS,KAAK,UAAU;EAC9B,MAAM,UAAU,OAAO,KAAK,MAAM;EAElC,KAAK,iBAAiB,EACpB,cAAc;GACZ,QAAQ,UAAU;EACpB,EACF,CAAC;EAED,gBAAgB;GACd,aAAa;IACX,IAAI,CAAC,UAAU,QAAQ,SAAS;KAC9B,QAAQ,UAAU;KAClB,SAAS;IACX;GACF;EACF,GAAG,CAAC,QAAQ,GAAG,YAAY,CAAC;CAC9B;CAEA,OAAc,OACZ,UAAoC,CAAC,GAClB;EACnB,MAAM,aAAa,gBAAgB,IAAI,kBAAkB,OAAO,CAAC;EACjE,WAAW,iBAAiB,OAAO;EACnC,OAAO;CACT;CAEA,oBACE,SACA,aACY;EACZ,YAAY,IAAI,OAAO;EACvB,aAAa;GACX,YAAY,OAAO,OAAO;EAC5B;CACF;CAEA,aACE,SACA,cACA;EACA,gBACS,UAAU,aAAa,OAAO,IAAI,KAAA,GACzC,CAAC,SAAS,IAAI,CAChB;CACF;CAEA,gBACE,QACA,UAGS;EAIT,OAHsB,MAAM,KAAK,QAAQ,CAAC,CAAC,KAAK,YAC9C,QAAQ,MAAM,CAET,CAAA,CAAc,MAAM,WAAW,WAAW,KAAK;CACxD;CAEA,iBAAkC;EAChC,OAAO,KAAK,gBAAgB,OAAO,KAAK,eAAe;CACzD;CAEA,gBAAiC;EAC/B,OAAO,KAAK,gBAAgB,MAAM,KAAK,cAAc;CACvD;CAEA,oBAA4B,QAA0B;EACpD,OAAO,KAAK,gBAAgB,QAAQ,KAAK,oBAAoB;CAC/D;CAEA,WAAkB,SAA8B;EAC9C,OAAO,KAAK,oBAAoB,SAAS,KAAK,eAAe;CAC/D;CAEA,UAAiB,SAA6B;EAC5C,OAAO,KAAK,oBAAoB,SAAS,KAAK,cAAc;CAC9D;CAEA,gBAAuB,SAAkC;EACvD,OAAO,KAAK,oBAAoB,SAAS,KAAK,oBAAoB;CACpE;CAEA,OAAoB;EAClB,KAAK,QAAQ,IAAI;CACnB;CAEA,MAAa,SAA8B;EACzC,KAAK,QAAQ,OAAO,OAAO;CAC7B;CAEA,SAAsB;EACpB,KAAK,QAAQ,CAAC,KAAK,MAAM;CAC3B;CAEA,QAAe,QAAiB,UAAwB,CAAC,GAAS;EAChE,IAAI,KAAK,WAAW,UAAU,KAAK,sBAAsB,QACvD;EAGF,KAAK,oBAAoB;EACzB,IAAI;GACF,KAAK,eAAe,QAAQ,OAAO;EACrC,UAAU;GACR,KAAK,oBAAoB,KAAA;EAC3B;CACF;;;;;;CAOA,SAAgB,QAAuB;EACrC,KAAK,SAAS;CAChB;CAEA,eAAuB,QAAiB,SAA6B;EACnE,MAAM,EAAE,qBAAqB,UAAU;EAEvC,IAAI,WAAW,OAAO;GAIpB,MAAM,mBAAmB,KAAK;GAC9B,KAAK,mBAAmB;GAExB,IACE,KAAK,yBACL,CAAC,oBACD,KAAK,+BAA+B,SAAS,KAC7C,CAAC,oBACD;IACA,KAAK,wBAAwB;IAC7B;GACF;EACF;EAEA,IAAI;EACJ,IAAI,QACF,UAAU,KAAK,cAAc;OAE7B,UAAU,KAAK,eAAe;EAEhC,IAAI,CAAC,SACH,UAAU,KAAK,oBAAoB,MAAM;EAG3C,IAAI,CAAC,SACH,KAAK,SAAS;CAElB;CAEA,sBAA6B,IAAmB;EAC9C,KAAK,qBAAqB;CAC5B;CAEA,YAAmB;EACjB,OAAO,kBAAkB,KAAK,MAAM;CACtC;CAEA,wBAA+B;EAC7B,OAAO,kBAAkB,KAAK,kBAAkB;CAClD;CAEA,2BAAkC;EAChC,OAAO,kBAAkB,KAAK,qBAAqB;CACrD;CAEA,2BAAkC;EAChC,OAAO,kBAAkB,KAAK,qBAAqB;CACrD;CAEA,4BAAmC;EACjC,OAAO,sCAAsC,IAAI;CACnD;;;;;;;;;CAUA,gCAAmD;EACjD,MAAM,QAAQ,CAAC;EACf,KAAK,+BAA+B,IAAI,KAAK;EAC7C,aAAa;GACX,KAAK,+BAA+B,OAAO,KAAK;EAClD;CACF;CAEA,eAA4B;EAC1B,KAAK,mBAAmB;EACxB,KAAK,wBAAwB;CAC/B;CAEA,qBAAkC;EAChC,KAAK,wBAAwB;CAC/B;AACF"}
|
|
1
|
+
{"version":3,"file":"OverlayController.mjs","names":[],"sources":["../../../../../../../../src/lib/controller/overlay/OverlayController.ts"],"sourcesContent":["import {\n OverlayState,\n type AnyOverlayOpenStateHandler,\n type DisposerFn,\n type OverlayCloseHandler,\n type OverlayCloseOptions,\n type OverlayOpenHandler,\n type OverlayOpenStateHandler,\n} from \"@mittwald/flow-components-base\";\nimport useSelector from \"@/lib/mobx/useSelector\";\nimport { useStatic } from \"@/lib/hooks/useStatic\";\nimport { useEffect, useRef, type DependencyList } from \"react\";\nimport { useCloseOverlayConfirmationController } from \"@/lib/controller/overlay/useCloseOverlayConfirmationController\";\nimport type { FlowComponentName } from \"@/components/propTypes\";\n\nexport type {\n OverlayCloseHandler,\n OverlayOpenHandler,\n OverlayOpenStateHandler,\n} from \"@mittwald/flow-components-base\";\n\nexport interface CloseOverlayOptions extends OverlayCloseOptions {\n /**\n * The overlay to close. Omitted, the nearest enclosing overlay is closed –\n * the same thing `closeOverlay={true}` means.\n */\n overlay?: FlowComponentName | OverlayController;\n}\n\nexport interface OnOverlayClosedOptions {\n dependencies?: DependencyList;\n}\n\nexport type CloseModalOptions = Omit<CloseOverlayOptions, \"overlay\">;\n\n/**\n * Every way an action can point at an overlay: by the Flow component name it\n * registers under, by controller, by options, or with `true` – the nearest\n * enclosing overlay, whatever its name.\n */\nexport type OverlayReference =\n FlowComponentName | OverlayController | CloseOverlayOptions | true;\n\ntype CloseOptions = CloseOverlayOptions | CloseModalOptions;\n\nexport interface OverlayControllerOptions {\n isDefaultOpen?: boolean;\n onOpen?: OverlayOpenHandler;\n onClose?: OverlayCloseHandler;\n onOpenChange?: OverlayOpenStateHandler;\n /**\n * Whether closing the overlay must be confirmed. `undefined` means \"no\n * opinion\": the value is not contributed at all, so other sources (e.g. a\n * `Modal`'s `confirmOnClose` prop or a dirty `Form`) still decide.\n */\n confirmOnClose?: boolean;\n}\n\n/**\n * The state is `OverlayState` from `@mittwald/flow-components-base`, shared\n * with every remote binding; this adds the hooks.\n */\nexport class OverlayController extends OverlayState<CloseOptions> {\n public useUpdateOptions(options: OverlayControllerOptions = {}): void {\n const { onOpen, onClose, onOpenChange, confirmOnClose } = options;\n\n this.useOnHandler(onOpen, (h) => this.addOnOpen(h));\n this.useOnHandler(onClose, (h) => this.addOnClose(h));\n this.useOnHandler(onOpenChange, (h) => this.addOnOpenChange(h));\n\n this.useConfirmOnCloseSource(confirmOnClose);\n }\n\n /**\n * Registers the calling component as a close confirmation source for as long\n * as it is mounted. `undefined` contributes nothing at all.\n */\n private useConfirmOnCloseSource(confirmOnClose: boolean | undefined): void {\n const source = useStatic((): object => ({}));\n\n useEffect(() => {\n if (confirmOnClose === undefined) {\n this.removeConfirmOnCloseSource(source);\n return;\n }\n this.setConfirmOnCloseSource(source, confirmOnClose);\n return () => this.removeConfirmOnCloseSource(source);\n }, [this, source, confirmOnClose]);\n }\n\n /**\n * Can be used to execute a callback when the Overlay has unmounted – means\n * after any closing animation.\n *\n * NOTICE: This hook only works inside the corresponding Overlay!\n */\n public useOnClosed(\n callback: () => unknown,\n options: OnOverlayClosedOptions = {},\n ) {\n const { dependencies = [] } = options;\n const isOpen = this.useIsOpen();\n const wasOpen = useRef(this.isOpen);\n\n this.useUpdateOptions({\n onOpen: () => {\n wasOpen.current = true;\n },\n });\n\n useEffect(() => {\n return () => {\n if (!isOpen && wasOpen.current) {\n wasOpen.current = false;\n callback();\n }\n };\n }, [isOpen, ...dependencies]);\n }\n\n public static useNew(\n options: OverlayControllerOptions = {},\n ): OverlayController {\n const controller = useStatic(() => new OverlayController(options));\n controller.useUpdateOptions(options);\n return controller;\n }\n\n private useOnHandler<T extends AnyOverlayOpenStateHandler>(\n handler: T | undefined,\n addHandlerFn: (handler: T) => DisposerFn,\n ) {\n useEffect(\n () => (handler ? addHandlerFn(handler) : undefined),\n [handler, this],\n );\n }\n\n public useIsOpen() {\n return useSelector(() => this.isOpen);\n }\n\n public useIsContentSuspended() {\n return useSelector(() => this.isContentSuspended);\n }\n\n public useShowConfirmationModal() {\n return useSelector(() => this.showConfirmationModal);\n }\n\n public useConfirmOnCloseEnabled() {\n return useSelector(() => this.confirmOnCloseEnabled);\n }\n\n public useConfirmationController() {\n return useCloseOverlayConfirmationController(this);\n }\n}\n"],"mappings":";;;;;;;;;;;;;AA8DA,IAAa,oBAAb,MAAa,0BAA0B,aAA2B;CAChE,iBAAwB,UAAoC,CAAC,GAAS;EACpE,MAAM,EAAE,QAAQ,SAAS,cAAc,mBAAmB;EAE1D,KAAK,aAAa,SAAS,MAAM,KAAK,UAAU,CAAC,CAAC;EAClD,KAAK,aAAa,UAAU,MAAM,KAAK,WAAW,CAAC,CAAC;EACpD,KAAK,aAAa,eAAe,MAAM,KAAK,gBAAgB,CAAC,CAAC;EAE9D,KAAK,wBAAwB,cAAc;CAC7C;;;;;CAMA,wBAAgC,gBAA2C;EACzE,MAAM,SAAS,iBAAyB,CAAC,EAAE;EAE3C,gBAAgB;GACd,IAAI,mBAAmB,KAAA,GAAW;IAChC,KAAK,2BAA2B,MAAM;IACtC;GACF;GACA,KAAK,wBAAwB,QAAQ,cAAc;GACnD,aAAa,KAAK,2BAA2B,MAAM;EACrD,GAAG;GAAC;GAAM;GAAQ;EAAc,CAAC;CACnC;;;;;;;CAQA,YACE,UACA,UAAkC,CAAC,GACnC;EACA,MAAM,EAAE,eAAe,CAAC,MAAM;EAC9B,MAAM,SAAS,KAAK,UAAU;EAC9B,MAAM,UAAU,OAAO,KAAK,MAAM;EAElC,KAAK,iBAAiB,EACpB,cAAc;GACZ,QAAQ,UAAU;EACpB,EACF,CAAC;EAED,gBAAgB;GACd,aAAa;IACX,IAAI,CAAC,UAAU,QAAQ,SAAS;KAC9B,QAAQ,UAAU;KAClB,SAAS;IACX;GACF;EACF,GAAG,CAAC,QAAQ,GAAG,YAAY,CAAC;CAC9B;CAEA,OAAc,OACZ,UAAoC,CAAC,GAClB;EACnB,MAAM,aAAa,gBAAgB,IAAI,kBAAkB,OAAO,CAAC;EACjE,WAAW,iBAAiB,OAAO;EACnC,OAAO;CACT;CAEA,aACE,SACA,cACA;EACA,gBACS,UAAU,aAAa,OAAO,IAAI,KAAA,GACzC,CAAC,SAAS,IAAI,CAChB;CACF;CAEA,YAAmB;EACjB,OAAO,kBAAkB,KAAK,MAAM;CACtC;CAEA,wBAA+B;EAC7B,OAAO,kBAAkB,KAAK,kBAAkB;CAClD;CAEA,2BAAkC;EAChC,OAAO,kBAAkB,KAAK,qBAAqB;CACrD;CAEA,2BAAkC;EAChC,OAAO,kBAAkB,KAAK,qBAAqB;CACrD;CAEA,4BAAmC;EACjC,OAAO,sCAAsC,IAAI;CACnD;AACF"}
|
|
@@ -15,4 +15,5 @@ import { ListSearch } from "./list/search/ListSearch.mjs";
|
|
|
15
15
|
import { ListSorting, mergeHiddenSorting } from "./list/sorting/ListSorting.mjs";
|
|
16
16
|
import { ListTable } from "./list/table/ListTable.mjs";
|
|
17
17
|
import { ListViewMode } from "./list/viewMode/ListViewMode.mjs";
|
|
18
|
-
|
|
18
|
+
import { OverlayState } from "./overlay/OverlayState.mjs";
|
|
19
|
+
export { ActionState, ListBatchesController, ListDateRangeFilter, ListFilter, ListItemCollection, ListLoaderState, ListSearch, ListSorting, ListTable, ListViewMode, OverlayState, actionStateDurations, getListColumn, getListDataLoaderOptions, mergeHiddenSorting };
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
"use client"
|
|
2
|
+
/* */
|
|
3
|
+
import { action, computed, makeObservable, observable, runInAction } from "mobx";
|
|
4
|
+
//#region ../components-base/src/overlay/OverlayState.ts
|
|
5
|
+
/**
|
|
6
|
+
* Whether an overlay is open, and whether closing it has to be confirmed first.
|
|
7
|
+
* Each binding adds its subscription and its lifecycle: React's
|
|
8
|
+
* `OverlayController` subclasses it, Vue's adapter wraps it in refs.
|
|
9
|
+
*
|
|
10
|
+
* `TCloseOptions` lets a binding pass more on a close than the state reads —
|
|
11
|
+
* React's `overlay`, resolved by `Action` before the close arrives here.
|
|
12
|
+
*/
|
|
13
|
+
var OverlayState = class {
|
|
14
|
+
isOpen = false;
|
|
15
|
+
isContentSuspended = false;
|
|
16
|
+
onOpenHandlers = /* @__PURE__ */ new Set();
|
|
17
|
+
onCloseHandlers = /* @__PURE__ */ new Set();
|
|
18
|
+
onOpenChangeHandlers = /* @__PURE__ */ new Set();
|
|
19
|
+
showConfirmationModal = false;
|
|
20
|
+
closeIsConfirmed = false;
|
|
21
|
+
confirmOnCloseFromOptions;
|
|
22
|
+
/**
|
|
23
|
+
* Every mounted component that has an opinion on close confirmation
|
|
24
|
+
* contributes one entry here – e.g. a `Modal` with a `confirmOnClose` prop
|
|
25
|
+
* and a `Form` tracking its dirty state. Combining them instead of assigning
|
|
26
|
+
* a single flag keeps them from overwriting each other.
|
|
27
|
+
*/
|
|
28
|
+
confirmOnCloseSources = observable.map();
|
|
29
|
+
/**
|
|
30
|
+
* Active grants that allow closing without a confirmation. Each entry is
|
|
31
|
+
* scoped to an ongoing operation that legitimately closes the overlay – e.g.
|
|
32
|
+
* a `Form` submit – and is dropped again when that operation has finished, so
|
|
33
|
+
* an operation that does _not_ close the overlay leaves the confirmation
|
|
34
|
+
* armed.
|
|
35
|
+
*/
|
|
36
|
+
closeWithoutConfirmationGrants = /* @__PURE__ */ new Set();
|
|
37
|
+
/**
|
|
38
|
+
* The open state a `setOpen` call is currently applying. Handlers run before
|
|
39
|
+
* `isOpen` is assigned, so a handler that calls `setOpen` again would not be
|
|
40
|
+
* caught by the equality check at the top and would recurse.
|
|
41
|
+
*/
|
|
42
|
+
openStateInFlight;
|
|
43
|
+
constructor(options = {}) {
|
|
44
|
+
makeObservable(this, {
|
|
45
|
+
isOpen: observable,
|
|
46
|
+
isContentSuspended: observable,
|
|
47
|
+
showConfirmationModal: observable,
|
|
48
|
+
confirmOnCloseEnabled: computed,
|
|
49
|
+
open: action.bound,
|
|
50
|
+
close: action.bound,
|
|
51
|
+
toggle: action.bound,
|
|
52
|
+
setOpen: action.bound,
|
|
53
|
+
syncOpen: action.bound,
|
|
54
|
+
setIsContentSuspended: action.bound,
|
|
55
|
+
confirmClose: action.bound,
|
|
56
|
+
cancelConfirmation: action.bound
|
|
57
|
+
});
|
|
58
|
+
const { isDefaultOpen = false, confirmOnClose = false } = options;
|
|
59
|
+
this.isOpen = isDefaultOpen;
|
|
60
|
+
this.confirmOnCloseFromOptions = confirmOnClose;
|
|
61
|
+
}
|
|
62
|
+
/** Whether closing this overlay currently requires a confirmation. */
|
|
63
|
+
get confirmOnCloseEnabled() {
|
|
64
|
+
if (this.confirmOnCloseSources.size === 0) return this.confirmOnCloseFromOptions;
|
|
65
|
+
return Array.from(this.confirmOnCloseSources.values()).some(Boolean);
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Sets the opinion of one source – any object the caller keeps – on close
|
|
69
|
+
* confirmation. Remove the source again when its owner goes away.
|
|
70
|
+
*
|
|
71
|
+
* @internal Bindings call it from their lifecycle.
|
|
72
|
+
*/
|
|
73
|
+
setConfirmOnCloseSource(source, confirmOnClose) {
|
|
74
|
+
runInAction(() => this.confirmOnCloseSources.set(source, confirmOnClose));
|
|
75
|
+
}
|
|
76
|
+
/** @internal Bindings call it from their lifecycle. */
|
|
77
|
+
removeConfirmOnCloseSource(source) {
|
|
78
|
+
runInAction(() => this.confirmOnCloseSources.delete(source));
|
|
79
|
+
}
|
|
80
|
+
addOpenStateHandler(handler, handlersSet) {
|
|
81
|
+
handlersSet.add(handler);
|
|
82
|
+
return () => {
|
|
83
|
+
handlersSet.delete(handler);
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
executeHandlers(isOpen, handlers) {
|
|
87
|
+
return Array.from(handlers).map((handler) => handler(isOpen)).some((result) => result === false);
|
|
88
|
+
}
|
|
89
|
+
executeOnClose() {
|
|
90
|
+
return this.executeHandlers(false, this.onCloseHandlers);
|
|
91
|
+
}
|
|
92
|
+
executeOnOpen() {
|
|
93
|
+
return this.executeHandlers(true, this.onOpenHandlers);
|
|
94
|
+
}
|
|
95
|
+
executeOnOpenChange(isOpen) {
|
|
96
|
+
return this.executeHandlers(isOpen, this.onOpenChangeHandlers);
|
|
97
|
+
}
|
|
98
|
+
addOnClose(handler) {
|
|
99
|
+
return this.addOpenStateHandler(handler, this.onCloseHandlers);
|
|
100
|
+
}
|
|
101
|
+
addOnOpen(handler) {
|
|
102
|
+
return this.addOpenStateHandler(handler, this.onOpenHandlers);
|
|
103
|
+
}
|
|
104
|
+
addOnOpenChange(handler) {
|
|
105
|
+
return this.addOpenStateHandler(handler, this.onOpenChangeHandlers);
|
|
106
|
+
}
|
|
107
|
+
open() {
|
|
108
|
+
this.setOpen(true);
|
|
109
|
+
}
|
|
110
|
+
close(options) {
|
|
111
|
+
this.setOpen(false, options);
|
|
112
|
+
}
|
|
113
|
+
toggle() {
|
|
114
|
+
this.setOpen(!this.isOpen);
|
|
115
|
+
}
|
|
116
|
+
setOpen(toOpen, options) {
|
|
117
|
+
if (this.isOpen === toOpen || this.openStateInFlight === toOpen) return;
|
|
118
|
+
this.openStateInFlight = toOpen;
|
|
119
|
+
try {
|
|
120
|
+
this.applyOpenState(toOpen, options);
|
|
121
|
+
} finally {
|
|
122
|
+
this.openStateInFlight = void 0;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Sets the open state without running any handler. Use it to mirror a
|
|
127
|
+
* controlled `isOpen` prop, whose change comes from the consumer – notifying
|
|
128
|
+
* them of their own state would echo it back.
|
|
129
|
+
*/
|
|
130
|
+
syncOpen(toOpen) {
|
|
131
|
+
this.isOpen = toOpen;
|
|
132
|
+
}
|
|
133
|
+
applyOpenState(toOpen, options) {
|
|
134
|
+
const { bypassConfirmation = false } = options ?? {};
|
|
135
|
+
if (toOpen === false) {
|
|
136
|
+
const closeIsConfirmed = this.closeIsConfirmed;
|
|
137
|
+
this.closeIsConfirmed = false;
|
|
138
|
+
if (this.confirmOnCloseEnabled && !closeIsConfirmed && this.closeWithoutConfirmationGrants.size === 0 && !bypassConfirmation) {
|
|
139
|
+
this.showConfirmationModal = true;
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
let aborted;
|
|
144
|
+
if (toOpen) aborted = this.executeOnOpen();
|
|
145
|
+
else aborted = this.executeOnClose();
|
|
146
|
+
if (!aborted) aborted = this.executeOnOpenChange(toOpen);
|
|
147
|
+
if (!aborted) this.isOpen = toOpen;
|
|
148
|
+
}
|
|
149
|
+
setIsContentSuspended(to) {
|
|
150
|
+
this.isContentSuspended = to;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Allows closing this overlay without a confirmation until the returned
|
|
154
|
+
* disposer is called. Use it around an operation that may legitimately close
|
|
155
|
+
* the overlay – e.g. a `Form` submit, where a "discard unsaved changes?"
|
|
156
|
+
* prompt would be nonsense – and dispose it as soon as that operation has
|
|
157
|
+
* finished. An operation that ends without closing the overlay therefore
|
|
158
|
+
* leaves the confirmation armed (#2775).
|
|
159
|
+
*/
|
|
160
|
+
grantCloseWithoutConfirmation() {
|
|
161
|
+
const grant = {};
|
|
162
|
+
this.closeWithoutConfirmationGrants.add(grant);
|
|
163
|
+
return () => {
|
|
164
|
+
this.closeWithoutConfirmationGrants.delete(grant);
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
confirmClose() {
|
|
168
|
+
this.closeIsConfirmed = true;
|
|
169
|
+
this.showConfirmationModal = false;
|
|
170
|
+
}
|
|
171
|
+
cancelConfirmation() {
|
|
172
|
+
this.showConfirmationModal = false;
|
|
173
|
+
}
|
|
174
|
+
};
|
|
175
|
+
//#endregion
|
|
176
|
+
export { OverlayState };
|
|
177
|
+
|
|
178
|
+
//# sourceMappingURL=OverlayState.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OverlayState.mjs","names":[],"sources":["../../../../../../../components-base/src/overlay/OverlayState.ts"],"sourcesContent":["import {\n action,\n computed,\n makeObservable,\n observable,\n runInAction,\n} from \"mobx\";\n\nexport type OverlayOpenHandler = () => unknown;\nexport type OverlayCloseHandler = () => unknown;\nexport type OverlayOpenStateHandler = (isOpen: boolean) => unknown;\nexport type AnyOverlayOpenStateHandler =\n OverlayOpenHandler | OverlayCloseHandler | OverlayOpenStateHandler;\n\nexport type DisposerFn = () => void;\n\nexport interface OverlayCloseOptions {\n /** Close without asking, even when the overlay requires confirmation. */\n bypassConfirmation?: boolean;\n}\n\nexport interface OverlayStateOptions {\n isDefaultOpen?: boolean;\n /**\n * Whether closing the overlay must be confirmed while no source has an\n * opinion (`setConfirmOnCloseSource`).\n */\n confirmOnClose?: boolean;\n}\n\n/**\n * Whether an overlay is open, and whether closing it has to be confirmed first.\n * Each binding adds its subscription and its lifecycle: React's\n * `OverlayController` subclasses it, Vue's adapter wraps it in refs.\n *\n * `TCloseOptions` lets a binding pass more on a close than the state reads —\n * React's `overlay`, resolved by `Action` before the close arrives here.\n */\nexport class OverlayState<\n TCloseOptions extends OverlayCloseOptions = OverlayCloseOptions,\n> {\n public isOpen = false;\n public isContentSuspended = false;\n private onOpenHandlers = new Set<OverlayOpenHandler>();\n private onCloseHandlers = new Set<OverlayCloseHandler>();\n private onOpenChangeHandlers = new Set<OverlayOpenStateHandler>();\n\n public showConfirmationModal = false;\n public closeIsConfirmed = false;\n private readonly confirmOnCloseFromOptions: boolean;\n /**\n * Every mounted component that has an opinion on close confirmation\n * contributes one entry here – e.g. a `Modal` with a `confirmOnClose` prop\n * and a `Form` tracking its dirty state. Combining them instead of assigning\n * a single flag keeps them from overwriting each other.\n */\n private confirmOnCloseSources = observable.map<object, boolean>();\n /**\n * Active grants that allow closing without a confirmation. Each entry is\n * scoped to an ongoing operation that legitimately closes the overlay – e.g.\n * a `Form` submit – and is dropped again when that operation has finished, so\n * an operation that does _not_ close the overlay leaves the confirmation\n * armed.\n */\n private closeWithoutConfirmationGrants = new Set<object>();\n /**\n * The open state a `setOpen` call is currently applying. Handlers run before\n * `isOpen` is assigned, so a handler that calls `setOpen` again would not be\n * caught by the equality check at the top and would recurse.\n */\n private openStateInFlight: boolean | undefined;\n\n public constructor(options: OverlayStateOptions = {}) {\n makeObservable(this, {\n isOpen: observable,\n isContentSuspended: observable,\n showConfirmationModal: observable,\n confirmOnCloseEnabled: computed,\n open: action.bound,\n close: action.bound,\n toggle: action.bound,\n setOpen: action.bound,\n syncOpen: action.bound,\n setIsContentSuspended: action.bound,\n confirmClose: action.bound,\n cancelConfirmation: action.bound,\n });\n const { isDefaultOpen = false, confirmOnClose = false } = options;\n this.isOpen = isDefaultOpen;\n this.confirmOnCloseFromOptions = confirmOnClose;\n }\n\n /** Whether closing this overlay currently requires a confirmation. */\n public get confirmOnCloseEnabled(): boolean {\n if (this.confirmOnCloseSources.size === 0) {\n return this.confirmOnCloseFromOptions;\n }\n return Array.from(this.confirmOnCloseSources.values()).some(Boolean);\n }\n\n /**\n * Sets the opinion of one source – any object the caller keeps – on close\n * confirmation. Remove the source again when its owner goes away.\n *\n * @internal Bindings call it from their lifecycle.\n */\n public setConfirmOnCloseSource(source: object, confirmOnClose: boolean) {\n runInAction(() => this.confirmOnCloseSources.set(source, confirmOnClose));\n }\n\n /** @internal Bindings call it from their lifecycle. */\n public removeConfirmOnCloseSource(source: object) {\n runInAction(() => this.confirmOnCloseSources.delete(source));\n }\n\n private addOpenStateHandler<T extends AnyOverlayOpenStateHandler>(\n handler: T,\n handlersSet: Set<T>,\n ): DisposerFn {\n handlersSet.add(handler);\n return () => {\n handlersSet.delete(handler);\n };\n }\n\n private executeHandlers(\n isOpen: boolean,\n handlers: Set<\n OverlayOpenHandler | OverlayCloseHandler | OverlayOpenStateHandler\n >,\n ): boolean {\n const handlerResult = Array.from(handlers).map((handler) =>\n handler(isOpen),\n );\n return handlerResult.some((result) => result === false);\n }\n\n private executeOnClose(): boolean {\n return this.executeHandlers(false, this.onCloseHandlers);\n }\n\n private executeOnOpen(): boolean {\n return this.executeHandlers(true, this.onOpenHandlers);\n }\n\n private executeOnOpenChange(isOpen: boolean): boolean {\n return this.executeHandlers(isOpen, this.onOpenChangeHandlers);\n }\n\n public addOnClose(handler: OverlayCloseHandler) {\n return this.addOpenStateHandler(handler, this.onCloseHandlers);\n }\n\n public addOnOpen(handler: OverlayOpenHandler) {\n return this.addOpenStateHandler(handler, this.onOpenHandlers);\n }\n\n public addOnOpenChange(handler: OverlayOpenStateHandler) {\n return this.addOpenStateHandler(handler, this.onOpenChangeHandlers);\n }\n\n public open(): void {\n this.setOpen(true);\n }\n\n public close(options?: TCloseOptions): void {\n this.setOpen(false, options);\n }\n\n public toggle(): void {\n this.setOpen(!this.isOpen);\n }\n\n public setOpen(toOpen: boolean, options?: TCloseOptions): void {\n if (this.isOpen === toOpen || this.openStateInFlight === toOpen) {\n return;\n }\n\n this.openStateInFlight = toOpen;\n try {\n this.applyOpenState(toOpen, options);\n } finally {\n this.openStateInFlight = undefined;\n }\n }\n\n /**\n * Sets the open state without running any handler. Use it to mirror a\n * controlled `isOpen` prop, whose change comes from the consumer – notifying\n * them of their own state would echo it back.\n */\n public syncOpen(toOpen: boolean): void {\n this.isOpen = toOpen;\n }\n\n private applyOpenState(toOpen: boolean, options?: TCloseOptions): void {\n const { bypassConfirmation = false } = options ?? {};\n\n if (toOpen === false) {\n // The confirmation is a one-shot permission for exactly this close\n // attempt – consume it here instead of only when a close succeeds, so it\n // cannot survive an aborted close and disarm later attempts.\n const closeIsConfirmed = this.closeIsConfirmed;\n this.closeIsConfirmed = false;\n\n if (\n this.confirmOnCloseEnabled &&\n !closeIsConfirmed &&\n this.closeWithoutConfirmationGrants.size === 0 &&\n !bypassConfirmation\n ) {\n this.showConfirmationModal = true;\n return;\n }\n }\n\n let aborted: boolean;\n if (toOpen) {\n aborted = this.executeOnOpen();\n } else {\n aborted = this.executeOnClose();\n }\n if (!aborted) {\n aborted = this.executeOnOpenChange(toOpen);\n }\n\n if (!aborted) {\n this.isOpen = toOpen;\n }\n }\n\n public setIsContentSuspended(to: boolean): void {\n this.isContentSuspended = to;\n }\n\n /**\n * Allows closing this overlay without a confirmation until the returned\n * disposer is called. Use it around an operation that may legitimately close\n * the overlay – e.g. a `Form` submit, where a \"discard unsaved changes?\"\n * prompt would be nonsense – and dispose it as soon as that operation has\n * finished. An operation that ends without closing the overlay therefore\n * leaves the confirmation armed (#2775).\n */\n public grantCloseWithoutConfirmation(): DisposerFn {\n const grant = {};\n this.closeWithoutConfirmationGrants.add(grant);\n return () => {\n this.closeWithoutConfirmationGrants.delete(grant);\n };\n }\n\n public confirmClose(): void {\n this.closeIsConfirmed = true;\n this.showConfirmationModal = false;\n }\n\n public cancelConfirmation(): void {\n this.showConfirmationModal = false;\n }\n}\n"],"mappings":";;;;;;;;;;;;AAsCA,IAAa,eAAb,MAEE;CACA,SAAgB;CAChB,qBAA4B;CAC5B,iCAAyB,IAAI,IAAwB;CACrD,kCAA0B,IAAI,IAAyB;CACvD,uCAA+B,IAAI,IAA6B;CAEhE,wBAA+B;CAC/B,mBAA0B;CAC1B;;;;;;;CAOA,wBAAgC,WAAW,IAAqB;;;;;;;;CAQhE,iDAAyC,IAAI,IAAY;;;;;;CAMzD;CAEA,YAAmB,UAA+B,CAAC,GAAG;EACpD,eAAe,MAAM;GACnB,QAAQ;GACR,oBAAoB;GACpB,uBAAuB;GACvB,uBAAuB;GACvB,MAAM,OAAO;GACb,OAAO,OAAO;GACd,QAAQ,OAAO;GACf,SAAS,OAAO;GAChB,UAAU,OAAO;GACjB,uBAAuB,OAAO;GAC9B,cAAc,OAAO;GACrB,oBAAoB,OAAO;EAC7B,CAAC;EACD,MAAM,EAAE,gBAAgB,OAAO,iBAAiB,UAAU;EAC1D,KAAK,SAAS;EACd,KAAK,4BAA4B;CACnC;;CAGA,IAAW,wBAAiC;EAC1C,IAAI,KAAK,sBAAsB,SAAS,GACtC,OAAO,KAAK;EAEd,OAAO,MAAM,KAAK,KAAK,sBAAsB,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO;CACrE;;;;;;;CAQA,wBAA+B,QAAgB,gBAAyB;EACtE,kBAAkB,KAAK,sBAAsB,IAAI,QAAQ,cAAc,CAAC;CAC1E;;CAGA,2BAAkC,QAAgB;EAChD,kBAAkB,KAAK,sBAAsB,OAAO,MAAM,CAAC;CAC7D;CAEA,oBACE,SACA,aACY;EACZ,YAAY,IAAI,OAAO;EACvB,aAAa;GACX,YAAY,OAAO,OAAO;EAC5B;CACF;CAEA,gBACE,QACA,UAGS;EAIT,OAHsB,MAAM,KAAK,QAAQ,CAAC,CAAC,KAAK,YAC9C,QAAQ,MAAM,CAET,CAAA,CAAc,MAAM,WAAW,WAAW,KAAK;CACxD;CAEA,iBAAkC;EAChC,OAAO,KAAK,gBAAgB,OAAO,KAAK,eAAe;CACzD;CAEA,gBAAiC;EAC/B,OAAO,KAAK,gBAAgB,MAAM,KAAK,cAAc;CACvD;CAEA,oBAA4B,QAA0B;EACpD,OAAO,KAAK,gBAAgB,QAAQ,KAAK,oBAAoB;CAC/D;CAEA,WAAkB,SAA8B;EAC9C,OAAO,KAAK,oBAAoB,SAAS,KAAK,eAAe;CAC/D;CAEA,UAAiB,SAA6B;EAC5C,OAAO,KAAK,oBAAoB,SAAS,KAAK,cAAc;CAC9D;CAEA,gBAAuB,SAAkC;EACvD,OAAO,KAAK,oBAAoB,SAAS,KAAK,oBAAoB;CACpE;CAEA,OAAoB;EAClB,KAAK,QAAQ,IAAI;CACnB;CAEA,MAAa,SAA+B;EAC1C,KAAK,QAAQ,OAAO,OAAO;CAC7B;CAEA,SAAsB;EACpB,KAAK,QAAQ,CAAC,KAAK,MAAM;CAC3B;CAEA,QAAe,QAAiB,SAA+B;EAC7D,IAAI,KAAK,WAAW,UAAU,KAAK,sBAAsB,QACvD;EAGF,KAAK,oBAAoB;EACzB,IAAI;GACF,KAAK,eAAe,QAAQ,OAAO;EACrC,UAAU;GACR,KAAK,oBAAoB,KAAA;EAC3B;CACF;;;;;;CAOA,SAAgB,QAAuB;EACrC,KAAK,SAAS;CAChB;CAEA,eAAuB,QAAiB,SAA+B;EACrE,MAAM,EAAE,qBAAqB,UAAU,WAAW,CAAC;EAEnD,IAAI,WAAW,OAAO;GAIpB,MAAM,mBAAmB,KAAK;GAC9B,KAAK,mBAAmB;GAExB,IACE,KAAK,yBACL,CAAC,oBACD,KAAK,+BAA+B,SAAS,KAC7C,CAAC,oBACD;IACA,KAAK,wBAAwB;IAC7B;GACF;EACF;EAEA,IAAI;EACJ,IAAI,QACF,UAAU,KAAK,cAAc;OAE7B,UAAU,KAAK,eAAe;EAEhC,IAAI,CAAC,SACH,UAAU,KAAK,oBAAoB,MAAM;EAG3C,IAAI,CAAC,SACH,KAAK,SAAS;CAElB;CAEA,sBAA6B,IAAmB;EAC9C,KAAK,qBAAqB;CAC5B;;;;;;;;;CAUA,gCAAmD;EACjD,MAAM,QAAQ,CAAC;EACf,KAAK,+BAA+B,IAAI,KAAK;EAC7C,aAAa;GACX,KAAK,+BAA+B,OAAO,KAAK;EAClD;CACF;CAEA,eAA4B;EAC1B,KAAK,mBAAmB;EACxB,KAAK,wBAAwB;CAC/B;CAEA,qBAAkC;EAChC,KAAK,wBAAwB;CAC/B;AACF"}
|
|
@@ -21,3 +21,4 @@ export type { ListSortingShape, SortingDefaultMode, SortingFn, } from "./list/so
|
|
|
21
21
|
export { ListViewMode } from "./list/viewMode/ListViewMode";
|
|
22
22
|
export type { ListViewModeOptions, ListViewModeValue, } from "./list/viewMode/types";
|
|
23
23
|
export { customPropertyPrefix, type CustomPropertyName, type PropertyName, type PropertyValue, type PropertyValueRenderMethod, } from "./list/types";
|
|
24
|
+
export { OverlayState, type AnyOverlayOpenStateHandler, type DisposerFn, type OverlayCloseHandler, type OverlayCloseOptions, type OverlayOpenHandler, type OverlayOpenStateHandler, type OverlayStateOptions, } from "./overlay/OverlayState";
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
export type OverlayOpenHandler = () => unknown;
|
|
2
|
+
export type OverlayCloseHandler = () => unknown;
|
|
3
|
+
export type OverlayOpenStateHandler = (isOpen: boolean) => unknown;
|
|
4
|
+
export type AnyOverlayOpenStateHandler = OverlayOpenHandler | OverlayCloseHandler | OverlayOpenStateHandler;
|
|
5
|
+
export type DisposerFn = () => void;
|
|
6
|
+
export interface OverlayCloseOptions {
|
|
7
|
+
/** Close without asking, even when the overlay requires confirmation. */
|
|
8
|
+
bypassConfirmation?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface OverlayStateOptions {
|
|
11
|
+
isDefaultOpen?: boolean;
|
|
12
|
+
/**
|
|
13
|
+
* Whether closing the overlay must be confirmed while no source has an
|
|
14
|
+
* opinion (`setConfirmOnCloseSource`).
|
|
15
|
+
*/
|
|
16
|
+
confirmOnClose?: boolean;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Whether an overlay is open, and whether closing it has to be confirmed first.
|
|
20
|
+
* Each binding adds its subscription and its lifecycle: React's
|
|
21
|
+
* `OverlayController` subclasses it, Vue's adapter wraps it in refs.
|
|
22
|
+
*
|
|
23
|
+
* `TCloseOptions` lets a binding pass more on a close than the state reads —
|
|
24
|
+
* React's `overlay`, resolved by `Action` before the close arrives here.
|
|
25
|
+
*/
|
|
26
|
+
export declare class OverlayState<TCloseOptions extends OverlayCloseOptions = OverlayCloseOptions> {
|
|
27
|
+
isOpen: boolean;
|
|
28
|
+
isContentSuspended: boolean;
|
|
29
|
+
private onOpenHandlers;
|
|
30
|
+
private onCloseHandlers;
|
|
31
|
+
private onOpenChangeHandlers;
|
|
32
|
+
showConfirmationModal: boolean;
|
|
33
|
+
closeIsConfirmed: boolean;
|
|
34
|
+
private readonly confirmOnCloseFromOptions;
|
|
35
|
+
/**
|
|
36
|
+
* Every mounted component that has an opinion on close confirmation
|
|
37
|
+
* contributes one entry here – e.g. a `Modal` with a `confirmOnClose` prop
|
|
38
|
+
* and a `Form` tracking its dirty state. Combining them instead of assigning
|
|
39
|
+
* a single flag keeps them from overwriting each other.
|
|
40
|
+
*/
|
|
41
|
+
private confirmOnCloseSources;
|
|
42
|
+
/**
|
|
43
|
+
* Active grants that allow closing without a confirmation. Each entry is
|
|
44
|
+
* scoped to an ongoing operation that legitimately closes the overlay – e.g.
|
|
45
|
+
* a `Form` submit – and is dropped again when that operation has finished, so
|
|
46
|
+
* an operation that does _not_ close the overlay leaves the confirmation
|
|
47
|
+
* armed.
|
|
48
|
+
*/
|
|
49
|
+
private closeWithoutConfirmationGrants;
|
|
50
|
+
/**
|
|
51
|
+
* The open state a `setOpen` call is currently applying. Handlers run before
|
|
52
|
+
* `isOpen` is assigned, so a handler that calls `setOpen` again would not be
|
|
53
|
+
* caught by the equality check at the top and would recurse.
|
|
54
|
+
*/
|
|
55
|
+
private openStateInFlight;
|
|
56
|
+
constructor(options?: OverlayStateOptions);
|
|
57
|
+
/** Whether closing this overlay currently requires a confirmation. */
|
|
58
|
+
get confirmOnCloseEnabled(): boolean;
|
|
59
|
+
private addOpenStateHandler;
|
|
60
|
+
private executeHandlers;
|
|
61
|
+
private executeOnClose;
|
|
62
|
+
private executeOnOpen;
|
|
63
|
+
private executeOnOpenChange;
|
|
64
|
+
addOnClose(handler: OverlayCloseHandler): DisposerFn;
|
|
65
|
+
addOnOpen(handler: OverlayOpenHandler): DisposerFn;
|
|
66
|
+
addOnOpenChange(handler: OverlayOpenStateHandler): DisposerFn;
|
|
67
|
+
open(): void;
|
|
68
|
+
close(options?: TCloseOptions): void;
|
|
69
|
+
toggle(): void;
|
|
70
|
+
setOpen(toOpen: boolean, options?: TCloseOptions): void;
|
|
71
|
+
/**
|
|
72
|
+
* Sets the open state without running any handler. Use it to mirror a
|
|
73
|
+
* controlled `isOpen` prop, whose change comes from the consumer – notifying
|
|
74
|
+
* them of their own state would echo it back.
|
|
75
|
+
*/
|
|
76
|
+
syncOpen(toOpen: boolean): void;
|
|
77
|
+
private applyOpenState;
|
|
78
|
+
setIsContentSuspended(to: boolean): void;
|
|
79
|
+
/**
|
|
80
|
+
* Allows closing this overlay without a confirmation until the returned
|
|
81
|
+
* disposer is called. Use it around an operation that may legitimately close
|
|
82
|
+
* the overlay – e.g. a `Form` submit, where a "discard unsaved changes?"
|
|
83
|
+
* prompt would be nonsense – and dispose it as soon as that operation has
|
|
84
|
+
* finished. An operation that ends without closing the overlay therefore
|
|
85
|
+
* leaves the confirmation armed (#2775).
|
|
86
|
+
*/
|
|
87
|
+
grantCloseWithoutConfirmation(): DisposerFn;
|
|
88
|
+
confirmClose(): void;
|
|
89
|
+
cancelConfirmation(): void;
|
|
90
|
+
}
|