@webx-ui/module-blocks 0.1.1 → 0.3.0

package/dist/BlocksField.d.ts

@@ -18,6 +18,16 @@ type __VLS_Props = {
     disabled?: boolean;
     /** Where the section lives, for the picker's "make one" link. */
     blocksPath?: string;
+    /**
+     * Be as tall as what the field is drawn in, and let each of the three panels scroll inside
+     * itself.
+     *
+     * Off by default, because the ordinary case is a field on a form that scrolls: there the
+     * constructor is as tall as it needs to be and the preview sticks. A screen that has given
+     * the constructor the whole area below its head says so — otherwise the field grows, the
+     * page scrolls, and the tree, the form and the preview all leave the screen together.
+     */
+    fill?: boolean;
 };
 type __VLS_PublicProps = {
     modelValue?: BlockNode[];
@@ -27,6 +37,7 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
 }, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     "onUpdate:modelValue"?: ((value: BlockNode[]) => any) | undefined;
 }>, {
+    fill: boolean;
     name: string;
     disabled: boolean;
     node: ScreenNode;
@@ -42,11 +53,13 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
         selected?: string | null;
         mode?: "wide" | "phone";
         reload?: number;
+        fill?: boolean;
     }> & Readonly<{}>, {
         replace: (key: string, html: string) => boolean;
         refresh: () => void;
         open: () => boolean;
     }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+        fill: boolean;
         mode: "wide" | "phone";
         selected: string | null;
         reload: number;
@@ -65,11 +78,13 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
         selected?: string | null;
         mode?: "wide" | "phone";
         reload?: number;
+        fill?: boolean;
     }> & Readonly<{}>, {
         replace: (key: string, html: string) => boolean;
         refresh: () => void;
         open: () => boolean;
     }, {}, {}, {}, {
+        fill: boolean;
         mode: "wide" | "phone";
         selected: string | null;
         reload: number;

package/dist/BlocksPreview.d.ts

@@ -15,6 +15,8 @@ type __VLS_Props = {
     mode?: 'wide' | 'phone';
     /** Bumped by the host to reload the page. */
     reload?: number;
+    /** Be as tall as what it is drawn in, and scroll the page inside rather than beside. */
+    fill?: boolean;
 };
 /** Swap one block's markup in place; false when the page has to be reloaded instead. */
 declare function replace(key: string, html: string): boolean;
@@ -24,6 +26,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
     refresh: typeof refresh;
     open: () => boolean;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    fill: boolean;
     mode: "wide" | "phone";
     selected: string | null;
     reload: number;

package/dist/BlocksTree.d.ts

@@ -20,12 +20,14 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
     add: (parentKey: string | null, field: string | null, node: ScreenNode | null) => any;
     remove: (key: string) => any;
     duplicate: (key: string) => any;
+    visibility: (key: string, hidden: boolean) => any;
     reorder: (parentKey: string | null, field: string | null, list: BlockNode[]) => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onSelect?: ((key: string) => any) | undefined;
     onAdd?: ((parentKey: string | null, field: string | null, node: ScreenNode | null) => any) | undefined;
     onRemove?: ((key: string) => any) | undefined;
     onDuplicate?: ((key: string) => any) | undefined;
+    onVisibility?: ((key: string, hidden: boolean) => any) | undefined;
     onReorder?: ((parentKey: string | null, field: string | null, list: BlockNode[]) => any) | undefined;
 }>, {
     disabled: boolean;

package/dist/content.d.ts

@@ -28,12 +28,22 @@ export declare function locate(tree: BlockNode[], key: string): Located | null;
 export declare function walk(tree: BlockNode[], visit: (node: BlockNode, depth: number, parent: BlockNode | null) => void, depth?: number, parent?: BlockNode | null): void;
 /** How many instances of a type the tree holds, nested ones included. */
 export declare function countType(tree: BlockNode[], slug: string): number;
+/** How many blocks sit inside a node, at any depth — what removing it takes with it. */
+export declare function countInside(node: BlockNode): number;
 /** The distinct types a tree uses, in first-seen order. */
 export declare function typesIn(tree: BlockNode[]): string[];
 /** The `wx-blocks` nodes of a schema, through cards and tabs. */
 export declare function nestedFields(schema: ScreenNode[]): ScreenNode[];
 /** A copy with fresh keys all the way down — what a duplicate is. */
 export declare function cloneNode(node: BlockNode): BlockNode;
+/**
+ * Switch a block off, or back on.
+ *
+ * Showing it removes the key rather than writing `false`, so a block that was never hidden and
+ * one that was hidden and shown again are the same content — and the revision that guards a
+ * save says so.
+ */
+export declare function setHidden(tree: BlockNode[], key: string, hidden: boolean): BlockNode[];
 export declare function insertNode(tree: BlockNode[], parentKey: string | null, field: string | null, index: number, node: BlockNode): BlockNode[];
 export declare function removeNode(tree: BlockNode[], key: string): BlockNode[];
 export declare function updateValues(tree: BlockNode[], key: string, values: Record<string, unknown>): BlockNode[];