Button

容器属性

所有组件配置的第一层均支持容器属性

组件属性 componentsProps

Name	Type	Default	是否支持 Variable Pattern	Description
className	string		✔️	组件的 className
style	object			组件的 style
type	'default' | 'primary' | 'ghost' | 'dashed' | 'link' | 'text'	'default'		按钮外观类型
size	'small' | 'middle' | 'large'	'middle'		按钮的尺寸
content	string	'middle'		按钮的文字内容
icon	string			按钮 icon 的名字
action	ButtonAction			按钮动作
clickUseCapture	bool	false		是否在捕获阶段触发点击事件
onClick	func			当按钮点击的时候调用此函数 @param {object} event: dom event

所有其余 componentsProps 将会被传给组件根元素（Button）。

ButtonAction

Name	Type	Default	是否支持 Variable Pattern	Description
type	'submit' | 'save' | 'cancel' | 'refresh' | 'refreshPage' | 'refreshTable' | 'refreshData' | 'dialog' | 'request' | 'setFormData' | download' | 'upload' | link' | 'globalMethod' | 'formMethod' | 'logout' | 'confirm' | 'updateTableRow' | 'scanCode'			动作类型
method	'get' | 'post' | 'put' | 'delete'			当 type 是 request 的时候，请求的方法
url	string	️	✔️	当 type 是 request、 download 、 upload 的时候请求的地址
href	ConditionalPropertyPropType(string)		✔️	当 type 是 `link' 的时候，链接的地址
hrefIsSiteBased	bool	false		如果值为 false 并且此链接位于 pbc 下，href 将自动拼接上 pbc 的 token 作为 basename，移动端将自动拼接上 mobile 的前缀
suppressBasePath	bool	false		是否直接链接不通过 react router 的 base path
suppressInheritIncludeDeleted	bool	false		是否禁止自动继承当前页面的 include_deleted 属性，此属性一般在当前页面 url 的 search params 里
target	string			当 type 是 `link' 的时候，html a 标签的 target 属性
replace	bool	false	️	当 type 是 `link' 的时候，react-router Link 的 replace 属性
requestData	object	formData	✔️	当 type 是 request 的时候，发送给服务器的数据
accept	string		✔️	当 type 是 upload 的时候，上传接受的文件类型
openFormProps	object	false		当 type 是 open 的时候，打开的表单/页面的属性，兼容所有 FormRenderer 的属性
openDialogProps	OpenDialogProps			当 type 是 open 的时候，打开的 Dialog 的属性
msg	string		✔️	当 type 是 submit, save, request, download, upload, 的时候，请求成功的提示信息
uploadingMsg	string			当 type 是 upload 的时候，正在上传的提示信息
uploadFileKey	string			当 type 是 upload 的时候，上传给服务器的文件在请求中的字段名
successAction	ButtonAction			按钮的事件成功过后执行的另一个事件，可以递归使用
suppressSuccessLinkDelay	bool			By default, link in successAction will has 2s delay
successLinkDelayTime	number	2000		自定义 successAction 中 link 动作的延迟时间(ms)
globalMethod	string			当 type 是 globalMethod 的时候，调用的 window 对象上的方法名
filename	string			当 type 是 download 的时候，下载的文件名
title	string			当 type 是 confirm 的时候，确认框的标题
content	string			当 type 是 confirm 的时候，确认框的内容
updateType	'add' | 'update' | 'remove'			当 type 是 updateTableRow 的时候，更新的操作类型
rowData	string | object			当 type 是 updateTableRow 的时候，更新的数据

OpenDialogProps

Name	Type	Default	是否支持 Variable Pattern	Description
hideFooter	bool	false		是否隐藏 Dialog 的 footer
centered	bool	true		Dialog 是否页面居中
title	string			Dialog 的标题
disableUseOpenContentTitle	bool	false		默认当 openDialogProps.title 不存在的时候 dialog 会使用打开弹窗的页面/表单的 title 作为 dialog 的 title，设置 true 禁止此行为
size	'xs' | 'sm' | 'md' | 'lg' | 'fullscreen'	'sm'		根据 id 获取详细数据的地址。
width	number | string			Dialog 的自定义宽度
okText	string	'确定'		Dialog footer 的 "确定" 按钮的文字
cancelText	string	'取消'		Dialog footer 的 "取消" 按钮的文字
okProps	object			Dialog footer 的 "确定" 按钮的 props
cancelProps	object			Dialog footer 的 "取消" 按钮的 props

JS API

通过 formApi.getFieldApi() 获取的接口如下：

Name	Type	Description
node	HTML Element	组件的根 DOM 元素
setLoading	() => void	设置 Button loading 状态