@webx-ui/module-blocks 0.8.0 → 0.8.1

package/dist/frame.d.ts

@@ -44,10 +44,13 @@ export interface FrameBinding {
 /**
  * Make the preview a picture of the page rather than the page itself.
  *
- * Every pointer event is taken at the document, in the capture phase, and goes no further:
- * stopped there it never reaches a link, a form or a block's own script, so nothing in the
- * preview navigates, submits or opens anything. What a click does instead is choose the block
- * it landed in, which is the one thing the editor wants from it.
+ * A click inside a block is taken at the document, in the capture phase, and goes no further:
+ * stopped there it never reaches a link, a form or the block's own script. What it does
+ * instead is choose the block it landed in, which is the one thing the editor wants from it.
+ *
+ * A click on the site around the blocks goes on to the site, only never anywhere else (see
+ * `inert`): the layout may open a newsletter popup or a cookie bar over the page, and one whose
+ * close button never hears its click covers the preview for good.
  *
  * Bound per document: an iframe that reloads gets a new one, and the old binding is released
  * with it.
@@ -59,6 +62,9 @@ export declare function bindFrame(doc: Document, handlers: {
  * The same picture without the choosing: nothing in the page navigates, submits or is dragged
  * away. What the block editor's stage needs — the site's header is full of links, and one
  * click on them would leave the frame on another page of the site with the block gone.
+ *
+ * Clicks themselves still reach the page (see `inert`): the block's own script runs as it will
+ * on the site, and the site's popups close.
  */
 export declare function freezeFrame(doc: Document): FrameBinding;
 /** The key the stage draws its block under — `StageController::KEY` on the server. */