Button¶
A button communicates the action that it is going to initiate. Users can click a button to begin a process or workflow, or to trigger an action.
Button Properties¶
| Property | Type | Required | Default |
|---|---|---|---|
| ButtonType | enum |
No | "Text" |
| Enabled | boolean |
No | true |
| Image | Image | No | |
| ImagePosition | enum |
No | "Leading" |
| OnPress | ActionOrRule | No | |
| Position | enum |
No | "Left" |
| Semantic | enum |
No | "Tint" |
| Styles | object |
No | |
| Title | string |
No | |
| Visible | boolean |
No | true |
| _Name | string |
Yes | |
| _Type | const |
Yes |
ButtonType¶
Important types of the button.
- type:
enum - default:
Text
The value of this property must be one of the known values listed below.
| Value | Description |
|---|---|
Primary |
Emphasize the most important actions. |
Secondary |
Less emphasis, but still require user's attention. |
Text |
Less important actions users can take. |
Enabled¶
Sets the button as enabled or disabled.
- type:
boolean - default:
true
Image¶
The image to be displayed with the title.
- type: Image
ImagePosition¶
Position of the image to be displayed along with the title
- type:
enum - default:
"Leading"
The value of this property must be one of the known values listed below.
ImagePosition Known Values¶
| Value | Description |
|---|---|
Leading |
|
Trailing |
OnPress¶
Action/Rule to be executed when the button is pressed. The ClientAPI object to be received in rule function is SectionProxy.
- type: ActionOrRule
- Formatter and Binding are not supported
Position¶
Display position of the label in the section header.
- type:
enum - default:
"Left"
The value of this property must be one of the known values listed below.
Position Known Values¶
| Value | Description |
|---|---|
Left |
|
Right |
Semantic¶
Use the semantic buttons for positive and negative actions.
- type:
enum - default:
Tint
The value of this property must be one of the known values listed below.
| Value | Description |
|---|---|
Normal |
Use it for neutral actions, e.g. Back / Cancel. |
Tint |
Use it for positive actions, e.g. Update / Add / Approve. |
Negative |
Use it for negative actions, e.g. Delete / Reset / Reject. |
Styles¶
Set styles for button.
- type:
objectwith following properties.
| Property | Type | Required | Default |
|---|---|---|---|
| Image | string | No | |
| Button | string | No |
Image¶
The string value is a style class name of Image.
- Image style class
Button¶
The string value is a style class name of Button.
- ButtonNew style class
Title¶
- type:
string
Visible¶
Sets the visibility of the control.
- type:
boolean - default:
true
_Name¶
- type:
string
_Type¶
- type:
const
The value of this property must be:
"SectionHeaderItem.Type.Button"