refactor(docs): update some docs

Author: janryWang

docs/API/SchemaForm.md

@@ -19,13 +19,13 @@ import SchemaForm from '@uform/next(antd)'
 | value | 表单值，受控态使用 | Object | {} |
 | initialValues | 表单值，受控态使用 | Object | {} |
 | locale | 表单国际化文案 | Object | {} |
-| schema | 表单json schema，具体参考 [扩展规范](https://yuque.antfin-inc.com/ascp-fe/uform/vu8y9o) | Object | {type:"object",properties:{}} |
+| schema | 表单json schema，具体参考 [扩展规范](#/MpI2Ij/1gSGSDf5) | Object | {type:"object",properties:{}} |
 | onChange | 表单变化事件回调 | `Function(values : Object){}` |  |
 | onSubmit | 表单提交事件回调 | `Function(values : Object){}` |  |
 | onReset | 表单重置事件回调 | `Function(values : Object){}` |  |
 | onValidateFailed | 表单校验失败事件回调 | Function |  |
 | editable | 控制表单字段是否可编辑状态 | `Boolean | Function(name : String) : Boolean` |  |
-| actions | 需要握手的表单actions，只接收通过[createFormActions](https://yuque.antfin-inc.com/ascp-fe/uform/ggm005)创建出来的actions | Object |  |
+| actions | 需要握手的表单actions，只接收通过[createFormActions](#/aAUeUD/XEFAF7HoHV)创建出来的actions | Object |  |
 | effects | 副作用处理函数 | Function |  |
 
 ## 副作用处理

docs/API/SchemaForm_React.md

@@ -19,13 +19,13 @@ import SchemaForm from '@uform/react'
 | value | 表单值，受控态使用 | Object | {} |
 | initialValues | 表单值，受控态使用 | Object | {} |
 | locale | 表单国际化文案 | Object | {} |
-| schema | 表单json schema，具体参考 [扩展规范](https://yuque.antfin-inc.com/ascp-fe/uform/vu8y9o) | Object | {type:"object",properties:{}} |
+| schema | 表单json schema，具体参考 [扩展规范](#/MpI2Ij/1gSGSDf5) | Object | {type:"object",properties:{}} |
 | onChange | 表单变化事件回调 | `Function(values : Object){}` |  |
 | onSubmit | 表单提交事件回调 | `Function(values : Object){}` |  |
 | onReset | 表单重置事件回调 | `Function(values : Object){}` |  |
 | onValidateFailed | 表单校验失败事件回调 | Function |  |
 | editable | 控制表单字段是否可编辑状态 | `Boolean | Function(name : String) : Boolean` |  |
-| actions | 需要握手的表单actions，只接收通过[createFormActions](https://yuque.antfin-inc.com/ascp-fe/uform/ggm005)创建出来的actions | Object |  |
+| actions | 需要握手的表单actions，只接收通过[createFormActions](#/aAUeUD/XEFAF7HoHV)创建出来的actions | Object |  |
 | effects | 副作用处理函数 | `Function( selector : Function, actions: FormActions){}` |  |
 
 

docs/API/createFormActions.md

@@ -0,0 +1,99 @@
+# createFormActions
+
+## 介绍
+
+声明表单 Actions，用于跨组件通讯
+
+## 类型描述
+
+```typescript
+type createFormActions() : {
+    setFormState(callback : (state : formState)=>void) : Promise, //设置表单状态，目前只支持设置formState.values
+    getFormState(callback : (state : formState)=>any)), //获取表单状态
+    setFieldState(name : String,callback : (state : fieldState)=>void) : Promise, //设置表单字段状态，目前支持设置fieldState的所有属性
+    getFieldState(name : String,callback : (state : fieldState)=>any)),//获取表单字段状态
+    reset(),//重置表单
+    submit(),//提交表单
+    validate(),//校验表单
+    getSchema(name : String) //获取表单Schema
+}
+```
+
+## formState
+
+用于描述整个表单状态的模型对象
+
+```typescript
+type formState {
+    values            : Object, //表单数据
+    valid             : Boolean, //是否合法
+    invalid           : Boolean, //是否不合法
+    errors            : Array<String>, //错误提示集合
+    pristine          : Boolean, //是否是原始态
+    dirty             : Boolean //是否存在变化
+}
+```
+
+## fieldState
+
+用于描述表单字段状态的模型对象
+
+```typescript
+type fieldState {
+    value            : Any,//字段值
+    valid            : Boolean,//字段是否合法
+    invalid          : Boolean,//字段是否非法
+    visible          : Boolean,//字段显示状态
+    editable         : Boolean,//字段是否可编辑
+    loading          : Boolean,//字段加载状态
+    errors           : Array<String>,//字段错误消息集合
+    pristine         : Boolean,//字段是否处于原始态
+    initialValue     : Any,//字段初始值
+    name             : String,//字段路径
+    path,            : Array<String>//字段路径，数组形式
+    props            : Object,//字段附加属性
+    rules            : Array<Object | Function | String>//字段校验规则
+}
+```
+
+## 依赖
+
+```javascript
+import { createFormActions } from '@uform/react'
+```
+
+## 用例
+
+```jsx
+import React from 'react'
+import ReactDOM from 'react-dom'
+import SchemaForm, {
+  Field,
+  registerFormField,
+  connect,
+  createFormActions
+} from '@uform/react'
+
+registerFormField(
+  'string',
+  connect()(props => <input {...props} value={props.value || ''} />)
+)
+
+const actions = createFormActions()
+
+ReactDOM.render(
+  <div>
+    <SchemaForm actions={actions}>
+      <Field name="aa" type="string" />
+    </SchemaForm>
+    <button
+      onClick={() => {
+        actions.submit()
+      }}
+    >
+      提交表单
+    </button>
+  </div>,
+  document.getElementById('root')
+)
+```

docs/SUMMARY.md

@@ -20,6 +20,7 @@
      - [registerFieldMiddleware](./API/registerFieldMiddleware.md)
      - [createVirtualBox](./API/createVirtualBox.md)
      - [connect](./API/connect.md)
+     - [createFormActions](./API/createFormActions.md)
    - @uform/next or antd
      - [<SchemaForm/>](./API/SchemaForm.md)
      - [<FormButtonGroup/>](./API/FormButtonGroup.md)

docs/index.html

@@ -29,5 +29,5 @@
       src="https://unpkg.com/react-is@16/umd/react-is.production.min.js"
     ></script>
 
-  <script type="text/javascript" src="statics/bundle.main.109ad769777e1adad4a6.js"></script></body>
+  <script type="text/javascript" src="statics/bundle.main.4fe11b94d773a4a0546b.js"></script></body>
 </html>