side menu

System widget settings

System settings are the same for all the widgets. They are used to configure a widget’s visibility and access to its data, define what happens, when the user moves or hovers the pointer over the widget, etc.

Events tab

system_events_tab

On this tab, you can specify a script that will run after a certain event:

  • On mouse enter handler. The script runs when the user hovers their mouse over the widget. For example, a pop-up window with a tip may be shown.
  • On mouse leave handler. The script runs the user moves their mouse away from the widget. For example, the tip window shown when hovering over the widget may be hidden.

 

You can use a variable of the Event type in the context of a custom widget to send event data to the parent widget. This variable will then appear on the Events tab. For more information, read the Send an event from a child widget to a parent one article.

To configure the script to be executed:

  1. Click the Create button next to the desired event.
  2. Enter the name of the function and click Open.
  3. Write the script in the opened Scripts tab.
  4. The script is saved automatically. To exit the interface designer, click Save and Publish.

System tab

system_system_tab

  • HTML styles. Here you can specify the CSS styles for the widget. For example, to enter its width.
  • HTML classes. You can create an HTML style using the Code widget and apply it to the current widget. To apply a style, enter its name specified in the script in this field. You can use the same style in several widgets. For example, you can quickly apply one background color to all widgets on a form.

Applying the same background color to several widgets using the HTML classes field

  1. Add the Code widget to the form. Write the following script:

<style>
  .my-custom-style {
      background: yellow;
  }
</style>

  1. Then add a widget to the form, for example, Text box. In its settings, enter my-custom-style in the HTML classes field. The widget’s background will become yellow.
  2. To quickly change their background color, edit the script in the Code widget.
  • Visibility. Allows you to visually hide a widget using CSS styles and HTML markup. This does not remove the widget from the page code. Specify when a widget is shown on the form:
    • Always show. The widget is always visible to the users.
    • Show conditionally, Hide on condition. Specify a condition for hiding or showing the widget. To do that, bind a context variable to this field. For example, select Hide on condition and bind it to a Yes/No switch variable. The widget will be shown to the user if the user selects No when filling out the form. If the user selects Yes, the widget will be hidden. Below you will find an example of how this option is used.
    • Show for groups. Select user groups that will be able to see the widget. Users who are not included in these groups will not see the widget.
    • Always hide. The widget will remain hidden all the time.
  • Render. Controls widget data loading onto the page. When hidden, the widget is deleted using the destroy function. Determine when to retrieve widget data for display on the page:
    • Always show. The widget is generated and displayed on the page.
    • Show conditionally, Hide on condition. Set the condition under which the widget is generated in the page code or the destroy function is called. To do this, bind a Yes/No switch variable to the option. For example, selecting Yes for the Hide on condition option will destroy the widget.
    • Show for groups. To generate the widget only for specific user groups, select them in the field that appears below.
    • Always hide. The widget is not generated and cannot be seen on the page, including in its code. To visually hide the widget without removing it from the page code, use the Visibility option.

For more information on using the options, see the Comparing the Visibility and Render options section.

  • Read only. Configure access to the widget:
    • Inherit from parent. The option is used when you use one widget inside of another. For example, you place the Associated items widget into the Column widget that has the Read only setting. If you select the Inherit from parent option for Associated items, users won't be able to edit the list of items.
    • If you select Yes, the user won’t be able to edit the widget’s data.
    • Select No to allow users to edit the widget’s data.
  • Load the contents asynchronously. This option is available for widgets that contain data, for example, Columns, My Tasks, Panel with Header. Enable the option to display content only when the page or app form is fully loaded.

Comparing the Visibility and Render options

Let's look at the differences between the following options:

  • Visibility. Controls the visual display of the widget on the page using CSS styles and HTML markup.
  • Render. Determines the presence of the widget in the page code. For example, you can configure a widget to be hidden conditionally, so that its data is loaded into the page code and subsequently displayed only under a specified condition.

 

You can use the Render option in the following cases:

  1. The input data for the widget to function correctly is not ready yet.
     
    To prevent users from seeing an empty or incorrectly functioning widget on the page, configure it to load into the page code only when all the necessary data for the widget has been received.
  2. For maximum privacy.
     
    You've hidden the widget using the Visibility option, but you don't want users to see it through developer tools. Use the Render option to prevent the widget from being loaded into the page code. For example, select Always hide.
  3. To optimize page load time.
     
    When you select Always hide in the Render option, the initialization function is not called. Data to display the widget is not requested, so the page loads faster.

Using the Visibility and Render options together

 
You can use the Visibility and Render options together. For example, you want a widget to be rendered when its input data is ready and displayed on the page when the user selects Yes in a form field. To do this:

  1. Create two Yes/No switch variables:
  • Data Ready for the Render option.
  • Show Widget for the Visibility option.

 

  1. In the Render option, select Show conditionally and bind the Data Ready variable, which will be set to Yes after receiving the data. The widget will be created in the page code and ready to display.
  2. In the Visibility option, select Show conditionally and bind the Show Widget variable, which is preset to No.

 

If the settings are completed and published, then:

  • When the input data for the widget is ready, it will be generated in the page code.
  • When the Show Widget variable changes to Yes, the widget will become visible on the page.

 

Link with a variable

You can bind the widget settings fields to context variables. This is convenient if you need to dynamically change widget settings on a page or during a business process. To bind a field:

  1. Click the bind_table-icon icon next to the necessary field name.
     
    In the Visibility field, you can link the variable to it only for the Show conditionally or Hide on condition options. Select one of them.
  2. Click <Not defined>.
  3. Select a context variable from the drop-down list. The list only displays variables with the same data type as the bound field.
  4. Save and publish the widget.

The setting is now defined by the selected context variable.

Use case for the dynamic tab display

Let’s say we have the Orders app to handle customers’ requests. For orders without prepayment, it is required to determine the payment schedule. In this case, the sales rep fills out a table with the schedule information on a separate tab. The tab can be hidden or displayed depending on whether the sales rep checks the Prepayment of 100% box or not.

This can be done with the following settings:

  1. Go to the Orders app menu and click Form Settings.
  2. In the window that opens, add the following properties on the Context tab: Payments of the Table type and Prepayment of 100% of the Yes/No switch type.
  3. Go to the Create tab and click <Default>, and then click +Create Form, or Edit Form if the form has been created earlier. The interface designer will open.
  4. Drag the Tabs widget to the top panel and add the Order and Payment schedule tabs. Add the Prepayment of 100% property to the first tab and the Payments table to the second one.
  5. Go to the Payment schedule tab’s system settings. In the Visibility field, select the Hide on condition option and bind it with the Prepayment of 100% property.
    use_case_hide_condition
  1. Click Save and Publish on the designer top panel.

Now, if the Prepayment of 100% box is unchecked, a new Payment schedule tab will appear on the page, where the user can specify order details. If the Prepayment 100% box is checked, the new tab will not appear.

common_widget_settings-3

field-masks.html 360027211631.html