Skip to content

Commit

Permalink
docs(site): update doc site (#64)
Browse files Browse the repository at this point in the history
* docs(API): Fix jump link can't jump in doc site. #59

* docs(site): move github pages==>netlify

* docs(api): update SchemaForm API table

* docs(api): update SchemaForm API links
  • Loading branch information
janryWang committed May 14, 2019
1 parent 1be9024 commit 24cc5cb
Show file tree
Hide file tree
Showing 68 changed files with 227 additions and 101 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<a href="https://www.npmjs.com/package/@uform/antd"><img src="https://img.shields.io/npm/v/@uform/antd.svg"></a>
<a href="https://travis-ci.com/alibaba/uform"><img src="https://travis-ci.com/alibaba/uform.svg?branch=master"></a>
<a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg"></a>
<a href="https://app.netlify.com/sites/vibrant-turing-251a6e/deploys"><img src="https://api.netlify.com/api/v1/badges/7145918b-9cb5-47f8-8a42-111969e232ef/deploy-status"/></a>
</p>

<p align="center" style="color:#666;margin-top:10px;">面向复杂场景的中后台表单解决方案,UForm 谐音 Your Form,代表,这才是你想要的 Form 解决方案</p>
Expand Down
32 changes: 16 additions & 16 deletions docs/API/Field_React.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ import {Field} from '@uform/react'

## API

| 属性名称 | 属性描述 | 属性类型 | 默认值 |
| ---- | ---- | ---- | --- |
| default | 默认值 | any |
| enum | 枚举值,配置该值在默认情况下会显示Select形态,指定x-component会显示对应的组件形态 | `Array< String | {label:String,value:any}>` | [] | |
| maxItems | 最大条目数,只有在type="array"时可以使用 | Number | |
| minItems | 最小条目数,只有在type="array"时可以使用 | Number | |
| name | 字段名称 | Object | {} |
| required | 字段是否必填 | Boolean | false |
| type | 字段类型 | Object | |
| x-component | 字段UI组件,用于指定该字段应该用什么组件做渲染 | Object | {type:"object",properties:{}} |
| x-effect | 副作用事件绑定对象 | `Function(dispatch : Function) : { [eventName](...arguemtns)}` | |
| x-index | 字段索引顺序 | Number | |
| x-props | 字段UI组件属性,API请参考对应fusion next/ant design组件API | Object | {} |
| x-props.editable | 字段是否可编辑 | Boolean | true |
| x-render | 字段渲染函数 | `Function(fieldProps : FieldRenderProps){}` | |
| x-rules | 字段校验规则 | `Object | Array<String | Object | Function> | String | Function` | |
| 属性名称 | 属性描述 | 属性类型 | 默认值 | |
| ---- | ---- | ---- | --- | --- |
| default | 默认值 | any | | |
| enum | 枚举值,配置该值在默认情况下会显示Select形态,指定x-component会显示对应的组件形态 | `Array< String | {label:String,value:any}>` | \[] | |
| maxItems | 最大条目数,只有在type="array"时可以使用 | Number | | |
| minItems | 最小条目数,只有在type="array"时可以使用 | Number | | |
| name | 字段名称 | Object | {} | |
| required | 字段是否必填 | Boolean | false | |
| type | 字段类型 | Object | | |
| x-component | 字段UI组件,用于指定该字段应该用什么组件做渲染 | Object | {type:"object",properties:{}} | |
| x-effect | 副作用事件绑定对象 | `Function(dispatch : Function) : { [eventName](...arguemtns)}` | | |
| x-index | 字段索引顺序 | Number | | |
| x-props | 字段UI组件属性,API请参考对应fusion next/ant design组件API | Object | {} | |
| x-props.editable | 字段是否可编辑 | Boolean | true | |
| x-render | 字段渲染函数 | `Function(fieldProps : FieldRenderProps){}` | | |
| x-rules | 字段校验规则 | `Object | Array<String | Object | Function> | String | Function` | | |

## x-rules详解

Expand Down
5 changes: 2 additions & 3 deletions docs/API/SchemaForm.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,13 @@ import SchemaForm from '@uform/next(antd)'

| 属性名称 | 属性描述 | 属性类型 | 默认值 |
| ---- | ---- | ---- | --- |
| actions | 需要握手的表单actions,只接收通过[createFormActions](/#/97UlUl/XEFAF7HoHV)/[createAsyncFormActions](/#/97UlUl/leFLFGHMHK)创建出来的actions | Object | |
| actions | 需要握手的表单actions,只接收通过[createFormActions](#/97UlUl/XEFAF7HoHV)/[createAsyncFormActions](#/97UlUl/leFLFGHMHK)创建出来的actions | Object | |
| defaultValue | 表单默认值 | Object | |
| editable | 控制表单字段是否可编辑状态 | `Boolean | Function(name : String) : Boolean` | |
| effects | 副作用处理函数 | Function | |
| initialValues | 表单值,受控态使用 | Object | {} |
| locale | 表单国际化文案 | Object | {} |
| schema | 表单json schema,具体参考 [扩展规范](/#/MpI2Ij/DVSLSafN) | Object | {type:"object",properties:{}} |
| value | 表单值,受控态使用 | Object | {} |
| schema | 表单json schema,具体参考 [扩展规范](#/MpI2Ij/DVSLSafN) | Object | {type:"object",properties:{}} |
| onChange | 表单变化事件回调 | `Function(values : Object){}` | |
| onReset | 表单重置事件回调 | `Function(values : Object){}` | |
| onSubmit | 表单提交事件回调 | `Function(values : Object){}` | |
Expand Down
5 changes: 2 additions & 3 deletions docs/API/SchemaForm_React.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ import SchemaForm from '@uform/react'
| 属性名称 | 属性描述 | 属性类型 | 默认值 |
| ---- | ---- | ---- | --- |
| --- | --- | --- | --- |
| actions | 需要握手的表单actions,只接收通过[createFormActions](/#/97UlUl/XEFAF7HoHV)/[createAsyncFormActions](/#/97UlUl/leFLFGHMHK)创建出来的actions | Object | |
| actions | 需要握手的表单actions,只接收通过[createFormActions](#/97UlUl/XEFAF7HoHV)/[createAsyncFormActions](#/97UlUl/leFLFGHMHK)创建出来的actions | Object | |
| defaultValue | 表单默认值 | Object | |
| editable | 控制表单字段是否可编辑状态 | `Boolean | Function(name : String) : Boolean` | |
| effects | 副作用处理函数 | Function | |
| initialValues | 表单值,受控态使用 | Object | {} |
| locale | 表单国际化文案 | Object | {} |
| schema | 表单json schema,具体参考 [扩展规范](/#/MpI2Ij/DVSLSafN) | Object | {type:"object",properties:{}} |
| value | 表单值,受控态使用 | Object | {} |
| schema | 表单json schema,具体参考 [扩展规范](#/MpI2Ij/DVSLSafN) | Object | {type:"object",properties:{}} |
| onChange | 表单变化事件回调 | `Function(values : Object){}` | |
| onReset | 表单重置事件回调 | `Function(values : Object){}` | |
| onSubmit | 表单提交事件回调 | `Function(values : Object){}` | |
Expand Down
2 changes: 1 addition & 1 deletion docs/iframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,5 @@
<script src="//unpkg.com/antd/dist/antd.min.js"></script>
<script src="//unpkg.com/@alifd/next/dist/next.min.js"></script>

<script type="text/javascript" src="//unpkg.com/@uform/docs@0.1.21/bundle.iframe.js"></script></body>
<script type="text/javascript" src="statics/bundle.iframe.c2d30637cb93c79d92e3.js"></script></body>
</html>
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,5 @@
<script src="//unpkg.com/antd/dist/antd.min.js"></script>
<script src="//unpkg.com/@alifd/next/dist/next.min.js"></script>

<script type="text/javascript" src="//unpkg.com/@uform/docs@0.1.21/bundle.index.js"></script></body>
<script type="text/javascript" src="statics/bundle.index.c2d30637cb93c79d92e3.js"></script></body>
</html>
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

File renamed without changes.

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 24cc5cb

Please sign in to comment.