@focus-reactive/payload-plugin-visual-editing 1.1.0 → 1.1.1
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/README.md
CHANGED
|
@@ -177,7 +177,7 @@ bunx payload generate:importmap
|
|
|
177
177
|
|
|
178
178
|
### Using it
|
|
179
179
|
|
|
180
|
-
Open a document in the admin, open the **Live Preview** side panel (it loads the frontend in draft mode), then flip the floating toggle to **Always** or **Hover**. Editable text shows an outline and an **Edit** badge; clicking it focuses that field in the admin form. To leave draft mode when viewing the frontend directly, hit `/next/exit-preview`.
|
|
180
|
+
Open a document in the admin, open the **Live Preview** side panel (it loads the frontend in draft mode), then flip the floating toggle to **Always** or **Hover**. Editable text shows an outline and an **Edit** badge; clicking it focuses that field in the admin form. A plain click anywhere on a highlighted element opens its field too; a modifier-click or a text selection keeps the page's normal behavior. To leave draft mode when viewing the frontend directly, hit `/next/exit-preview`.
|
|
181
181
|
|
|
182
182
|
## Editable richText and upload fields
|
|
183
183
|
|
|
@@ -7,7 +7,10 @@ import { createMutationPipeline } from "./mutationPipeline.js";
|
|
|
7
7
|
import { createStegaBookkeeper } from "./stegaBookkeeper.js";
|
|
8
8
|
import { collectAttrMatches, collectTextMatches } from "./stegaScanner.js";
|
|
9
9
|
import { createTargetRegistry } from "./targetRegistry.js";
|
|
10
|
-
import { pickTargetForGroup } from "./targetSelector.js";
|
|
10
|
+
import { findTargetAncestor, pickTargetForGroup } from "./targetSelector.js";
|
|
11
|
+
const isPlainPrimaryClick = (event)=>event.button === 0 && !event.metaKey && !event.ctrlKey && !event.shiftKey && !event.altKey;
|
|
12
|
+
const hasTextSelection = ()=>document.getSelection()?.isCollapsed === false;
|
|
13
|
+
const isRepeatedClick = (event)=>event.detail > 1;
|
|
11
14
|
// Wires every overlay submodule and returns a dispose that tears them down in reverse order.
|
|
12
15
|
// `getCtx` is a getter so the callsite (the hook) can stabilize its useEffect dependency array
|
|
13
16
|
// on just `[enabled]` while still seeing fresh ctx when a target is registered.
|
|
@@ -68,7 +71,23 @@ export function createOverlay(main, getCtx) {
|
|
|
68
71
|
},
|
|
69
72
|
onTextReset: (node)=>bookkeeper.forgetText(node)
|
|
70
73
|
});
|
|
74
|
+
const openFieldOnTargetClick = (event)=>{
|
|
75
|
+
if (!isPlainPrimaryClick(event)) return;
|
|
76
|
+
const target = findTargetAncestor(event.target instanceof Element ? event.target : null);
|
|
77
|
+
const config = target ? registry.get(target) : undefined;
|
|
78
|
+
if (!config) return;
|
|
79
|
+
if (isRepeatedClick(event)) {
|
|
80
|
+
event.preventDefault();
|
|
81
|
+
event.stopPropagation();
|
|
82
|
+
return;
|
|
83
|
+
}
|
|
84
|
+
if (hasTextSelection()) return;
|
|
85
|
+
event.stopPropagation();
|
|
86
|
+
config.clickHandler(event);
|
|
87
|
+
};
|
|
88
|
+
main.addEventListener("click", openFieldOnTargetClick, true);
|
|
71
89
|
return ()=>{
|
|
90
|
+
main.removeEventListener("click", openFieldOnTargetClick, true);
|
|
72
91
|
pipeline.dispose();
|
|
73
92
|
hover.dispose();
|
|
74
93
|
registry.disposeAll();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/client/overlay/createOverlay.ts"],"sourcesContent":["import type { BuildAdminEditUrl } from \"../buildAdminEditUrl.js\";\nimport type { Marker } from \"./markerExtractor.js\";\nimport type { TextMatch } from \"./stegaScanner.js\";\n\nimport { DATA_VE_PATH_ATTR } from \"../../constants.js\";\nimport { LABEL_CLASS } from \"./constants.js\";\nimport { createEditBadge } from \"./editBadge.js\";\nimport { createHoverController } from \"./hoverController.js\";\nimport { groupNodesByPath, readMarkerFromAttrs } from \"./markerExtractor.js\";\nimport { createMutationPipeline } from \"./mutationPipeline.js\";\nimport { createStegaBookkeeper } from \"./stegaBookkeeper.js\";\nimport { collectAttrMatches, collectTextMatches } from \"./stegaScanner.js\";\nimport { createTargetRegistry } from \"./targetRegistry.js\";\nimport { pickTargetForGroup } from \"./targetSelector.js\";\n\nexport type OverlayCtx = {\n buildAdminEditUrl: BuildAdminEditUrl;\n adminOrigin: string;\n adminBasePath: string;\n locale?: string;\n /** 'always' paints outlines on every editable target; 'hover' paints only the hovered one.\n * 'off' is handled by not mounting the overlay at all, so it never reaches this module. */\n mode: \"always\" | \"hover\";\n};\n\n// Wires every overlay submodule and returns a dispose that tears them down in reverse order.\n// `getCtx` is a getter so the callsite (the hook) can stabilize its useEffect dependency array\n// on just `[enabled]` while still seeing fresh ctx when a target is registered.\nexport function createOverlay(main: HTMLElement, getCtx: () => OverlayCtx): () => void {\n // Fast Refresh may skip the cleanup from a previous effect run — purge any leftover labels.\n // Outline and target attrs are owned by the registry now (disposal restores them), so leftover\n // attrs only exist if a crash skipped cleanup entirely; rare enough to not warrant a scan.\n for (const leftover of Array.from(document.querySelectorAll<HTMLElement>(`.${LABEL_CLASS}`))) {\n leftover.remove();\n }\n\n const bookkeeper = createStegaBookkeeper();\n const registry = createTargetRegistry();\n const badge = createEditBadge();\n const hover = createHoverController(badge, registry);\n\n const applyOverlay = (target: HTMLElement, marker: Marker): boolean => {\n const existing = registry.get(target);\n if (existing && existing.path === marker.path) return false;\n registry.upsert(target, marker, getCtx());\n if (existing) {\n hover.refresh(target);\n } else {\n hover.attach(target);\n }\n return true;\n };\n\n const scan = (root: Element) => {\n if (!root.isConnected) return;\n // Our own `appendChild(label)` triggers childList mutations the observer will forward\n // back here. The label has no stega and no wrapper — short-circuit to avoid TreeWalker work.\n if (root.classList?.contains(LABEL_CLASS)) return;\n\n const newMatches: TextMatch[] = [];\n for (const match of collectTextMatches(root)) {\n if (bookkeeper.recordText(match.textNode)) newMatches.push(match);\n }\n\n for (const match of collectAttrMatches(root)) {\n bookkeeper.recordAttr(match.el, match.attr, match.value);\n }\n\n for (const { nodes, ctx: marker } of groupNodesByPath(newMatches)) {\n const target = pickTargetForGroup(nodes, main);\n if (!(target instanceof HTMLElement)) continue;\n applyOverlay(target, marker);\n }\n\n // Rich text and other renderers that own their own text nodes carry the path on a wrapper\n // attr instead of inline stega.\n const wrappers: HTMLElement[] = [];\n if (root.matches(`[${DATA_VE_PATH_ATTR}]`)) wrappers.push(root as HTMLElement);\n wrappers.push(...Array.from(root.querySelectorAll<HTMLElement>(`[${DATA_VE_PATH_ATTR}]`)));\n\n for (const target of wrappers) {\n const marker = readMarkerFromAttrs(target);\n if (!marker) continue;\n applyOverlay(target, marker);\n }\n };\n\n scan(main);\n\n const pipeline = createMutationPipeline(main, {\n onRoots: (roots) => {\n for (const root of roots) scan(root);\n },\n onTextReset: (node) => bookkeeper.forgetText(node),\n });\n\n return () => {\n pipeline.dispose();\n hover.dispose();\n registry.disposeAll();\n badge.dispose();\n bookkeeper.restoreAll();\n };\n}\n"],"names":["DATA_VE_PATH_ATTR","LABEL_CLASS","createEditBadge","createHoverController","groupNodesByPath","readMarkerFromAttrs","createMutationPipeline","createStegaBookkeeper","collectAttrMatches","collectTextMatches","createTargetRegistry","pickTargetForGroup","createOverlay","main","getCtx","leftover","Array","from","
|
|
1
|
+
{"version":3,"sources":["../../../src/client/overlay/createOverlay.ts"],"sourcesContent":["import type { BuildAdminEditUrl } from \"../buildAdminEditUrl.js\";\nimport type { Marker } from \"./markerExtractor.js\";\nimport type { TextMatch } from \"./stegaScanner.js\";\n\nimport { DATA_VE_PATH_ATTR } from \"../../constants.js\";\nimport { LABEL_CLASS } from \"./constants.js\";\nimport { createEditBadge } from \"./editBadge.js\";\nimport { createHoverController } from \"./hoverController.js\";\nimport { groupNodesByPath, readMarkerFromAttrs } from \"./markerExtractor.js\";\nimport { createMutationPipeline } from \"./mutationPipeline.js\";\nimport { createStegaBookkeeper } from \"./stegaBookkeeper.js\";\nimport { collectAttrMatches, collectTextMatches } from \"./stegaScanner.js\";\nimport { createTargetRegistry } from \"./targetRegistry.js\";\nimport { findTargetAncestor, pickTargetForGroup } from \"./targetSelector.js\";\n\nexport type OverlayCtx = {\n buildAdminEditUrl: BuildAdminEditUrl;\n adminOrigin: string;\n adminBasePath: string;\n locale?: string;\n /** 'always' paints outlines on every editable target; 'hover' paints only the hovered one.\n * 'off' is handled by not mounting the overlay at all, so it never reaches this module. */\n mode: \"always\" | \"hover\";\n};\n\nconst isPlainPrimaryClick = (event: MouseEvent) =>\n event.button === 0 && !event.metaKey && !event.ctrlKey && !event.shiftKey && !event.altKey;\n\nconst hasTextSelection = () => document.getSelection()?.isCollapsed === false;\n\nconst isRepeatedClick = (event: MouseEvent) => event.detail > 1;\n\n// Wires every overlay submodule and returns a dispose that tears them down in reverse order.\n// `getCtx` is a getter so the callsite (the hook) can stabilize its useEffect dependency array\n// on just `[enabled]` while still seeing fresh ctx when a target is registered.\nexport function createOverlay(main: HTMLElement, getCtx: () => OverlayCtx): () => void {\n // Fast Refresh may skip the cleanup from a previous effect run — purge any leftover labels.\n // Outline and target attrs are owned by the registry now (disposal restores them), so leftover\n // attrs only exist if a crash skipped cleanup entirely; rare enough to not warrant a scan.\n for (const leftover of Array.from(document.querySelectorAll<HTMLElement>(`.${LABEL_CLASS}`))) {\n leftover.remove();\n }\n\n const bookkeeper = createStegaBookkeeper();\n const registry = createTargetRegistry();\n const badge = createEditBadge();\n const hover = createHoverController(badge, registry);\n\n const applyOverlay = (target: HTMLElement, marker: Marker): boolean => {\n const existing = registry.get(target);\n if (existing && existing.path === marker.path) return false;\n registry.upsert(target, marker, getCtx());\n if (existing) {\n hover.refresh(target);\n } else {\n hover.attach(target);\n }\n return true;\n };\n\n const scan = (root: Element) => {\n if (!root.isConnected) return;\n // Our own `appendChild(label)` triggers childList mutations the observer will forward\n // back here. The label has no stega and no wrapper — short-circuit to avoid TreeWalker work.\n if (root.classList?.contains(LABEL_CLASS)) return;\n\n const newMatches: TextMatch[] = [];\n for (const match of collectTextMatches(root)) {\n if (bookkeeper.recordText(match.textNode)) newMatches.push(match);\n }\n\n for (const match of collectAttrMatches(root)) {\n bookkeeper.recordAttr(match.el, match.attr, match.value);\n }\n\n for (const { nodes, ctx: marker } of groupNodesByPath(newMatches)) {\n const target = pickTargetForGroup(nodes, main);\n if (!(target instanceof HTMLElement)) continue;\n applyOverlay(target, marker);\n }\n\n // Rich text and other renderers that own their own text nodes carry the path on a wrapper\n // attr instead of inline stega.\n const wrappers: HTMLElement[] = [];\n if (root.matches(`[${DATA_VE_PATH_ATTR}]`)) wrappers.push(root as HTMLElement);\n wrappers.push(...Array.from(root.querySelectorAll<HTMLElement>(`[${DATA_VE_PATH_ATTR}]`)));\n\n for (const target of wrappers) {\n const marker = readMarkerFromAttrs(target);\n if (!marker) continue;\n applyOverlay(target, marker);\n }\n };\n\n scan(main);\n\n const pipeline = createMutationPipeline(main, {\n onRoots: (roots) => {\n for (const root of roots) scan(root);\n },\n onTextReset: (node) => bookkeeper.forgetText(node),\n });\n\n const openFieldOnTargetClick = (event: MouseEvent) => {\n if (!isPlainPrimaryClick(event)) return;\n const target = findTargetAncestor(event.target instanceof Element ? event.target : null);\n const config = target ? registry.get(target) : undefined;\n if (!config) return;\n if (isRepeatedClick(event)) {\n event.preventDefault();\n event.stopPropagation();\n return;\n }\n if (hasTextSelection()) return;\n event.stopPropagation();\n config.clickHandler(event);\n };\n main.addEventListener(\"click\", openFieldOnTargetClick, true);\n\n return () => {\n main.removeEventListener(\"click\", openFieldOnTargetClick, true);\n pipeline.dispose();\n hover.dispose();\n registry.disposeAll();\n badge.dispose();\n bookkeeper.restoreAll();\n };\n}\n"],"names":["DATA_VE_PATH_ATTR","LABEL_CLASS","createEditBadge","createHoverController","groupNodesByPath","readMarkerFromAttrs","createMutationPipeline","createStegaBookkeeper","collectAttrMatches","collectTextMatches","createTargetRegistry","findTargetAncestor","pickTargetForGroup","isPlainPrimaryClick","event","button","metaKey","ctrlKey","shiftKey","altKey","hasTextSelection","document","getSelection","isCollapsed","isRepeatedClick","detail","createOverlay","main","getCtx","leftover","Array","from","querySelectorAll","remove","bookkeeper","registry","badge","hover","applyOverlay","target","marker","existing","get","path","upsert","refresh","attach","scan","root","isConnected","classList","contains","newMatches","match","recordText","textNode","push","recordAttr","el","attr","value","nodes","ctx","HTMLElement","wrappers","matches","pipeline","onRoots","roots","onTextReset","node","forgetText","openFieldOnTargetClick","Element","config","undefined","preventDefault","stopPropagation","clickHandler","addEventListener","removeEventListener","dispose","disposeAll","restoreAll"],"mappings":"AAIA,SAASA,iBAAiB,QAAQ,qBAAqB;AACvD,SAASC,WAAW,QAAQ,iBAAiB;AAC7C,SAASC,eAAe,QAAQ,iBAAiB;AACjD,SAASC,qBAAqB,QAAQ,uBAAuB;AAC7D,SAASC,gBAAgB,EAAEC,mBAAmB,QAAQ,uBAAuB;AAC7E,SAASC,sBAAsB,QAAQ,wBAAwB;AAC/D,SAASC,qBAAqB,QAAQ,uBAAuB;AAC7D,SAASC,kBAAkB,EAAEC,kBAAkB,QAAQ,oBAAoB;AAC3E,SAASC,oBAAoB,QAAQ,sBAAsB;AAC3D,SAASC,kBAAkB,EAAEC,kBAAkB,QAAQ,sBAAsB;AAY7E,MAAMC,sBAAsB,CAACC,QAC3BA,MAAMC,MAAM,KAAK,KAAK,CAACD,MAAME,OAAO,IAAI,CAACF,MAAMG,OAAO,IAAI,CAACH,MAAMI,QAAQ,IAAI,CAACJ,MAAMK,MAAM;AAE5F,MAAMC,mBAAmB,IAAMC,SAASC,YAAY,IAAIC,gBAAgB;AAExE,MAAMC,kBAAkB,CAACV,QAAsBA,MAAMW,MAAM,GAAG;AAE9D,6FAA6F;AAC7F,+FAA+F;AAC/F,gFAAgF;AAChF,OAAO,SAASC,cAAcC,IAAiB,EAAEC,MAAwB;IACvE,4FAA4F;IAC5F,+FAA+F;IAC/F,2FAA2F;IAC3F,KAAK,MAAMC,YAAYC,MAAMC,IAAI,CAACV,SAASW,gBAAgB,CAAc,CAAC,CAAC,EAAE/B,YAAY,CAAC,GAAI;QAC5F4B,SAASI,MAAM;IACjB;IAEA,MAAMC,aAAa3B;IACnB,MAAM4B,WAAWzB;IACjB,MAAM0B,QAAQlC;IACd,MAAMmC,QAAQlC,sBAAsBiC,OAAOD;IAE3C,MAAMG,eAAe,CAACC,QAAqBC;QACzC,MAAMC,WAAWN,SAASO,GAAG,CAACH;QAC9B,IAAIE,YAAYA,SAASE,IAAI,KAAKH,OAAOG,IAAI,EAAE,OAAO;QACtDR,SAASS,MAAM,CAACL,QAAQC,QAAQZ;QAChC,IAAIa,UAAU;YACZJ,MAAMQ,OAAO,CAACN;QAChB,OAAO;YACLF,MAAMS,MAAM,CAACP;QACf;QACA,OAAO;IACT;IAEA,MAAMQ,OAAO,CAACC;QACZ,IAAI,CAACA,KAAKC,WAAW,EAAE;QACvB,sFAAsF;QACtF,6FAA6F;QAC7F,IAAID,KAAKE,SAAS,EAAEC,SAASlD,cAAc;QAE3C,MAAMmD,aAA0B,EAAE;QAClC,KAAK,MAAMC,SAAS5C,mBAAmBuC,MAAO;YAC5C,IAAId,WAAWoB,UAAU,CAACD,MAAME,QAAQ,GAAGH,WAAWI,IAAI,CAACH;QAC7D;QAEA,KAAK,MAAMA,SAAS7C,mBAAmBwC,MAAO;YAC5Cd,WAAWuB,UAAU,CAACJ,MAAMK,EAAE,EAAEL,MAAMM,IAAI,EAAEN,MAAMO,KAAK;QACzD;QAEA,KAAK,MAAM,EAAEC,KAAK,EAAEC,KAAKtB,MAAM,EAAE,IAAIpC,iBAAiBgD,YAAa;YACjE,MAAMb,SAAS3B,mBAAmBiD,OAAOlC;YACzC,IAAI,CAAEY,CAAAA,kBAAkBwB,WAAU,GAAI;YACtCzB,aAAaC,QAAQC;QACvB;QAEA,0FAA0F;QAC1F,gCAAgC;QAChC,MAAMwB,WAA0B,EAAE;QAClC,IAAIhB,KAAKiB,OAAO,CAAC,CAAC,CAAC,EAAEjE,kBAAkB,CAAC,CAAC,GAAGgE,SAASR,IAAI,CAACR;QAC1DgB,SAASR,IAAI,IAAI1B,MAAMC,IAAI,CAACiB,KAAKhB,gBAAgB,CAAc,CAAC,CAAC,EAAEhC,kBAAkB,CAAC,CAAC;QAEvF,KAAK,MAAMuC,UAAUyB,SAAU;YAC7B,MAAMxB,SAASnC,oBAAoBkC;YACnC,IAAI,CAACC,QAAQ;YACbF,aAAaC,QAAQC;QACvB;IACF;IAEAO,KAAKpB;IAEL,MAAMuC,WAAW5D,uBAAuBqB,MAAM;QAC5CwC,SAAS,CAACC;YACR,KAAK,MAAMpB,QAAQoB,MAAOrB,KAAKC;QACjC;QACAqB,aAAa,CAACC,OAASpC,WAAWqC,UAAU,CAACD;IAC/C;IAEA,MAAME,yBAAyB,CAAC1D;QAC9B,IAAI,CAACD,oBAAoBC,QAAQ;QACjC,MAAMyB,SAAS5B,mBAAmBG,MAAMyB,MAAM,YAAYkC,UAAU3D,MAAMyB,MAAM,GAAG;QACnF,MAAMmC,SAASnC,SAASJ,SAASO,GAAG,CAACH,UAAUoC;QAC/C,IAAI,CAACD,QAAQ;QACb,IAAIlD,gBAAgBV,QAAQ;YAC1BA,MAAM8D,cAAc;YACpB9D,MAAM+D,eAAe;YACrB;QACF;QACA,IAAIzD,oBAAoB;QACxBN,MAAM+D,eAAe;QACrBH,OAAOI,YAAY,CAAChE;IACtB;IACAa,KAAKoD,gBAAgB,CAAC,SAASP,wBAAwB;IAEvD,OAAO;QACL7C,KAAKqD,mBAAmB,CAAC,SAASR,wBAAwB;QAC1DN,SAASe,OAAO;QAChB5C,MAAM4C,OAAO;QACb9C,SAAS+C,UAAU;QACnB9C,MAAM6C,OAAO;QACb/C,WAAWiD,UAAU;IACvB;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@focus-reactive/payload-plugin-visual-editing",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "Visual editing for Payload CMS — click-to-edit overlays on your frontend via Vercel stega and a postMessage bridge back to the admin.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "FocusReactive <ship@focusreactive.com>",
|