@neeloong/form 0.12.1 → 0.14.0

package/README.md

@@ -175,6 +175,13 @@ render(store, layouts, app);
   <li !enum="items" !text="$item"></li> <!-- items 是数组 -->
 </ul>
 ```
+#### 自定义排序
+
+```html
+<ul>
+  <li !enum="object" !sort="$key" !text="$item"></li> <!-- object 是对象，将按照其键排序，渲染其值 -->
+</ul>
+```
 
 #### 嵌套循环
 
@@ -284,7 +291,7 @@ render(store, layouts, app);
 1. 模板定义: `!template`
 1. 条件: `!if` `!else`
 1. 子属性: `!value`
-1. 枚举: `!enum`
+1. 枚举: `!enum` `!sort`
 1. 别名、计算名与显式变量: `*别名` `*计算名` `+变量`
 1. 片段与模板调用: `!fragment` 
 1. 属性与事件: `:绑定属性` `@事件` `普通属性` `!bind`
@@ -304,6 +311,7 @@ render(store, layouts, app);
    - `$creatable` 只读 值是否可创建（`$new` 为 `true` 时，字段只读）
    - `$immutable` 只读 值是否不可改变（`$new` 为 `false` 时，字段只读）
    - `$new` 只读 是否新建项
+   - `$loading` 只读 加载状态
    - `$readonly` 只读 是否只读
    - `$hidden` 只读 是否可隐藏
    - `$clearable` 只读 是否可清除
@@ -325,7 +333,9 @@ render(store, layouts, app);
    - `$kind` 只读 字段类别
    - `$error` 只读 字段校验错误信息
    - `$errors` 只读 所有校验错误列表
-1. 数组字段扩展隐式函数（只在事件中可用）
+   - `$addable` 只读 是否可以为当前数组增加项目，非数组上下文总是为 `false`
+   - `$removable` 只读 是否可以将当前项从数组中移除，非数组成员上下文总是为 `false`
+1. 字段扩展隐式函数（只在事件中可用）
    - `$reset()` 重置数据
    - `$validate()` 触发当前项的异步校验
    - `$validate(true)` 触发当前项及其后代的异步校验

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.12.1
+* @neeloong/form v0.14.0
 * (c) 2024-2025 Fierflame
 * @license Apache-2.0
 */
@@ -253,6 +253,7 @@ type Enum = {
     templates?: Record<string, Template> | undefined;
     type: "enum";
     value: Node.Name | Node.Calc | Node.Value;
+    sort?: Node.Name | Node.Calc | Node.Value<any> | undefined;
     /**
      * 子元素
      */
@@ -653,6 +654,14 @@ declare namespace Schema {
          * 模式规则
          */
         pattern?: RegExp | ((store: Store) => RegExp | null) | null | undefined;
+        /**
+         * 数组内是否可添加
+         */
+        addable?: boolean | ((store: Store) => boolean) | null | undefined;
+        /**
+         * 数组内是否可移除
+         */
+        removable?: boolean | ((store: Store) => boolean) | null | undefined;
         /**
          * 可选值
          */
@@ -804,7 +813,7 @@ declare class Store<T = any, M = any> {
     /**
      * @param {Schema.Field<M>} schema 字段的 Schema 定义
      * @param {object} [options] 可选配置
-     * @param {*} [options.parent]
+     * @param {Store?} [options.parent]
      * @param {*} [options.state]
      * @param {number | string | null} [options.index]
      * @param {number | Signal.State<number> | Signal.Computed<number>} [options.size]
@@ -813,8 +822,9 @@ declare class Store<T = any, M = any> {
      * @param {boolean} [options.hidden]
      * @param {boolean} [options.clearable]
      * @param {boolean} [options.required]
-     * @param {boolean} [options.readonly]
      * @param {boolean} [options.disabled]
+     * @param {boolean} [options.readonly]
+     * @param {boolean} [options.removable]
      *
      * @param {string} [options.label] 字段标签
      * @param {string} [options.description] 字段描述
@@ -838,8 +848,8 @@ declare class Store<T = any, M = any> {
      * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdate]
      * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdateState]
      */
-    constructor(schema: Schema.Field<M>, { null: isNull, state, ref, setValue, setState, convert, onUpdate, onUpdateState, validator, validators, index, size, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, label, description, placeholder, min, max, step, minLength, maxLength, pattern, values }?: {
-        parent?: any;
+    constructor(schema: Schema.Field<M>, { null: isNull, state, ref, setValue, setState, convert, onUpdate, onUpdateState, validator, validators, index, size, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, removable, label, description, placeholder, min, max, step, minLength, maxLength, pattern, values }?: {
+        parent?: Store<any, any> | null | undefined;
         state?: any;
         index?: string | number | null | undefined;
         size?: number | Signal.State<number> | Signal.Computed<number> | undefined;
@@ -848,8 +858,9 @@ declare class Store<T = any, M = any> {
         hidden?: boolean | undefined;
         clearable?: boolean | undefined;
         required?: boolean | undefined;
-        readonly?: boolean | undefined;
         disabled?: boolean | undefined;
+        readonly?: boolean | undefined;
+        removable?: boolean | undefined;
         label?: string | undefined;
         description?: string | undefined;
         placeholder?: string | undefined;
@@ -911,6 +922,8 @@ declare class Store<T = any, M = any> {
     get kind(): string;
     get ref(): Ref;
     schema: Schema.Field<M>;
+    set loading(loading: boolean);
+    get loading(): boolean;
     /** 存储对象自身 */
     get store(): this;
     /** 父级存储对象 */
@@ -964,6 +977,11 @@ declare class Store<T = any, M = any> {
     set readonly(v: boolean);
     /** 是否只读 */
     get readonly(): boolean;
+    set selfRemovable(v: boolean | null);
+    get selfRemovable(): boolean | null;
+    set removable(v: boolean);
+    /** 是否只读 */
+    get removable(): boolean;
     set selfLabel(v: string | null);
     get selfLabel(): string | null;
     set label(v: string | null);
@@ -1057,6 +1075,102 @@ declare class Store<T = any, M = any> {
     #private;
 }
 
+/** @import { Schema } from '../types.mjs' */
+/**
+ * @template {Record<string, any>} [T=Record<string, any>]
+ * @template [M=any]
+ * @extends {Store<T, M>}
+ */
+declare class ObjectStore<T extends Record<string, any> = Record<string, any>, M = any> extends Store<T, M> {
+    /**
+     * @param {Schema.Object<M> & Schema.Attr<M>} schema
+     * @param {object} [options]
+     * @param {Store?} [options.parent]
+     * @param {number | string | null} [options.index]
+     * @param {boolean} [options.new]
+     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdate]
+     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdateState]
+     */
+    constructor(schema: Schema.Object<M> & Schema.Attr<M>, { parent, index, new: isNew, onUpdate, onUpdateState }?: {
+        parent?: Store<any, any> | null | undefined;
+        index?: string | number | null | undefined;
+        new?: boolean | undefined;
+        onUpdate?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
+        onUpdateState?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
+    });
+    [Symbol.iterator](): Generator<[string, Store<any, any>], void, unknown>;
+    #private;
+}
+
+/** @import { Schema } from '../types.mjs' */
+/**
+ * @template [T=any]
+ * @template [M=any]
+ * @extends {Store<(T | null)[], M>}
+ */
+declare class ArrayStore<T = any, M = any> extends Store<(T | null)[], M> {
+    /**
+     * @param {Schema.Field<M>} schema
+     * @param {object} [options]
+     * @param {Store?} [options.parent]
+     * @param {string | number | null} [options.index]
+     * @param {boolean} [options.new]
+     * @param {boolean} [options.addable]
+     * @param {(value: any, index: any, store: Store) => void} [options.onUpdate]
+     * @param {(value: any, index: any, store: Store) => void} [options.onUpdateState]
+     */
+    constructor(schema: Schema.Field<M>, { parent, onUpdate, onUpdateState, index, new: isNew, addable }?: {
+        parent?: Store<any, any> | null | undefined;
+        index?: string | number | null | undefined;
+        new?: boolean | undefined;
+        addable?: boolean | undefined;
+        onUpdate?: ((value: any, index: any, store: Store) => void) | undefined;
+        onUpdateState?: ((value: any, index: any, store: Store) => void) | undefined;
+    });
+    get children(): Store<any, any>[];
+    set selfAddable(v: boolean | null);
+    get selfAddable(): boolean | null;
+    set addable(v: boolean);
+    /** 是否禁用字段 */
+    get addable(): boolean;
+    /**
+     *
+     * @param {number} index
+     * @param {T?} [value]
+     * @param {boolean} [isNew]
+     * @returns
+     */
+    insert(index: number, value?: T | null, isNew?: boolean): boolean;
+    /**
+     *
+     * @param {T?} [value]
+     * @returns
+     */
+    add(value?: T | null): boolean;
+    /**
+     *
+     * @param {number} index
+     * @returns
+     */
+    remove(index: number): T | null | undefined;
+    /**
+     *
+     * @param {number} from
+     * @param {number} to
+     * @returns
+     */
+    move(from: number, to: number): boolean;
+    /**
+     *
+     * @param {number} a
+     * @param {number} b
+     * @returns
+     */
+    exchange(a: number, b: number): boolean;
+    [Symbol.iterator](): Generator<[number, Store<any, any>], undefined, unknown>;
+    #private;
+}
+
 /**
  * @param {Store} store 存储实例
  * @param {Layout.Child[]} layouts 布局信息
@@ -1097,4 +1211,4 @@ declare function watch<T>(getter: () => T, callback: (value: T) => void, immedia
  */
 declare function effect(fn: () => void): () => void;
 
-export { type AsyncValidator, Component, Enhancement, index_d as Layout, type Ref, type Relatedness, Schema, Store, type Validator, type VerifyError, effect, render, watch };
+export { ArrayStore, type AsyncValidator, Component, Enhancement, index_d as Layout, ObjectStore, type Ref, type Relatedness, Schema, Store, type Validator, type VerifyError, effect, render, watch };