@plotdb/form 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Change Logs
 
+## v0.2.0
+
+ - fix typo in image opset
+ - tweak file opset: update i18n and add min-size in size-limit op
+ - add `paths` and `resolve` api
+ - add experimental conditor module
+ - upgrade dependencies
+ - fix bug: child isn't reinitialized in manager.order api
+ - support export api in manager and widget
+ - support `mod.value` api
+ - explicitly define the purpose of fromSource option in value api
+ - widget.validate: lazy get of widget content to improve performance
+ - widget.value: equality check in widget.validate use internal value.
+ - add form.value.toString api for convert generic widget value to string
+ - add additional utils api for merging exported json
+
+
+
+## v0.1.3
+
+ - upgrade dependencies
+ - add `widgets` api in manager
+ - tweak `condctrl` interface
+ - add valspec and valdef support in widget
+ - add choice opset for valspec @plotdb/form:valdef/choice
+ - support id in term
+ - support function-based meta in op
+ - tweak length opset i18n
+
+
 ## v0.1.2
 
  - fix bug: `disabled`, `isRequired`, `readonly` may return undefined, causing issue for caller that need an explicit defined value.

package/README.md

@@ -1,33 +1,35 @@
 # @plotdb/form
 
-Form related modules for interactive form design throught GUI, with following (expected, TODO) features:
+`@plotdb/form` is a form management package with following feature:
 
- - design a form through GUI.
- - designed form serializable and renderable in frontend for end users to fill.
- - end user filled result of a form is also serializable.
- - Aware of OT for collaborative editing.
- - Works in both frontend and backend.
+ - form construction with block-based widget
+ - serializable form spec and filled data
 
+It includes following modules:
 
-`@plotdb/form` includes following modules:
+ `form.manager`: a recursive manager of a set of widgets.
+ `form.widget`: a form widget as a bridge between user and manager.
+ `form.opset` and `form.op`: operation set and individual operations for validating given inputs from users.
+ `form.term`: validation rule with configs including used opset/op and corresponding configurations.
+ `form.condctrl`: controller for form dynamics based on given conditions.
 
- - `form.manager`: manage a set of form widgets.
- - `form.widget`: interface between form manager and UI.
- - `form.opset`: a set of op for validating given input from user.
- - `form.op`: a specific operation for validating given input from user.
- - `form.term`: a rule ( a op, opset and config based on the specified op ) for validating given input from user.
 
+For more information, check markdown document for corresponding modules under `docs/` folder.
 
-## Draft
 
-### form.block attrubite
+## Simple Usage
 
-An attribute is an aspect of data from a form.block. For example, a File form.block could contains following attributes:
+    mgr = form.manager!
+    # prepare a widget
+    widget = new form.widget({root: ...})
+    <~ widget.init!then _
+    widget.deserialize({isRequired: true}, {init: true})
+    mgr.add {widget, path: "name"}
+    mgr.on \change, -> console.log mgr.value!
+    # use condition control
+    mgr.condition!reset conditions: [{src: "name", config: {value: "dummy", path: [...]}}]
 
- - `size` - size of all files combined.
- - `count` - count of files.
- - `modifiedtime` - modified time of last touched files.
- - `ext` - type of files.
 
-Every attribute can be associated with one or multiple `form.opset` For example, above `ext` attribute can be associated with `extensions` type, which helps in determining if files in a given `ext` array all belong to certain file type.
+## License
 
+MIT