submit button
This block is part of the state elements
group and was last modified in core v13.0.6
.
submit button
v13.0.1
A submit button to handle your form using a POST or PUT API. An error will be shown if the API responds with a non-200 status code and an error message. For this to work a form element needs to be used.
Pin | Pin | Type | Default |
---|---|---|---|
form idrequired A unique ID for the form this field is used in. |
value |
|
|
textrequired Text to be shown within the button. Can be updated using {state}.content . |
value |
|
|
parametersrequired |
object |
|
|
queryrequired |
object |
|
|
state keyrequired The state to bind the button to. Will execute the left click function and update the {state}.visible with 1 . |
value |
|
|
icon Icon to be shown next to the button, be aware to include the icon font in your HTML/template. Icon can be updated using {state}.icon |
value |
|
|
icon: style Style inline CSS style for the icon |
uistyle |
|
|
icon: class Assigns a CSS class to the icon. |
uiclass |
|
|
class Assigns a CSS class to the element. |
uiclass |
|
|
style Applies inline CSS style to the element |
uistyle |
|
|
attributes Adds custom attributes to the element. |
uiattributes |
|
|
on success Will be executed when the API returns code 200 , to modify the state UI accordingly. |
inpinfunction |
|
Pin | Pin | Type | Example |
---|---|---|---|
state Returns the element to the frontend state. |
state |
Core Releases
v13.0.1 This block was introduced inv13.0.1
, click here to see the release notes.
v13.0.6
This block was last modified in v13.0.6
, click here to see the release notes.
Back to
state elements
Return to the main group to view all sub-groups
Back to buttons
Return to the group to view all blocks within this group