@neeloong/form 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,219 @@
+neeloongForm
+===================
+
+一个表单布局渲染库
+
+相应式的实现,目前采用 [tc39/proposal-signals](https://github.com/tc39/proposal-signals) 的 [polyfill](https://github.com/proposal-signals/signal-polyfill.git)
+
+```js
+
+import { Store, Layout, render } from '@neeloong/form';
+/** @import { Schema } from '@neeloong/form'; */
+const template = `
+<input !value="a" !bind="$value" />
+		<input !bind="a" />
+<ul +a=1>
+	<li !value="list" !enum>
+		<input !bind="b" />
+		<ul !value="c" +x="0">
+			<li !enum +b=alias$length +a=2 +k="++x">
+				<div !fragment !text="k"></div>
+				<button @click="a+=1">a+1:<span !fragment !text="a"></span></button>
+				<button @click="b+=1">b+1:<span !fragment !text="b"></span></button>
+					<input !bind=a type=number />
+				<div !fragment !text="$no"/>. <div !fragment !text="d">1</div> <div !fragment !text>1</div>
+				<button @click="$remove">移除</button>
+				<button @click="$upMove" :disabled="!$upMovable">上移</button>
+				<button @click="$downMove()" :disabled="!$downMovable">下移</button>
+			</li>
+			<li><button @click="$add(0)">添加</button><button @click="$add( - $length - 1)">添加(<span !fragment !text=" - $length - 1"></span>)</button></li>
+		</ul>
+	</li>
+</ul>
+`
+
+/** @type {Layout.Options} */
+const layoutOptions = {
+	creteCalc: value => {
+		const fn = new Function('globalThis', `with(globalThis) { return ${value} }`);
+		fn.toString = () => value;
+		return /** @type {*} */(fn);
+	},
+	creteEvent: value => {
+		const fn = new Function('$event', 'globalThis', `with(globalThis) { ${value} }`);
+		fn.toString = () => value;
+		return /** @type {*} */(fn);
+	},
+}
+
+/**
+ * @type {Schema}
+ */
+const schema = {
+	a: { type: 'int', disabled: true },
+	list: { array: true, props: {
+			b: { type: 'int', disabled: true },
+			c: { array: true, type: 'int' },
+		},
+	},
+};
+const defaultValue = {
+	a: 5,
+	list: {b: 2, c: [1,2,3,4,5]}
+}
+const layouts = Layout.parse(template, layoutOptions);
+
+const store = Store.create(schema);
+store.value = defaultValue
+/** @type {Element} */
+// @ts-ignore
+const app = document.querySelector('#app');
+render(store, layouts, app);
+
+
+```
+
+## API
+
+- `Layout.parse(template, options)` 解析模板
+- `Store.create(schema)` 创建存储
+- `render(store, layouts, element, global, components)` 渲染表单
+
+
+## 模板语法
+
+### 属性绑定
+
+```html
+<div :id="dynamicId"></div>
+```
+
+### 事件监听
+
+```html
+<div @click="doSomething"></div>
+```
+
+### 条件渲染
+
+```html
+<h1 !if="a"></h1>
+<h2 !else !if="b"></h2>
+<h3 !else !if="c"></h3>
+<p !else></p>
+```
+
+### 子属性
+
+```html
+<h1 !value="subField"></h1>
+```
+
+### 列表子属性
+
+```html
+<h1 !enum="subArrayField"></h1>
+```
+
+### 字段绑定
+
+```html
+<input !bind="field" />
+```
+
+### 片段
+
+```html
+<tagName !fragment></tagName>
+```
+
+### 文本渲染与 html 渲染
+
+```html
+<span !text="text"></span>
+```
+
+```html
+<div !html="html"></div>
+```
+
+### 注释
+```html
+<div !comment="注释内容"></div>
+```
+
+### 别名与计算值
+
+```
+<div *alias1="v1" *computed="v1 + v2"></div>
+```
+
+
+### 显式变量（局部变量）
+
+```html
+<div +var1="123"></div>
+```
+
+
+### 各用法的优先级
+
+优先级从高到低:
+
+1. 模板定义: `!template`
+1. 条件: `!if` `!else`
+1. 子属性: `!value`
+1. 枚举: `!enum`
+1. 别名与计算名: `*别名` `*计算名`
+1. 显式变量: `+变量`
+1. 片段与模板调用: `!fragment` 
+1. 属性与事件: `:绑定属性` `@事件` `普通属性` `!bind`
+1. 子内容: `!text` `!html`
+1. 注释: `!comment`
+
+
+### 变量
+1. 字段扩展隐式属性
+   - `$value` 
+   - `$state` 
+   - `$null` 只读属性
+   - `$index` 只读属性
+   - `$no` 只读属性
+   - `$length` 只读属性
+   - `$creatable` 只读属性
+   - `$immutable` 只读属性
+   - `$schema` 只读属性
+   - `$new` 只读属性
+   - `$readonly` 只读属性
+   - `$hidden` 只读属性
+   - `$clearable` 只读属性
+   - `$required` 只读属性
+   - `$disabled` 只读属性
+   - `$label` 只读属性
+   - `$description` 只读属性
+   - `$placeholder` 只读属性
+   - `$min` 只读属性
+   - `$max` 只读属性
+   - `$step` 只读属性
+   - `$values` 只读属性
+1. 数组字段扩展隐式函数（只在事件中可用）
+   - `$insert(index, value)`
+   - `$add(value)`
+   - `$remove(index)`
+   - `$move(from, to)`
+   - `$exchange(a, b)`
+1. 数组成员字段扩展隐式属性
+   - `$upMovable` 只读属性
+   - `$downMovable` 只读属性
+1. 数组成员字段扩展隐式函数（只在事件中可用）
+   - `$remove()`
+   - `$upMove()`
+   - `$downMove()`
+1. 当前范围及组件范围的所有字段（数组字段的成员除外，因为数组字段成员索引为数字，不符合标识符命名规则）都存在 `field$value` 及 `field$$value` 形式的变量
+1. 如果别名为字段的别名，则也存在 `alias$value` 形式的变量
+1. 当存在同名变量时，则会按照变量来源类型决定优先级，从高到低依次为：
+   1. 显式声明（如别名、计算名、显式变量），如果别名是字段的别名，则也包括 `alias$value` 形式的变量
+   1. 全局变量，此部分由 `render` 的参数传入
+   1. 字段声明，包括 `field$value` 及 `field$$value` 形式的变量
+1. 在同一来源类型重复的变量名，再按照作用域处理
+1. 同一作用域下的别名（或计算名）与显式变量重名时，由于会先处理别名，所以，显式变量会覆盖别名。

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.1.0
+* @neeloong/form v0.3.0
 * (c) 2024-2025 Fierflame
 * @license Apache-2.0
 */
@@ -64,11 +64,19 @@ declare namespace Schema {
         value: string | number;
     };
     namespace Value {
+        type Define = Schema.Value | string | number;
         type Group = {
             label: string;
             value?: string | number | undefined;
-            children: (Schema.Value.Group | Schema.Value | string | number)[];
+            children: (Schema.Value.Group | Schema.Value)[];
         };
+        namespace Group {
+            type Define = {
+                label: string;
+                value?: string | number | undefined;
+                children: (Schema.Value.Group | Schema.Value.Define)[];
+            };
+        }
     }
     type Object = {
         type?: null | undefined;
@@ -82,14 +90,52 @@ declare namespace Schema {
         array?: boolean | undefined;
         meta?: any;
     };
+    type Event = {
+        input?: Function | null | undefined;
+        change?: Function | null | undefined;
+        click?: Function | null | undefined;
+        focus?: Function | null | undefined;
+        blur?: Function | null | undefined;
+        add?: Function | null | undefined;
+        remove?: Function | null | undefined;
+        move?: Function | null | undefined;
+    };
     type Attr = {
         immutable?: boolean | undefined;
         creatable?: boolean | undefined;
-        hidden?: boolean | ((store: Store) => boolean) | null | undefined;
-        clearable?: boolean | ((store: Store) => boolean) | null | undefined;
-        required?: boolean | ((store: Store) => boolean) | null | undefined;
-        disabled?: boolean | ((store: Store) => boolean) | null | undefined;
-        readonly?: boolean | ((store: Store) => boolean) | null | undefined;
+        hidden?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
+        clearable?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
+        required?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
+        disabled?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
+        readonly?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
+        /**
+         * 字段标签
+         */
+        label?: string | ((store: Store, root: Store) => string) | null | undefined;
+        /**
+         * 字段描述
+         */
+        description?: string | ((store: Store, root: Store) => string) | null | undefined;
+        /**
+         * 占位符
+         */
+        placeholder?: string | ((store: Store, root: Store) => string) | null | undefined;
+        /**
+         * 日期、时间、数字的最小值
+         */
+        min?: number | ((store: Store, root: Store) => number) | null | undefined;
+        /**
+         * 日期、时间、数字的最大值
+         */
+        max?: number | ((store: Store, root: Store) => number) | null | undefined;
+        /**
+         * 日期、时间、数字的步长
+         */
+        step?: number | ((store: Store, root: Store) => number) | null | undefined;
+        /**
+         * 可选值
+         */
+        values?: (Schema.Value.Define | Schema.Value.Group.Define)[] | undefined;
     };
 }
 
@@ -120,13 +166,22 @@ declare class Store<T = any> {
      * @param {boolean} [options.required]
      * @param {boolean} [options.readonly]
      * @param {boolean} [options.disabled]
+     *
+     * @param {string} [options.label] 字段标签
+     * @param {string} [options.description] 字段描述
+     * @param {string} [options.placeholder] 占位符
+     * @param {number} [options.min] 日期、时间、数字的最小值
+     * @param {number} [options.max] 日期、时间、数字的最大值
+     * @param {number} [options.step] 日期、时间、数字的步长
+     * @param {(Schema.Value.Group | Schema.Value | string | number)[]} [options.values] 可选值
+     *
      * @param {((value: any) => any)?} [options.setValue]
      * @param {((value: any) => any)?} [options.setState]
      * @param {((value: any, state: any) => [value: any, state: any])?} [options.convert]
      * @param {((value: T?, index: any) => void)?} [options.onUpdate]
      * @param {((value: T?, index: any) => void)?} [options.onUpdateState]
      */
-    constructor(schema: Schema.Field, { null: isNull, state, setValue, setState, convert, onUpdate, onUpdateState, index, length, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, }: {
+    constructor(schema: Schema.Field, { null: isNull, state, setValue, setState, convert, onUpdate, onUpdateState, index, length, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, label, description, placeholder, min, max, step, values }: {
         parent?: any;
         state?: any;
         index?: string | number | null | undefined;
@@ -138,6 +193,13 @@ declare class Store<T = any> {
         required?: boolean | undefined;
         readonly?: boolean | undefined;
         disabled?: boolean | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        placeholder?: string | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+        step?: number | undefined;
+        values?: (string | number | Schema.Value | Schema.Value.Group)[] | undefined;
         setValue?: ((value: any) => any) | null | undefined;
         setState?: ((value: any) => any) | null | undefined;
         convert?: ((value: any, state: any) => [value: any, state: any]) | null | undefined;
@@ -159,7 +221,6 @@ declare class Store<T = any> {
     get selfNew(): boolean;
     set new(v: boolean);
     get new(): boolean;
-    get editable(): boolean;
     set selfHidden(v: boolean | null);
     get selfHidden(): boolean | null;
     set hidden(v: boolean);
@@ -180,6 +241,34 @@ declare class Store<T = any> {
     get selfReadonly(): boolean | null;
     set readonly(v: boolean);
     get readonly(): boolean;
+    set selfLabel(v: string | null);
+    get selfLabel(): string | null;
+    set label(v: string | null);
+    get label(): string | null;
+    set selfDescription(v: string | null);
+    get selfDescription(): string | null;
+    set description(v: string | null);
+    get description(): string | null;
+    set selfPlaceholder(v: string | null);
+    get selfPlaceholder(): string | null;
+    set placeholder(v: string | null);
+    get placeholder(): string | null;
+    set selfMin(v: number | null);
+    get selfMin(): number | null;
+    set min(v: number | null);
+    get min(): number | null;
+    set selfMax(v: number | null);
+    get selfMax(): number | null;
+    set max(v: number | null);
+    get max(): number | null;
+    set selfStep(v: number | null);
+    get selfStep(): number | null;
+    set step(v: number | null);
+    get step(): number | null;
+    set selfValues(v: (Schema.Value | Schema.Value.Group)[] | null);
+    get selfValues(): (Schema.Value | Schema.Value.Group)[] | null;
+    set values(v: (Schema.Value | Schema.Value.Group)[] | null);
+    get values(): (Schema.Value | Schema.Value.Group)[] | null;
     /**
      *
      * @param {string | number} key
@@ -236,7 +325,8 @@ declare function parse(source: string, { creteCalc, creteEvent, simpleTag, }?: O
 declare function toString(value: Node | (Node | string)[], formable?: boolean): string;
 
 type Directives = {
-    fragment?: boolean | undefined;
+    template?: string | undefined;
+    fragment?: string | boolean | undefined;
     if?: string | Function | undefined;
     else?: boolean | undefined;
     /**
@@ -246,7 +336,7 @@ type Directives = {
     /**
      * 列表属性枚举
      */
-    enum?: boolean | undefined;
+    enum?: string | boolean | Function | undefined;
     bind?: string | undefined;
     text?: string | Function | undefined;
     html?: string | Function | undefined;
@@ -267,6 +357,7 @@ type Node = {
     attrs: Record<string, string | {
         name: string;
     } | ((global: any) => void)>;
+    params: Record<string, string | ((global: any) => void)>;
     classes: Record<string, string | boolean | ((global: any) => void)>;
     styles: Record<string, string | ((global: any) => void)>;
     events: Record<string, string | (($event: any, global: any) => void)>;