Add a control that has Bootstrap Wrapper support.
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 Bootstrap Wrapper control calling another Page through another component using JSON format.
This control is only available for Form-type Screens. See Screen Types.
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.
Follow these steps to add this control to the Screen:
Create a Form Screen or edit a Form Screen in which to add the control.
Drag the Bootstrap Wrapper icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.
Place into the Screen Builder canvas where you want the control to display on the Screen. The Bootstrap Wrapper displays as follows.
Configure the Bootstrap Wrapper control. See Settings.
Validate that the control is configured correctly. See Validate Your Screen.
See Move a Control on the Page.
Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.
Follow these steps to copy a control:
Select the control to be copied.
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:
Select the control to be deleted.
The Image control has the following panels that contain 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:
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: {{ BootstrapWrapperComponent }}
.
Reference this value in Visibility Rule setting expressions.
See best practices when editing a Request variable name.
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 Wrapper control in the Configuration panel:
In the Bootstrap vue component setting, select one of the following BootstrapVue components for the wrap supported by ProcessMaker Platform. The following hyperlinks reference BootstrapVue documentation for their descriptions:
Refer to the following BootstrapVue documentation for property descriptions to each available wrap component:
For example, if using the property ok-title
and size
, enter:
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:
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.
See the following best practices regarding custom CSS in Screens:
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.
Locate the Bootstrap Wrapper icon in the panel to the left of the Screen Builder canvas.
Click the Duplicate Control button. The control copies with its current settings, and then displays below other controls placed on that page.
Click the Delete button. The control deletes. Other controls on that Screen page adjust their locations automatically.
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.
Edit the default label that displays for this control if necessary. New Bootstrap Wrapper is the default value.
The Modal setting is selected by default.
In the page setting, select a page created in the same Screen to use in the component selected previously.
In the Config setting, enter in JSON format component BootstrapVue properties.
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.
Both: The control displays on both desktop and mobile devices. Both toggle keys are enabled by default.
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.