@neeloong/form 0.22.0 → 0.23.0

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.22.0
+* @neeloong/form v0.23.0
 * (c) 2024-2026 Fierflame
 * @license Apache-2.0
 */
@@ -778,9 +778,10 @@ declare namespace Enhancement {
         value: any;
     };
 }
-type StoreLayout = {
+type StoreLayout<T> = {
     html?: string | ParentNode | null | undefined;
-    fields?: StoreLayout.Item[] | null | undefined;
+    fields?: StoreLayout.Item<T>[] | null | undefined;
+    renderer?: T | undefined;
 };
 declare namespace StoreLayout {
     type Action = "add" | "move" | "trigger" | "remove" | "serial" | "open" | "collapse";
@@ -823,7 +824,7 @@ declare namespace StoreLayout {
          */
         label?: string | undefined;
     };
-    type Field = {
+    type Field<T_1> = {
         type?: "field" | undefined;
         colStart?: number | undefined;
         colSpan?: number | undefined;
@@ -832,10 +833,11 @@ declare namespace StoreLayout {
         rowSpan?: number | undefined;
         rowEnd?: number | undefined;
         cell?: StoreLayout.Grid["cell"];
+        renderer?: T_1 | undefined;
         field: string;
         html?: string | ParentNode | null | undefined;
         inlineHtml?: string | ParentNode | null | undefined;
-        fields?: StoreLayout.Item[] | null | undefined;
+        fields?: StoreLayout.Item<T_1>[] | null | undefined;
         tableFoot?: "add" | "header" | "none" | undefined;
         columns?: (string | number | StoreLayout.Column | StoreLayout.Action[])[] | undefined;
         arrayStyle?: "tree" | "table" | undefined;
@@ -872,13 +874,14 @@ declare namespace StoreLayout {
         description?: string | undefined;
         html?: string | ParentNode | null | undefined;
     };
-    type Item = StoreLayout.Field | StoreLayout.Button | StoreLayout.Html;
+    type Item<T_1> = StoreLayout.Field<T_1> | StoreLayout.Button | StoreLayout.Html;
     type Options = {
         relate?: ((store: Store, el: Element | Relatedness) => () => void) | undefined;
         editable?: boolean | undefined;
+        signal?: AbortSignal | undefined;
         call?: ((name: string, event: Event, store: Store<any, any>, options?: StoreLayout.Options | null) => void) | undefined;
     };
-    type Renderer = (store: Store<any, any>, options?: StoreLayout.Options | null) => [HTMLElement, () => void] | null;
+    type Renderer<T_1> = (store: Store<any, any>, renderer?: T_1, options?: StoreLayout.Options | null) => HTMLElement | null;
 }
 
 declare const ref: unique symbol;
@@ -1292,30 +1295,74 @@ declare function render(store: Store, layouts: Child[], parent: Element, { compo
 /**
  * 创建可赋值计算值
  * @template T
+ * @overload
  * @param {() => T} getter 取值方法
  * @param {(value: T) => void} callback 取值方法
  * @param {boolean} immediate 是否立即执行一次
+ * @param {null} [signal]
  * @returns {() => void}
  */
-declare function watch<T>(getter: () => T, callback: (value: T) => void, immediate: boolean): () => void;
+declare function watch<T>(getter: () => T, callback: (value: T) => void, immediate: boolean, signal?: null | undefined): () => void;
+/**
+ * 创建可赋值计算值
+ * @template T
+ * @overload
+ * @param {() => T} getter 取值方法
+ * @param {(value: T) => void} callback 取值方法
+ * @param {boolean} immediate 是否立即执行一次
+ * @param {AbortSignal?} [signal]
+ * @returns {(() => void) | void}
+ */
+declare function watch<T>(getter: () => T, callback: (value: T) => void, immediate: boolean, signal?: AbortSignal | null | undefined): (() => void) | void;
+/**
+ * 创建可赋值计算值
+ * @template T
+ * @overload
+ * @param {() => T} getter 取值方法
+ * @param {(value: T) => void} callback 取值方法
+ * @param {boolean} immediate 是否立即执行一次
+ * @param {AbortSignal} signal
+ * @returns {void}
+ */
+declare function watch<T>(getter: () => T, callback: (value: T) => void, immediate: boolean, signal: AbortSignal): void;
 
 /**
  * 相应式执行
+ * @overload
  * @param {() => void} fn 执行函数
+ * @param {null} [signal]
  * @returns {() => void} 取消函数
  */
-declare function effect(fn: () => void): () => void;
+declare function effect(fn: () => void, signal?: null | undefined): () => void;
+/**
+ * 相应式执行
+ * @overload
+ * @param {() => void} fn 执行函数
+ * @param {AbortSignal} signal
+ * @returns {void} 取消函数
+ */
+declare function effect(fn: () => void, signal: AbortSignal): void;
+/**
+ * 相应式执行
+ * @overload
+ * @param {() => void} fn 执行函数
+ * @param {AbortSignal?} [signal]
+ * @returns {(() => void) | void} 取消函数
+ */
+declare function effect(fn: () => void, signal?: AbortSignal | null | undefined): (() => void) | void;
 
 /**
  *
+ * @template T
  * @param {Store} store
- * @param {StoreLayout.Renderer} fieldRenderer
+ * @param {StoreLayout.Renderer<T>} fieldRenderer
  * @param {HTMLElement} root
- * @param {StoreLayout?} [layout]
+ * @param {StoreLayout<T>?} [layout]
  * @param {StoreLayout.Options & {clone?: boolean} | null} [options]
+ * @returns {void}
  */
-declare function renderStore(store: Store, fieldRenderer: StoreLayout.Renderer, root: HTMLElement, layout?: StoreLayout | null, options?: (StoreLayout.Options & {
+declare function renderStore<T>(store: Store, fieldRenderer: StoreLayout.Renderer<T>, root: HTMLElement, layout?: StoreLayout<T> | null, options?: (StoreLayout.Options & {
     clone?: boolean;
-}) | null): () => void;
+}) | null): void;
 
 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 };