Form Footer Item

Describes an optional item displayed in a form footer before the built-in reset, cancel, navigation and submit buttons.

Footer items can be buttons, text, status icons, flexible spacers or dividers. Every item supports value bindings, including Visible bindings that remove hidden items from the footer layout.

Attributes

Type

Type

Specifies the footer item type.

Attribute Values

Value	Description
button	Default value. An action button.
text	A text label or status message.
icon	A non-interactive status icon with an optional tooltip.
spacer	A flexible spacer that takes the available space, or a fixed-size spacer when Size is set.
divider	A vertical divider.

The default value is: button.

Button Action

Action

Specifies the action performed when the footer button is clicked.

Attribute Values

Value	Description
command	Default value. Sends a command to the server. The command parameter is a JSON object that includes: - action, set to footer-button - values, containing the current form values - key or keys, when editing datasource records - popup, when used in an edit popup - button, when Button Name is set The command response supports the Command API, including fields updates for the current form or edit popup.
link	Changes page, shows a popup or opens a URL.
download	Fires a download request. The request calls userCommand with the same JSON parameter as the command action. The callback returns the file path or content to download. See Handling a download request.

This attribute is available when type is "button".

When type is "button", this attribute defaults to command.

Command Name

Specifies the command name sent by the footer button. If empty, it falls back to the form Command Name, then to the form ID.

Attribute Values

Value	Description	Example
<string>	A command name.
$[variable name]	A command name that sets a variable.	$myvar
$[variable name]!	A command name that sets a persistent variable.	$myvar!

This attribute is available when type is "button" and action is one of "command" or "download".

When type is "button" and action is one of "command" or "download", this attribute defaults to the owner's commandname attribute.

Button Name

Specifies the optional identifier included in the JSON command parameter's button property. Use it to distinguish footer buttons that share a Command Name.

Command parameter: { "action": "footer-button", "values": { "<field>": "<value>", ... }, "key": "<row key>", "popup": "<popup id>", "button": "<button name>" } For multi-edit, keys replaces key. The popup property is present in collection edit popups.

Attribute Values

Value	Description
<string>	Button identifier.

This attribute is available when type is "button" and action is one of "command" or "download".

Link

Specifies a page, navigation command or external URL to follow.

Attribute Values

Value	Description	Example
<Page ID>	The page ID.
<URL>	A url starting with "http://", "https://", "ftp://" or "www.".
back	Navigate backward in browsing history.
forward	Navigate forward in browsing history.
close	Closes the last opened popup.
close-all	Closes all open popups.
logout	Opens the logout popup.
adminclock	Opens the admin clock page, where the user can set the system time.
adminpwd	Opens the admin password page, where the user can change its puk or password.
adminusers	Opens the admin users page, where the user can manage users and groups.
<comma-separated list>	Consequently opens a list of links. Useful for example to open multiple modals in sequence, or to open a page and then a popup.	close-all,mymodal

This attribute is available when type is "button" and action is "link".

Link Target

Specifies where to open the linked URL. Available only for URL links.

Attribute Values

Value	Description
_self	Default value. Opens the linked URL in the same window or tab.
_blank	Opens the linked URL in a new window or tab.
<string>	Opens the linked URL in a named window or tab. Use this to open multiple links in the same window or tab.

This attribute is available when action is link and link is a valid URL or path.

When action is link and link is a valid URL or path, this attribute defaults to _self.

Feedback

If feedback is enabled, when the action is performed, a loader is displayed until the server responds.

Also the action can't be performed again until the server responds.

Attribute Values

Value	Description
false	Default value. Feedback is disabled.
true	Feedback is enabled.

This attribute is available when type is "button" and action is "command".

The default value is: false.

Confirm

Requires a confirmation before performing the action.

Attribute Values

Value	Description
false	Default value. No confirmation, the action is performed right away.
doubleclick	A second click (or touch or enter key) is required to confirm the action.
popup	A popup is displayed to ask for confirmation.

This attribute is available when type is "button".

The default value is: false.

Confirm Message

The confirmation message to be displayed if the "confirm" attribute is set to "popup".

Attribute Values

Value	Description	Example
<string>	The message to be displayed in the confirm popup.	Are you sure?

This attribute is available when type is "button".

Button

Label

Specifies the footer button's label.

Attribute Values

Value	Description
<string>	Button label.

This attribute is available when type is "button".

Description

Specifies a description displayed below the label.

Attribute Values

Value	Description
<string>	Button's description.

This attribute is available when type is "button".

Tooltip

A text displayed when hovering over the object, commonly used to display additional information.

Attribute Values

Value	Description	Example
<string>	Text to be displayed.	Set phasers to stun

This attribute is available when type is "button".

Icon

Specifies the icon source to display. Its position is set with the "Icon Position" attribute.

The value can be:

• An icon prefixed with icon:
• A relative path to an image file, such as lights/lamp.png, resolved from the standard image folders

Attribute Values

Value	Description	Example
<icon>	Icon prefixed with icon:.	icon:mdi#account-multiple
<image>	Relative path to the image file.	lights/lamp.png

