-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathupdateFocussedState.ts
More file actions
488 lines (448 loc) · 18.4 KB
/
updateFocussedState.ts
File metadata and controls
488 lines (448 loc) · 18.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
import { VisualBuilder } from "..";
import { extractDetailsFromCslp } from "../../cslp";
import { getAddInstanceButtons } from "../generators/generateAddInstanceButtons";
import {
addFocusOverlay,
hideFocusOverlay,
} from "../generators/generateOverlay";
import { hideHoverOutline } from "../listeners/mouseHover";
import {
LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX,
RIGHT_EDGE_BUFFER,
TOOLBAR_EDGE_BUFFER,
TOP_EDGE_BUFFER,
} from "./constants";
import { FieldSchemaMap } from "./fieldSchemaMap";
import getChildrenDirection from "./getChildrenDirection";
import { getPsuedoEditableElementStyles } from "./getPsuedoEditableStylesElement";
import { isFieldDisabled } from "./isFieldDisabled";
import { fetchEntryPermissionsAndStageDetails } from "./fetchEntryPermissionsAndStageDetails";
import {
removeTruncateStyles,
restoreTruncateStyles,
hasStoredLineClampStyles,
} from "./truncateHandler";
interface ToolbarPositionParams {
focusedToolbar: HTMLElement | null;
selectedElementDimension: DOMRect;
}
/**
* Adjust the position of the field toolbar instead of clearing the innerhtml fo the focused toolbar.
* By doing this, can avoid the re-rendering of the focus field toolbar.
*/
function positionToolbar({
focusedToolbar,
selectedElementDimension,
}: ToolbarPositionParams): void {
if (focusedToolbar) {
const targetElementRightEdgeOffset =
window.scrollX + window.innerWidth - selectedElementDimension.left;
const distanceFromTop =
selectedElementDimension.top + window.scrollY - TOOLBAR_EDGE_BUFFER;
// Adjust top position based on the available space
const adjustedDistanceFromTop =
selectedElementDimension.top + window.scrollY < TOP_EDGE_BUFFER
? distanceFromTop +
selectedElementDimension.height +
TOP_EDGE_BUFFER
: distanceFromTop;
const distanceFromLeft =
selectedElementDimension.left - LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX;
const adjustedDistanceFromLeft = Math.max(
distanceFromLeft,
TOOLBAR_EDGE_BUFFER
);
// Handle right-edge overflow
if (
targetElementRightEdgeOffset < RIGHT_EDGE_BUFFER &&
(focusedToolbar.style.justifyContent !== "flex-end" ||
focusedToolbar.style.left !==
`${selectedElementDimension.right + LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX}px`)
) {
focusedToolbar.style.justifyContent = "flex-end";
focusedToolbar.style.left = `${selectedElementDimension.right + LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX}px`;
} else if (
focusedToolbar.style.justifyContent !== "flex-start" ||
focusedToolbar.style.left !== `${adjustedDistanceFromLeft}px`
) {
focusedToolbar.style.justifyContent = "flex-start"; // Default
focusedToolbar.style.left = `${adjustedDistanceFromLeft}px`;
}
// Adjust top position if necessary
if (focusedToolbar.style.top !== `${adjustedDistanceFromTop}px`) {
focusedToolbar.style.top = `${adjustedDistanceFromTop}px`;
}
}
}
/**
* This function can be used to re-draw/update the focussed state of an element.
* The focussed state includes the overlay, psuedo-editable, toolbar, and multiple
* instance add buttons. It is similar to handleBuilderInteraction but it does not
* create new elements, it just updates the existing ones whenever possible.
* NOTE: breakdown this function into multiple functions when the need arises
*/
export async function updateFocussedState({
editableElement,
visualBuilderContainer,
overlayWrapper,
focusedToolbar,
resizeObserver,
}: {
editableElement: HTMLElement | null;
visualBuilderContainer: HTMLDivElement | null;
overlayWrapper: HTMLDivElement | null;
focusedToolbar: HTMLDivElement | null;
resizeObserver: ResizeObserver | null;
}): Promise<void> {
let previousSelectedEditableDOM =
VisualBuilder.VisualBuilderGlobalState.value
.previousSelectedEditableDOM;
if (
!visualBuilderContainer ||
!editableElement ||
!previousSelectedEditableDOM ||
!overlayWrapper
) {
return;
}
// prefer data-cslp-unique-id when available else use data-cslp.
// unique ID is added on click when multiple elements with same
// data-cslp are found.
const previousSelectedElementCslp =
editableElement?.getAttribute("data-cslp") || "";
const previousSelectedElementCslpUniqueId =
previousSelectedEditableDOM?.getAttribute("data-cslp-unique-id");
const newPreviousSelectedElement =
document.querySelector(
`[data-cslp-unique-id="${previousSelectedElementCslpUniqueId}"]`
) ||
document.querySelector(`[data-cslp="${previousSelectedElementCslp}"]`);
if (!newPreviousSelectedElement && resizeObserver) {
hideFocusOverlay({
visualBuilderOverlayWrapper: overlayWrapper,
focusedToolbar,
visualBuilderContainer,
resizeObserver,
noTrigger: true,
});
return;
}
if (newPreviousSelectedElement !== previousSelectedEditableDOM) {
previousSelectedEditableDOM = newPreviousSelectedElement as HTMLElement;
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
previousSelectedEditableDOM;
}
const cslp = editableElement?.getAttribute("data-cslp") || "";
const fieldMetadata = extractDetailsFromCslp(cslp);
hideHoverOutline(visualBuilderContainer);
// Remove line-clamp styles from the currently focused element
if (editableElement) {
removeTruncateStyles(editableElement);
}
// in every case, this function will bring cached values
// and this should be quick
const fieldSchema = await FieldSchemaMap.getFieldSchema(
fieldMetadata.content_type_uid,
fieldMetadata.fieldPath
);
const { acl: entryAcl, workflowStage: entryWorkflowStageDetails } =
await fetchEntryPermissionsAndStageDetails({
entryUid: fieldMetadata.entry_uid,
contentTypeUid: fieldMetadata.content_type_uid,
locale: fieldMetadata.locale,
variantUid: fieldMetadata.variant,
});
const { isDisabled } = isFieldDisabled(
fieldSchema,
{ editableElement, fieldMetadata },
entryAcl,
entryWorkflowStageDetails
);
addFocusOverlay(previousSelectedEditableDOM, overlayWrapper, isDisabled);
// update psuedo editable element if present
const psuedoEditableElement = visualBuilderContainer.querySelector(
".visual-builder__pseudo-editable-element"
) as HTMLElement;
if (psuedoEditableElement) {
const styles = getPsuedoEditableElementStyles(editableElement);
const styleString = Object.entries(styles).reduce(
(acc, [key, value]) => {
return `${acc}${key}:${value};`;
},
""
);
psuedoEditableElement.style.cssText = styleString;
// since we are copying styles from the editableEl
// it will now have a visibility of hidden, which we added
// when creating the pseudo editable element, so make the psuedo visible
psuedoEditableElement.style.visibility = "visible";
}
const targetElementDimension = editableElement.getBoundingClientRect();
if (targetElementDimension.width && targetElementDimension.height) {
const selectedElement =
VisualBuilder.VisualBuilderGlobalState.value
.previousSelectedEditableDOM;
if (!selectedElement) return;
// position the focused tool bar
positionToolbar({
focusedToolbar: focusedToolbar,
selectedElementDimension: selectedElement.getBoundingClientRect(),
});
}
// re-add multiple instance add buttons
const buttons = getAddInstanceButtons(visualBuilderContainer);
const parentCslpValue =
fieldMetadata.multipleFieldMetadata?.parentDetails?.parentCslpValue;
if (
buttons &&
parentCslpValue &&
buttons.length > 1 &&
buttons[0] &&
buttons[1]
) {
const [previousButton, nextButton] = buttons;
const direction = getChildrenDirection(
editableElement,
parentCslpValue
);
const targetDOMDimension = editableElement.getBoundingClientRect();
if (direction === "horizontal") {
const middleHeight =
targetDOMDimension.top +
(targetDOMDimension.bottom - targetDOMDimension.top) / 2 +
window.scrollY;
previousButton.style.left = `${targetDOMDimension.left}px`;
previousButton.style.top = `${middleHeight}px`;
nextButton.style.left = `${targetDOMDimension.right}px`;
nextButton.style.top = `${middleHeight}px`;
} else if (direction === "vertical") {
const middleWidth =
targetDOMDimension.left +
(targetDOMDimension.right - targetDOMDimension.left) / 2;
previousButton.style.left = `${middleWidth}px`;
previousButton.style.top = `${
targetDOMDimension.top + window.scrollY
}px`;
nextButton.style.left = `${middleWidth}px`;
nextButton.style.top = `${
targetDOMDimension.bottom + window.scrollY
}px`;
}
}
}
/**
* This function is used to resize/reposition focus overlay and toolbar due to a
* mutation in the DOM or due to changes in a different field (other than the focussed field).
*/
export function updateFocussedStateOnMutation(
focusOverlayWrapper: HTMLDivElement | null,
focusedToolbar: HTMLDivElement | null,
visualBuilderContainer: HTMLDivElement | null,
resizeObserver: ResizeObserver | null
) {
if (!focusOverlayWrapper) return;
let selectedElement =
VisualBuilder.VisualBuilderGlobalState.value
.previousSelectedEditableDOM;
if (!selectedElement) return;
const selectedElementCslp = selectedElement?.getAttribute("data-cslp");
const selectedElementCslpUniqueId = selectedElement?.getAttribute(
"data-cslp-unique-id"
);
const newSelectedElement =
document.querySelector(
`[data-cslp-unique-id="${selectedElementCslpUniqueId}"]`
) || document.querySelector(`[data-cslp="${selectedElementCslp}"]`);
if (!newSelectedElement && resizeObserver) {
// Restore truncate styles for the selected element before hiding focus
if (selectedElement && hasStoredLineClampStyles(selectedElement)) {
restoreTruncateStyles(selectedElement);
}
hideFocusOverlay({
visualBuilderOverlayWrapper: focusOverlayWrapper,
focusedToolbar,
visualBuilderContainer,
resizeObserver,
noTrigger: true,
});
return;
}
if (newSelectedElement !== selectedElement) {
selectedElement = newSelectedElement as HTMLElement;
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
selectedElement;
}
const selectedElementDimension = selectedElement.getBoundingClientRect();
/**
* Update the focus outline if it exists.
*/
const focusOutline = focusOverlayWrapper.querySelector<HTMLDivElement>(
".visual-builder__overlay--outline"
);
if (focusOutline) {
const focusOutlineDimension = focusOutline.getBoundingClientRect();
if (!isSameRect(selectedElementDimension, focusOutlineDimension)) {
focusOutline.style.top = `${selectedElementDimension.top + window.scrollY}px`;
focusOutline.style.left = `${selectedElementDimension.left}px`;
focusOutline.style.width = `${selectedElementDimension.width}px`;
focusOutline.style.height = `${selectedElementDimension.height}px`;
}
}
/**
* Update the focus overlays if they exists.
*/
const focusedOverlayTop = focusOverlayWrapper.querySelector<HTMLDivElement>(
".visual-builder__overlay--top"
);
const focusedOverlayBottom =
focusOverlayWrapper.querySelector<HTMLDivElement>(
".visual-builder__overlay--bottom"
);
const focusedOverlayLeft =
focusOverlayWrapper.querySelector<HTMLDivElement>(
".visual-builder__overlay--left"
);
const focusedOverlayRight =
focusOverlayWrapper.querySelector<HTMLDivElement>(
".visual-builder__overlay--right"
);
const distanceFromTop = selectedElementDimension.top + window.scrollY;
if (focusedOverlayTop) {
const dimension = focusedOverlayTop.getBoundingClientRect();
if (dimension.height !== distanceFromTop) {
focusedOverlayTop.style.height = `calc(${distanceFromTop}px)`;
}
}
if (focusedOverlayBottom) {
const dimension = focusedOverlayBottom.getBoundingClientRect();
if (
dimension.top !== selectedElementDimension.bottom ||
dimension.height !==
window.document.body.scrollHeight -
selectedElementDimension.bottom -
window.scrollY
) {
focusedOverlayBottom.style.top = `${
selectedElementDimension.bottom + window.scrollY
}px`;
focusedOverlayBottom.style.height = `${
window.document.body.scrollHeight -
selectedElementDimension.bottom -
window.scrollY
}px`;
}
}
if (focusedOverlayLeft) {
const dimension = focusedOverlayLeft.getBoundingClientRect();
if (
dimension.top + window.scrollY !== distanceFromTop ||
dimension.height !== selectedElementDimension.height ||
dimension.width !== selectedElementDimension.left
) {
focusedOverlayLeft.style.top = `${distanceFromTop}px`;
focusedOverlayLeft.style.height = `${selectedElementDimension.height}px`;
focusedOverlayLeft.style.width = `${selectedElementDimension.left}px`;
}
}
if (focusedOverlayRight) {
const dimension = focusedOverlayRight.getBoundingClientRect();
if (
dimension.left !== selectedElementDimension.right ||
dimension.top + window.scrollY !== distanceFromTop ||
dimension.height !== selectedElementDimension.height ||
dimension.width !==
document.documentElement.clientWidth -
selectedElementDimension.right
) {
focusedOverlayRight.style.left = `${selectedElementDimension.right}px`;
focusedOverlayRight.style.top = `${distanceFromTop}px`;
focusedOverlayRight.style.height = `${selectedElementDimension.height}px`;
focusedOverlayRight.style.width = `${
document.documentElement.clientWidth -
selectedElementDimension.right
}px`;
}
}
/**
* Update the focus toolbar if it exists.
*/
if (focusedToolbar) {
const targetElementRightEdgeOffset =
window.scrollX + window.innerWidth - selectedElementDimension.left;
const distanceFromTop =
selectedElementDimension.top + window.scrollY - TOOLBAR_EDGE_BUFFER;
// Position the toolbar at the top unless there's insufficient space or scrolling up is not possible (topmost element targetted).
const adjustedDistanceFromTop =
selectedElementDimension.top + window.scrollY < TOP_EDGE_BUFFER
? distanceFromTop +
selectedElementDimension.height +
TOP_EDGE_BUFFER
: distanceFromTop;
const distanceFromLeft =
selectedElementDimension.left - LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX;
const adjustedDistanceFromLeft = Math.max(
distanceFromLeft,
TOOLBAR_EDGE_BUFFER
);
if (
targetElementRightEdgeOffset < RIGHT_EDGE_BUFFER &&
(focusedToolbar.style.justifyContent !== "flex-end" ||
focusedToolbar.style.left !==
`${
selectedElementDimension.right +
LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX
}px`)
) {
// Overflow / Cutoff on right edge
focusedToolbar.style.justifyContent = "flex-end";
focusedToolbar.style.left = `${
selectedElementDimension.right +
LIVE_PREVIEW_OUTLINE_WIDTH_IN_PX
}px`;
} else if (
focusedToolbar.style.justifyContent !== "flex-start" ||
focusedToolbar.style.left !== `${adjustedDistanceFromLeft}px`
) {
focusedToolbar.style.justifyContent = "flex-start"; // default
focusedToolbar.style.left = `${adjustedDistanceFromLeft}px`;
}
if (focusedToolbar.style.top !== `${adjustedDistanceFromTop}px`) {
focusedToolbar.style.top = `${adjustedDistanceFromTop}px`;
}
}
/**
* Update the pseudo-editable if it exists.
*/
if (visualBuilderContainer) {
const psuedoEditableElement = visualBuilderContainer.querySelector(
".visual-builder__pseudo-editable-element"
) as HTMLElement;
const editableElement = selectedElement as HTMLElement;
const styles = getPsuedoEditableElementStyles(editableElement);
const styleString = Object.entries(styles).reduce(
(acc, [key, value]) => {
return `${acc}${key}:${value};`;
},
""
);
if (
psuedoEditableElement &&
(psuedoEditableElement.style.cssText !== styleString ||
psuedoEditableElement.style.visibility !== "visible")
) {
psuedoEditableElement.style.cssText = styleString;
// since we are copying styles from the editableEl
// it will now have a visibility of hidden, which we added
// when creating the pseudo editable element, so make the psuedo visible
psuedoEditableElement.style.visibility = "visible";
}
}
}
function isSameRect(rect1: DOMRect, rect2: DOMRect) {
return (
rect1.top === rect2.top &&
rect1.left === rect2.left &&
rect1.width === rect2.width &&
rect1.height === rect2.height
);
}