Skip to content

Button Component

Mike edited this page Jun 5, 2025 · 9 revisions

For the updated documentation on the Button component, refer to the Form.io User Guide.

JSON Schema

The JSON Schema definition for this component is defined as follows.

{
"label": "Submit",
"block": true,
"leftIcon": "fa fa-send",
"disableOnInvalid": true,
"tableView": false,
"key": "submit",
"type": "button",
"input": true,
"saveOnEnter": false
}

Core Properties

This component uses the core properties defined within the Common Parameters section.

Specific Properties

PropertyDescriptionValueRequiredDefault
sizeThe button size, as defined through the Bootstrap DocumentationOne of the following (xs, sm, md, lg, xl)falsemd
leftIconThe icon to place to the left of the button. This should be a FontAwesome fontfalseExample: fa-plus
rightIconThe icon to place to the left of the button. This should be a FontAwesome fontfalseExample: fa-plus
blockDetermines if the button should be full width of the bounding container.falsefalsefalse
actionThe action to execute when the button is pressedOne of the following.
  • submit - This button should trigger a form submission.
  • reset - This button should clear all form data.
  • event - A custom event that can be fired and handled with a custom controller.
  • oauth - Trigger an OAuth login.
truesubmit
disableOnInvalidWhether to disable this button if the form is invalid.true or falsetruefalse
themeThe theme of the button as defined though Bootstrap styles.primary, success, default, etc.trueprimary

Clone this wiki locally