@neeloong/form 0.16.0 → 0.18.0

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.16.0
+* @neeloong/form v0.18.0
 * (c) 2024-2025 Fierflame
 * @license Apache-2.0
 */
@@ -13,7 +13,7 @@ export { Signal } from 'signal-polyfill';
  * @param {Layout.Options} [options] 解析选项
  * @returns {Layout.Child[]}
  */
-declare function parse(source: string, { createCalc, createInit, createEvent, simpleTag, enableHTML, }?: Options$1): Child[];
+declare function parse(source: string, { createCalc, createInit, createEvent, simpleTag, enableHTML, }?: Options): Child[];
 
 /**
  * 增强信息
@@ -39,7 +39,7 @@ type Enhancement$1 = {
 /**
  * 解析选项
  */
-type Options$1 = {
+type Options = {
     /**
      * 启用 `!html` 指令
      */
@@ -349,12 +349,13 @@ type index_d_Enum = Enum;
 type index_d_EventListener = EventListener;
 type index_d_Fragment = Fragment;
 declare const index_d_Node: typeof Node;
+type index_d_Options = Options;
 type index_d_Select = Select;
 type index_d_Template = Template;
 type index_d_Variable<T = unknown> = Variable<T>;
 declare const index_d_parse: typeof parse;
 declare namespace index_d {
-  export { type index_d_Calc as Calc, type index_d_CallTemplate as CallTemplate, type index_d_Child as Child, type index_d_Content as Content, type index_d_Divergent as Divergent, type index_d_DivergentChildren as DivergentChildren, type Enhancement$1 as Enhancement, type index_d_Enum as Enum, type index_d_EventListener as EventListener, type index_d_Fragment as Fragment, index_d_Node as Node, type Options$1 as Options, type index_d_Select as Select, type index_d_Template as Template, type index_d_Variable as Variable, index_d_parse as parse };
+  export { type index_d_Calc as Calc, type index_d_CallTemplate as CallTemplate, type index_d_Child as Child, type index_d_Content as Content, type index_d_Divergent as Divergent, type index_d_DivergentChildren as DivergentChildren, type Enhancement$1 as Enhancement, type index_d_Enum as Enum, type index_d_EventListener as EventListener, type index_d_Fragment as Fragment, index_d_Node as Node, type index_d_Options as Options, type index_d_Select as Select, type index_d_Template as Template, type index_d_Variable as Variable, index_d_parse as parse };
 }
 
 type VerifyError = any;
@@ -777,6 +778,65 @@ declare namespace Enhancement {
         value: any;
     };
 }
+type StoreLayout = {
+    html?: string | ParentNode | null | undefined;
+    fields?: StoreLayout.Item[] | null | undefined;
+};
+declare namespace StoreLayout {
+    type Action = "add" | "move" | "trigger" | "remove" | "serial";
+    type Field = {
+        type?: "field" | undefined;
+        colStart?: number | undefined;
+        colSpan?: number | undefined;
+        colEnd?: number | undefined;
+        rowStart?: number | undefined;
+        rowSpan?: number | undefined;
+        rowEnd?: number | undefined;
+        cell?: "" | "block" | "inline" | "collapse" | "base" | undefined;
+        field: string;
+        html?: string | ParentNode | null | undefined;
+        inlineHtml?: string | ParentNode | null | undefined;
+        fields?: StoreLayout.Item[] | null | undefined;
+        tableFoot?: "add" | "header" | "none" | undefined;
+        columns?: (string | StoreLayout.Action[])[] | undefined;
+    };
+    type Button = {
+        type: "button";
+        colStart?: number | undefined;
+        colSpan?: number | undefined;
+        colEnd?: number | undefined;
+        rowStart?: number | undefined;
+        rowSpan?: number | undefined;
+        rowEnd?: number | undefined;
+        cell?: "" | "block" | "inline" | "collapse" | "base" | undefined;
+        required?: boolean | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        text?: string | undefined;
+        click?: string | ((event: Event, store: Store<any, any>, options?: StoreLayout.Options | null) => void) | undefined;
+    };
+    type Html = {
+        type: "html";
+        colStart?: number | undefined;
+        colSpan?: number | undefined;
+        colEnd?: number | undefined;
+        rowStart?: number | undefined;
+        rowSpan?: number | undefined;
+        rowEnd?: number | undefined;
+        cell?: "" | "content" | "block" | "inline" | "collapse" | undefined;
+        required?: boolean | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        html?: string | ParentNode | null | undefined;
+    };
+    type Item = StoreLayout.Field | StoreLayout.Button | StoreLayout.Html;
+    type Options = {
+        relate?: ((store: Store, el: Element | Relatedness) => () => void) | undefined;
+        editable?: boolean | undefined;
+        call?: ((name: string, event: Event, store: Store<any, any>, options?: StoreLayout.Options | null) => void) | undefined;
+    };
+    type Renderer = (store: Store<any, any>, component: any, options?: StoreLayout.Options | null) => [HTMLElement, () => void] | null;
+}
 
 declare const ref: unique symbol;
 type Ref = {
@@ -1174,32 +1234,6 @@ declare class ArrayStore<T = any, M = any> extends Store<(T | null)[], M> {
     #private;
 }
 
-type GridFormItemTemplate = {
-    field: string;
-    subFields?: GridFormTemplate | null | undefined;
-    span: number;
-    headers?: string[] | undefined;
-    colStart?: number | undefined;
-    colSpan?: number | undefined;
-    colEnd?: number | undefined;
-    rowStart?: number | undefined;
-    rowSpan?: number | undefined;
-    rowEnd?: number | undefined;
-};
-type GridFormTemplate = GridFormItemTemplate[];
-type Options = object;
-type FieldRenderer = (store: Store<any, any>, component: any, Options: Options) => [HTMLElement, () => void];
-
-/**
- *
- * @param {Store} store
- * @param {HTMLElement} root
- * @param {FieldRenderer} fieldRenderer
- * @param {boolean} editable
- * @param {GridFormTemplate?} [template]
- */
-declare function _default(store: Store, root: HTMLElement, fieldRenderer: FieldRenderer, editable: boolean, template?: GridFormTemplate | null): () => void;
-
 /**
  * @param {Store} store 存储实例
  * @param {Layout.Child[]} layouts 布局信息
@@ -1242,12 +1276,14 @@ declare function effect(fn: () => void): () => void;
 
 /**
  *
- * @param {(store: Store<any, any>, component: any) => [HTMLElement, () => void]?} renderField
  * @param {Store} store
+ * @param {StoreLayout.Renderer} fieldRenderer
  * @param {HTMLElement} root
- * @param {string | ParentNode} [html]
- * @param {boolean} [clone]
+ * @param {StoreLayout?} [layout]
+ * @param {StoreLayout.Options & {clone?: boolean} | null} [options]
  */
-declare function renderHtml(renderField: (store: Store<any, any>, component: any) => [HTMLElement, () => void] | null, store: Store, root: HTMLElement, html?: string | ParentNode, clone?: boolean): () => void;
+declare function renderStore(store: Store, fieldRenderer: StoreLayout.Renderer, root: HTMLElement, layout?: StoreLayout | null, options?: (StoreLayout.Options & {
+    clone?: boolean;
+}) | null): () => void;
 
-export { ArrayStore, type AsyncValidator, Component, Enhancement, type FieldRenderer, type GridFormItemTemplate, type GridFormTemplate, index_d as Layout, ObjectStore, type Options, type Ref, type Relatedness, Schema, Store, type Validator, type VerifyError, effect, render, _default as renderGrid, renderHtml, watch };
+export { ArrayStore, type AsyncValidator, Component, Enhancement, index_d as Layout, ObjectStore, type Ref, type Relatedness, Schema, Store, StoreLayout, type Validator, type VerifyError, effect, render, renderStore, watch };