@webx-ui/module-blocks 0.8.0 → 0.8.2

package/dist/BlockThumb.d.ts

@@ -5,6 +5,10 @@ import { BlockThumbnail } from './types';
  * An iframe rather than inline markup because a block's styles are a block's business — a
  * stray `h2 { }` in one type would otherwise restyle the whole list of cards — and because
  * the thumbnail is a picture of the site, not a part of the panel.
+ *
+ * Drawn in the site's own clothes when the site has a stage: its stylesheets and fonts, and
+ * the wrappers the block sits in on a page, without the header, the footer or any script
+ * (see `siteShell`). Bare until that arrives, and bare where there is none.
  */
 type __VLS_Props = {
     thumbnail: BlockThumbnail | null;

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. */
@@ -98,3 +104,22 @@ export interface StageInput {
  * and the runtime, and nothing of the panel. `srcdoc` takes it.
  */
 export declare function stageDocument(input: StageInput): string;
+/** Where a thumbnail's block goes in a {@link siteShell}. */
+export declare const SHELL_PLACE = "<!--wx-thumb-->";
+/**
+ * The stage page with the page taken out: what a thumbnail needs of the site to look like it.
+ *
+ * Kept from the head: the stylesheets, the `<style>` elements and the font preloads — the
+ * look. Kept from the body: only the chain of elements the block's place sits in, each one
+ * empty but for the next, so a rule like `.site-main > section` still finds its parent. The
+ * header, the footer, the popups and every script are left behind: a card in a list is a
+ * picture, and a site's script in forty of them is forty newsletter popups.
+ *
+ * Null when the page has no place for a block — then there is nothing to put the block in.
+ */
+export declare function siteShell(html: string, url: string): string | null;
+/** A thumbnail's document: the block in the site's shell, its own styles last. */
+export declare function thumbDocument(shell: string, input: {
+    html: string;
+    styles: string;
+}): string;