Bootstrap Component Control Settings

Add a control that has BootstrapVue Component library support.

Control Description

ProcessMaker Platform supports BootstrapVue components to add in Forms. Use BootstrapVue to display responsive, mobile-first, and ARIA accessible forms projects on the Web. Configure the Bootstrap Component control using the component properties in JSON format.

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. Create a Form Screen or edit a Form Screen in which to add the control.

  2. Drag the Bootstrap Component 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. The Bootstrap Component control displays as follows.

  4. Configure the Bootstrap Component control. See Settings.

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

Settings

The Image 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 Image control in the Variable panel:

Variable Name

Use the Variable Name setting value in the following ways:

  • Reference this control by its Variable Name setting's value. The Data Preview panel in Preview mode represents the state of the Bootstrap Component control using its Variable Name value in the Request's JSON data model.

  • 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: {{ BootstrapFormComponent }}.

  • Reference this value in Visibility Rule setting expressions.

See best practices when editing a Request variable name.

Label

Validation Rules

Follow these steps to add a validation rule to this control:

  1. Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.

  2. Select the rule that this control validates against.

  3. Click Save. Parameters for the selected rule display. Parameter settings display which ones are required to properly configure the rule.

  4. Enter the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.

Follow these steps to edit a validation rule for this control:

  1. Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.

  2. Edit the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.

Follow these steps to delete a validation rule for this control:

  1. Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.

  2. Click Delete.

Make Required

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 settings for the Bootstrap Component control in the Configuration panel:

BootstrapVue Component

In the Bootstrap vue component setting, select one of the following BootstrapVue components ProcessMaker Platform supports. The following hyperlinks reference BootstrapVue documentation for their descriptions:

Component Configuration

Refer to the following BootstrapVue documentation for property descriptions to each available component:

For example, if using the property src and fluid, enter:

{
     "src":"https://picsum.photos/1024/400/?image=41",
     "fluid":"true"
}

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 Image control in the Advanced panel:

Visibility Rule

Note the following regarding how to use visibility rules:

See the following best practices regarding custom CSS in Screens:

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

Last updated

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