Submit Button Control Settings

Add a control from which the Request participant submits the Screen.

Control Description

The Submit Button control adds a button to the Screen. The Submit Button control has two functions:

  • Submit: Submits the Screen whilst setting this control's value as specified from the Value setting. This is the default setting.

  • Do Not Submit, Set Value: Sets this control's value as specified from the Value setting, but does not submit the Screen.

This control is only available for Form-type Screens. See Screen Types.

Permissions

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the Screens permissions or ask your Administrator for assistance.

Add the Control to a Screen

Follow these steps to add this control to the Screen:

  1. View the Screen page to which to add the control.

  2. Drag the Submit Button icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.

  3. Place into the Screen Builder canvas where you want the control to display on the Screen.

  4. Configure the Submit Button control. See Settings.

  5. Validate that the control is configured correctly. See Validate Your Screen.

Below is a Submit Button control in Preview mode.

Settings

The Submit Button control has the following panels that contain settings:

Variable Panel Settings

Click the control while in Design mode, and then click the Variable panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Submit Button control in the Variable panel:

Variable Name

Use the Variable Name setting value in the following ways:

  • Reference this control's value in a different Screen Builder control. To do so, use mustache syntax and reference this control's Variable Name value in the target control. Example: {{ SubmitButtonControl }}.

  • Reference this value in Visibility Rule setting expressions.

See best practices when editing a Request variable name.

Label

Value

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.

Below are the settings for the Submit Button control in the Configuration panel:

Type Button

Select from the following options how the Submit Button control functions when the control is clicked:

  • Submit: Submits the Screen whilst setting this control's value as specified from the Value setting. This is the default setting.

Loading

Tooltip

Follow these steps to configure how the tooltip displays for the Submit Button control:

  1. From the Position drop-down menu, select the position of the tooltip relative to the Submit Button control from the following options:

    • Top

    • Top Left

    • Top Right

    • Right

    • Right Top

    • Right Bottom

    • Bottom

    • Bottom Left

    • Bottom Right

    • Left

    • Left Top

    • Left Bottom

  2. From the Variant drop-down menu, select the style for the tooltip:

    • Primary: Blue-colored background with white-colored Label text. This is the default option.

    • Secondary: Gray-colored background with white-colored Label text.

    • Success: Green-colored background with white-colored Label text.

    • Danger: Red-colored background with white-colored Label text.

    • Warning: Yellow-colored background with black-colored Label text.

    • Info: Teal-colored background with white-colored Label text.

    • Light: White-colored background with black-colored Label text.

    • Dark: Black-colored background with white-colored Label text.

  3. In the Tooltip Contains setting, enter the text that the tooltip displays. This setting supports both HTML and mustache syntax.

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas.

Below is the setting for the Submit Button control in the Design panel:

Button Variant Style

Select the style for the Submit Button control. The style changes the control's appearance but otherwise has no functional difference. Select from the following options:

  • Primary: Blue-colored background with white-colored Label text. This is the default option.

  • Secondary: Gray-colored background with white-colored Label text.

  • Success: Green-colored background with white-colored Label text.

  • Danger: Red-colored background with white-colored Label text.

  • Warning: Yellow-colored background with black-colored Label text.

  • Info: Teal-colored background with white-colored Label text.

  • Light: White-colored background with black-colored Label text.

  • Dark: Black-colored background with white-colored Label text.

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Submit Button control in the Advanced panel:

Visibility Rule

Note the following regarding how to use visibility rules:

Device Visibility

Select on which device types this control displays:

  • Desktop: The control displays only on desktop devices. Enable the Show for Desktop toggle key.

  • Mobile: The control displays only on mobile devices. Enable the Show for Mobile toggle key.

CSS Selector Name

See the following best practices regarding custom CSS in Screens:

Aria Label

Enter the string that provides a text alternative to this control for the following purposes:

  • Assistive technology, such as screen readers, read the Aria Label setting value.

  • This control has a visual indication of its purpose, such as a button that uses a graphic instead of text, but still needs to clarify that purpose for anyone who cannot access the visual indication.

Tab Order

Tab order determines the sequential navigation order to navigate a Screen's controls using a keyboard interface. Assistive technology users often use a keyboard for navigation.

Last updated

© Copyright 2000-2024 ProcessMaker Inc. All rights reserved.