Button

Container properties

All component configurations support Container properties at the first level.

Component properties

Name	Type	Default	Supports Variable Pattern	Description
className	string		✔️	The className of the component.
style	object			The style of the component.
type	'default' | 'primary' | 'ghost' | 'dashed' | 'link' | 'text'	'default'		The appearance type of the button.
size	'small' | 'middle' | 'large'	'middle'		The size of the button.
content	string	'middle'		The text content of the button.
icon	string			The name of the button's icon.
action	ButtonAction			The action associated with the button.
clickUseCapture	bool	false		Whether to trigger the click event in the capture phase.
onClick	func			The function to be called when the button is clicked. @param {object} event: dom event

All other componentsProps will be passed to the root element of the component（Button）。

ButtonAction

Name	Type	Default	Supports Variable Pattern	Description
type	'submit' | 'save' | 'cancel' | 'refresh' | 'refreshPage' | 'refreshTable' | 'refreshData' | 'dialog' | 'request' | 'setFormData' | download' | 'upload' | link' | 'globalMethod' | 'formMethod' | 'logout' | 'confirm' | 'updateTableRow' | 'scanCode'			action type
method	'get' | 'post' | 'put' | 'delete'			When type is request, the requested method
url	string	️	✔️	The address requested when type is request, download, upload
href	ConditionalPropertyPropType(string)		✔️	When type is `link', the link address
hrefIsSiteBased	bool	false		If the value is false and this link is under pbc, href will automatically splice the token of pbc as basename, and the mobile side will automatically splice the prefix of mobile
suppressBasePath	bool	false		Whether the direct link does not go through the base path of the react router
suppressInheritIncludeDeleted	bool	false		Is it prohibited to automatically inherit the include_deleted property of the current page. This property is generally in the search params of the url of the current page.
target	string			When type is `link', the target property of the html a tag
replace	bool	false	️	When the type is 'link', react-router Link's replace property
requestData	object	formData	✔️	When the type is 'request', the data sent to the server
accept	string		✔️	When the type is 'upload', the accepted file types are uploaded
openFormProps	object	false		When type is open, the open form property is compatible with all FormRenderer properties
openDialogProps	OpenDialogProps			When type is open, the properties of the open Dialog
msg	string		✔️	When the type is submit, save, request, download, upload, upload, , , prompt message for success
uploadingMsg	string			When the type is 'upload', a message is being uploaded
uploadFileKey	string			When type is 'upload', the file uploaded to the server is named in the field of the request
successAction	ButtonAction			The button's event can be used recursively after another event is executed after it has been successful
suppressSuccessLinkDelay	bool			By default, link in successAction will has 2s delay
successLinkDelayTime	number	2000		Customize the delay time (ms) of the link action in successAction
globalMethod	string			When type is globalMethod, the method name on the called window object
filename	string			When type is 'download', the name of the downloaded file
title	string			When type is confirm, the title of the confirm box
content	string			When type is confirm, the contents of the confirm box
updateType	'add' | 'update' | 'remove'			When type is updateTableRow, the updated operation type
rowData	string | object			When type is updateTableRow, the updated data

OpenDialogProps

Name	Type	Default	Supports Variable Pattern	Description
hideFooter	bool	false		Whether to hide the footer of Dialog
centered	bool	true		Dialog is the page centered
title	string			Dialog title
disableUseOpenContentTitle	bool	false		By default, when openDialogProps.title does not exist, the dialog will use the title of the page / form that opens the pop-up window as the title of the dialog. Set true to prohibit this behavior.
size	'xs' | 'sm' | 'md' | 'lg' | 'fullscreen'	'sm'		Get the address of the detailed data based on id.
width	number | string			Custom Width of Dialog
okText	string	'Sure'		The text of the "OK" button of Dialog footer
cancelText	string	'Cancel'		Text of the "Cancel" button of Dialog footer
okProps	object			Dialog footer's "OK" button props
cancelProps	object			Props of the "Cancel" button of Dialog footer

JS API

The interface obtained through formApi.getFieldApi() is as follows:

Name	Type	Description
node	HTML Element	The root DOM element of the component
setLoading	() => void	Set Button loading status