Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: sort api table alphabetically #58

Merged
merged 1 commit into from
May 8, 2019

Conversation

monkindey
Copy link
Contributor

fix #52

加了一个 sort-api-table 脚本, 直接 yarn sort-api 即可

之前

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

之后

属性名称 属性描述 属性类型 默认值
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

@janryWang janryWang merged commit 1331564 into alibaba:master May 8, 2019
@monkindey monkindey deleted the sort-api-table branch May 9, 2019 02:48
ZirkleTsing pushed a commit that referenced this pull request May 14, 2020
docs: sort api table alphabetically
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

文档 API 按照字母表排序
2 participants