releases: 0.1.0, Happy Lantern Festival

Author: cipchk

docs/changelog.md

@@ -4,6 +4,19 @@ title: 更新日志
 type: Basic
 ---
 
+### 0.1.0
+
+`2018-3-2`
+
+- `nz-sf` 组件
+    - 新增 `refreshSchema()` 方法，用于需要动态修改 Schema 某个值时可以方便调用
+    - 修复 `model` 参数双向绑定无效问题
+- Schema
+    - `visibleIf`：支持复杂表达式
+- Widgets
+    - `button`：新增 `popconfirm` 参数，允许设置按钮确认框
+    - `number`：修复 `default` 值无效问题
+
 ### 0.0.1
 
 `2018-2-27`

docs/qa.md

@@ -0,0 +1,81 @@
+---
+order: 4
+title: 常见问题
+type: Basic
+---
+
+## 隐藏字段的用处？
+
+当你需要一些必填字段但又无需任何呈现时非常有用，例如 `parent_id` 父编号可能来自已知信息。
+
+或一些条件表单中，例如：
+
+```ts
+schema: SFSchema = {
+    properties: {
+        parent_id: {
+            type: 'string',
+            widget: 'hidden'
+        },
+        remark: {
+            type: 'string',
+            title: '描述',
+            widget: 'textarea',
+            visibleIf: {
+                parent_id: (value: number) => value > 0
+            }
+        }
+    }
+}
+```
+
+其中 `parent_id` 必须定义为隐藏字段，这样在条件 `visibleIf` 中才能访问到你希望的属性值。
+
+## 如何动态使用 Schema？
+
+一般分为两种情形：
+
+**1、Scheam 定义后可能受限于某个数据来自远程**
+
+```ts
+@ViewChild('sf') sf: FormComponent;
+schema: SFSchema = {
+    properties: {
+        app: {
+            type: 'string',
+            title: '附属应用',
+            widget: 'select',
+            enum: []
+        }
+    }
+};
+
+ngOnInit() {
+    this.http.get('/apps').subscribe((res: any) => {
+        this.schema.properties.app.enum = res;
+        this.sf.refreshSchema();
+    });
+}
+```
+
+**2、远程 Schema**
+
+```ts
+schema: SFSchema = {
+    properties: {}
+};
+
+ngOnInit() {
+    this.http.get('/schema').subscribe((res: any) => {
+        this.schema = res;
+    });
+}
+```
+
+## Schema 中 `enum` 和 `widget.data` 有什么区别？
+
+二者是兼容的，`enum` 属性 Json Schema 标准之一；后者是为了使小部件属性的完整性；本质上应该尽可能使用 `enum` 标准。
+
+## 什么时候使用 `default`？
+
+Schema 的 `default` 用于设置初始化，一般情况下当修改表单时是需要提供 `model` 参数，但对于增加表单来说，应该依靠 `default` 提供一个更友好的表单给用户。

docs/schema.md

@@ -31,6 +31,15 @@ disabled | 是否禁用状态  | `boolean` | -
 class | 自定义类，等同 `[ngClass]` 值  | `string,string[]` | -
 style | 自定义样式，等同 `[ngStyle]` 值  | `object` | -
 grid | 响应式属性  | `SFGrid` | -
+visibleIf | 条件表单 | `{ [key: string]: any[] | ((value: any) => boolean) }` | -
+
+**visibleIf**
+
+指定条件时才显示，例如：
+
+- `visibleIf: { shown: [ true ] }`：当 `shown: true` 时才显示当前属性
+- `visibleIf: { shown: [ '$ANY$' ] }`：当 `shown` 包括任意值时
+- `visibleIf: { shown: (value: any) => value > 0 }`：复杂表达式
 
 ## 小部件Schema
 

lib/src/schema/index.ts

@@ -157,6 +157,7 @@ export interface SFSchema extends ErrorSchema, SFHorizontalLayoutSchema, SFRende
      * 指定条件时才显示，例如：
      *
      * - `visibleIf: { shown: [ true ] }`：当 `shown: true` 时才显示当前属性
+     * - `visibleIf: { shown: [ '$ANY$' ] }`：当 `shown` 包括任意值时
      * - `visibleIf: { shown: (value: any) => value > 0 }`：复杂表达式
      */
     visibleIf?: { [key: string]: any[] | ((value: any) => boolean) };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nz-schema-form",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "license": "MIT",
   "description": "ng-zorro-antd form generation based on JSON-Schema",
   "main": "./bundles/index.js",

src/app/document/data.ts

@@ -26,6 +26,11 @@ export const DATA = {
             title: '自定义错误格式',
             content: getMd(require('!!raw-loader!../../../docs/error.md'))
         },
+        {
+            id: 'qa',
+            title: '常见问题',
+            content: getMd(require('!!raw-loader!../../../docs/qa.md'))
+        },
         {
             id: 'changelog',
             title: '更新日志',