This attribute is available when type is "button".

Icon Position

Specifies the position of the icon.

Attribute Values

Value	Description
auto	Default value. Equals "center" if an icon is specified, but there's no label. Equals "left" if both an icon and a label are specified. Otherwise, equals "none".
none	No icon. The label is centered.
left	Place the icon on the left of the label.
top	Place the icon on top of the label.
center	Place the icon in the center, hiding the label.
background	Place the icon in the center, behind the label.

This attribute is available when type is "button".

When type is "button", this attribute defaults to auto.

Icon Color

Specifies the icon's color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "button".

Icon Size

Specifies the icon's size.

Attribute Values

Value	Description	Example
<int>	Size in pixels.	10

This attribute is available when type is "button".

When type is "button", this attribute defaults to auto.

Color

Specifies the button color.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight action buttons.
warning	Warning color, used to highlight warning buttons.
success	Success color, used to highlight success buttons.
error	Error color, used to highlight error buttons.
light	Light color.
dark	Dark color.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

This attribute is available when type is "button".

The default value is: default.

Custom Color

Specifies the button's custom color.

Attribute Values

Value	Description
<html color>	Any valid HTML color.

This attribute is available when type is "button".

Look

Specifies the button's look.

Attribute Values

Value	Description
filled	Default value. Filled look, with a solid background.
clear	Clear look, no background or border.
outlined	Outlined look, with a solid border.
glass	Glass look, with a semi-transparent background.

This attribute is available when type is "button".

The default value is: filled.

Shape

Specifies the button's shape.

Attribute Values

Value	Description
default	Default value. Default shape.
rounded	Rounded shape.
pill	Pill or circle shape.
rectangle	Rectangle shape.

This attribute is available when type is "button".

The default value is: default.

Font Family

Specifies the font family.

This attribute is available when type is "button".

Default behavior:

• When type is "button", this attribute defaults to default.
• When type is "text", this attribute defaults to default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

This attribute is available when type is "button".

Default behavior:

• When type is "button", this attribute defaults to 14.
• When type is "text", this attribute defaults to 14.

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "button".

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

This attribute is available when type is "button".

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

This attribute is available when type is "button".

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

This attribute is available when type is "button".

The default value is: false.

Text Align

Sets the horizontal alignment of the text.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

This attribute is available when type is "button".

The default value is: none.

Width

Specifies the footer button width in pixels.

Minimum value is 24.

Attribute Values

Value	Description
<int>	Width in pixels.

This attribute is available when type is "button".

When type is "button", this attribute defaults to 96.

Text

Text

Specifies the text.

This attribute is available when type is "text".

Font Family

Specifies the font family.

This attribute is available when type is "text".

Default behavior:

• When type is "button", this attribute defaults to default.
• When type is "text", this attribute defaults to default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

This attribute is available when type is "text".

Default behavior:

• When type is "button", this attribute defaults to 14.
• When type is "text", this attribute defaults to 14.

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "text".

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

This attribute is available when type is "text".

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

This attribute is available when type is "text".

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

This attribute is available when type is "text".

The default value is: false.

Text Align

Sets the horizontal alignment of the text.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

This attribute is available when type is "text".

The default value is: none.

Icon

Tooltip

A text displayed when hovering over the object, commonly used to display additional information.

Attribute Values

Value	Description	Example
<string>	Text to be displayed.	Set phasers to stun

This attribute is available when type is "icon".

Icon

Specifies the icon source to display. Its position is set with the "Icon Position" attribute.

The value can be:

• An icon prefixed with icon:
• A relative path to an image file, such as lights/lamp.png, resolved from the standard image folders

Attribute Values

Value	Description	Example
<icon>	Icon prefixed with icon:.	icon:mdi#account-multiple
<image>	Relative path to the image file.	lights/lamp.png

This attribute is available when type is "icon".

Icon Color

Specifies the icon's color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "icon".

Size

Specifies the icon width and height in pixels.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Size in pixels.

This attribute is available when type is "icon".

Default behavior:

• When type is "icon", this attribute defaults to 20.
• When type is "spacer", this attribute defaults to auto.

Spacer

Size

Specifies a fixed spacer width. With auto, the spacer grows to take the available footer space.

Minimum value is 1.

Attribute Values

Value	Description
auto	Default value. Takes the available footer space.
<int>	Width in pixels.

This attribute is available when type is "spacer".

Default behavior:

• When type is "icon", this attribute defaults to 20.
• When type is "spacer", this attribute defaults to auto.

Divider

Divider Type

Specifies the type of the divider.

Attribute Values

Value	Description
line	Default value. Line.
thick	Thick.

This attribute is available when type is "divider".

The default value is: line.

Divider Style

Specifies the style of the divider.

Attribute Values

Value	Description
default	Default value. Default.
dark	Dark.
light	Light.

This attribute is available when type is "divider".

The default value is: default.

View

Visible

Sets the object's visibility.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

The default value is: true.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

This attribute is available when type is "button".

When type is "button", this attribute defaults to true.