Bootstrap Component Control Settings

Add a control that has BootstrapVue Component library support.

Control Description

ProcessMaker Platform support 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.

Bootstrap Component control using Embed property

Permissions Required

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

Permissions Required

Permissions are required to do this.

Design Best Practice

Avoid designing with more than 25 controls in one 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. Locate the Bootstrap Component icon in the panel to the left of the Screen Builder canvas.
3. 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.

4. Place into the Screen Builder canvas where you want the control to display on the Screen. The Bootstrap Component control displays as follows.

   
5. Configure the Bootstrap Component control. See Settings.

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

Move the Control on the Page

After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.

Permissions are required to do this.

Follow these steps to move a control to another location on that Screen page:

1. Place your cursor anywhere on the control not displaying the Duplicate Controlor Delete Controlbuttons.
2. Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, theicon displays in the preview.
3. Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

Copy the Control with its Settings

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.

Permissions are required to do this.

Follow these steps to copy a control:

1. Select the control to be copied.

2. Click the Duplicate Control button. The control copies with its current settings, and then displays below other controls placed on that page.

Delete the Control from a Screen

Permissions are required to do this.

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.

Follow these steps to delete a control from a Screen page:

1. Select the control to be deleted.

2. Click the Delete button. The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

Permissions are required to do this.

The Image control has the following panels that contain settings:

• Variable panel

• Configuration panel

• Advanced panel

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

• Label

• Validation Rules

• Make Required

Variable Name

Edit the default Variable Name setting value for this control if necessary. The Variable Name setting value represents data in this control during Requests. Ensure that the Variable Name setting value is a unique name from other controls in this Screen and contains at least one letter. This is a required setting.

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

Edit the default label that displays for this control if necessary. New Bootstrap Component is the default value.

Validation Rules

Enter the validation rule(s) the Request participant must comply with to properly enter a valid value into this control. This setting has no default value. If there are no configured validation rules the following message displays: No validation rule(s). See Validation Rules for "Validation" Control Settings.

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. Click the Add Rule button. The Select drop-down menu displays.
3. Select the rule that this control validates against.

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

5. 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. Click the Edit iconfor the validation rule to edit if that rule can be edited. Validation rules that do not have parameters cannot be edited. The parameter settings for that validation rule displays.
3. 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 the Delete iconfor the validation rule to delete. A message displays to confirm deletion of the validation rule.
3. Click Delete.

Make Required

Select to indicate that this control is required. This option is not selected by default. This is a quick way to add the Required validation rule.

In the Screen preview or during a Request if you submit the Screen without selecting this required Bootstrap Component control, this control displays Field is required in red-colored text.

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

• Component Configuration

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:

• Embed

• Image

• Form Rating

• Form Spinbutton

• Form Tags

• Form Timepicker

• Table

The Form Tags setting is selected by default.

Component Configuration

In the Config setting, enter in JSON format component BootstrapVue properties.

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

• Embed

• Image

• Form Rating

• Form Spinbutton

• Form Tags

• Form Timepicker

• Table

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

• Device Visibility

• CSS Selector Name

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components. If this setting does not have an expression, then this control displays by default.

Note the following regarding how to use visibility rules:

• To make this control hidden until another control contains a value, enter the Variable Name setting value of that control to this control's Visibility Rule setting.

• Visibility rules override custom CSS settings.

See the following best practices regarding custom CSS in Screens:

• Editing a CSS name to represent this control in custom CSS syntax

• Visibility rules override custom CSS settings

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.

• Both: The control displays on both desktop and mobile devices. Both toggle keys are enabled by default.

CSS Selector Name

Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.

Related Topics

pageScreen TypespageScreen Builder ModespageValidate Your ScreenpageEdit Your ScreenpageBootstrap Wrapper Control SettingspageCheckbox Control SettingspageDate Picker Control SettingspageFile Download Control SettingspageFile Preview Control SettingspageFile Upload Control SettingspageGoogle Places Control SettingspageImage Control SettingspageLine Input Control SettingspageLoop Control SettingspageMulticolumn / Table Control SettingspageNested Screen Control SettingspagePage Navigation Control SettingspagePhoto/Video Control SettingspageRecord List Control SettingspageRich Text Control SettingspageSelect List Control SettingspageSignature Control SettingspageSubmit Button Control SettingspageTextarea Control SettingspageExpression Syntax ComponentspageValidation Rules for "Validation Rules" SettingspageReference Magic Variables in ProcessMaker Platform Assets