Updated on 2025-08-26 GMT+08:00

Setting Properties of the Chat History Widget

This widget displays records of user chats with the foundation model.

Figure 1 Chat history

Data Binding

For widgets on standard pages, different view models are created to link various data sources to the return values or property values of the widgets, enabling dynamic data effects.
  • Value binding: Value binding is similar to the v-model of the Vue. Bidirectional data binding is created on the widget. Value binding automatically selects the correct method to update the element based on the widget type. In addition, it checks events that cause binding data changes to update data.
    1. In the Data Binding area, click in the value binding area. The Select Model dialog box is displayed.
    2. Click New.
    3. Set Model Name and Source, and click Next.
      Figure 2 Defining a model

      There are four types of models: Custom, Objects, Services, and Events. Each type of model contains parameter definitions and method definitions. Methods are APIs defined on models. In general, these APIs are called in event scripts (such as page loading events and mouse click events) associated with frontend widgets to implement certain logic.

      Table 1 Model types

      Type

      Model Description

      Model Parameter Description

      Model Method Description

      API Calling Method

      Custom

      Models defined by developers.

      Defined by developers. Subnodes can be added.

      Developer-defined method.

      $model.ref("modelName").actionName();

      Objects

      Object models are generated based on the mapping of the object table. For details about the object model, see Objects.

      The system automatically obtains all fields of an object. Developers can select some fields as parameters.

      The system automatically generates four methods: query, save, delete, and count.

      • Query: $model.ref("modelName").query(param);
      • Save: $model.ref("modelName").save();
      • Delete: $model.ref("modelName").delete();
      • Statistics: $model.ref("modelName").count();

      Services

      Service models are generated by mapping backend services. Currently, service models can only be mapped to flows or scripts. For details about the service model, see Flows and Scripts.

      The parameters are mapped to the inputParam and outputParam sections based on the input and output parameters of backend services.

      The run method is automatically generated to execute a flow or a script associated with the model.

      $model.ref("modelName").run();

      Events

      For event models, data binding is created based on fields of a backend event. Model data can be updated based on the web socket.

      Parameters are generated by mapping fields of backend events.

      Directly use.

      Directly use.

      In addition to the methods defined in models, the platform provides the following standard APIs for all models:

      • Obtaining model data: $model.ref("modelName").getData();
      • Setting model data: $model.ref("modelName").setData();
      • Setting model field values: $model.ref("modelName").setValue(key,value);
    4. On the Settings page of the new model, perform the following operations:
      • If Source is set to Custom in the previous step, you need to add customized parameters and types of subnodes.
      • If Source is set to Objects in the previous step, you need to configure the object and fields associated with the model.
      • If Source is set to Services in the previous step, you need to configure the backend service associated with the model. The backend service can be a script, flow, or public API.
      • If Source is set to Events in the previous step, you need to configure the event and event fields associated with the model.
    5. Click Next.

      Generally, you do not need to add a method. If you need to add or modify a method, refer to the method generated by the object and service by default.

    6. Click OK.
  • Property Binding: Binds a property of a container widget, such as hiding, style, and elastic layout, to a specific model field. Once bound, these properties automatically update in sync with the model field's value, functioning in a manner akin to Vue's v-bind directive.
    1. In the Data Binding area, click + next to Property Binding.
    2. Select a property of the container from the Properties drop-down list.
    3. Under Field, click . The model selection page is displayed.
    4. Click New.
    5. Set Model Name and Source, and click Next.
      There are four types of models: Custom, Objects, Services, and Events. Each type of model contains parameter definitions and method definitions. Methods are APIs defined on models. In general, these APIs are called in event scripts (such as page loading events and mouse click events) associated with frontend widgets to implement certain logic. For details, see Table 1.
      Figure 3 Defining a model
    1. On the Settings page of the new model, perform the following operations:
      • If Source is set to Custom in the previous step, you need to add customized parameters and types of subnodes.
      • If Source is set to Objects in the previous step, you need to configure the object and fields associated with the model.
      • If Source is set to Services in the previous step, you need to configure the backend service associated with the model. The backend service can be a script, flow, or public API.
      • If Source is set to Events in the previous step, you need to configure the event and event fields associated with the model.
    2. Click Next.

      Generally, you do not need to add a method. If you need to add or modify a method, refer to the method generated by the object and service by default.

    3. Click OK.

Basic Properties

After basic properties are bound through data, the values of the bound data are used during running.

  • Name: Controls if the brand name appears in the chat history list. If not set, the brand name is hidden.
    Figure 4 Setting the brand name
  • Logo: Indicates whether to show the brand logo in the chat history list. If not set, the logo is hidden. Recommended formats are JPG, JPEG, PNG, or GIF, with a maximum file size of 50 MB.
  • Search Box: Whether to enable searching past conversations. This function is enabled by default.
    Figure 5 Enabling Search Box
  • Edit Button: Whether historical dialogs can be edited. This function is enabled by default.
    Figure 6 Enabling Edit Button
  • Delete Button: Whether historical dialogs can be deleted. This function is enabled by default.
    Figure 7 Enabling Delete Button

Common

  • Name: Name of the current widget.
  • Hid: Whether to hide the widget. In this mode, the widget is statically hidden. You can set this property to a Boolean model field. By controlling the value of this field in custom JavaScript code, you can dynamically determine whether to hide the widget. This dynamic setting has the highest priority.

Style

  • Layout: Set the width and height of the widget.
  • Font: Set the font size, style, and color.
  • Background: Set the background color and transparency.
  • Border: Set the border color and width. The unit can be px, em, or %.
  • Shadow: Set the shadow color and style. The units px, em, and % are supported.
  • Advance
    • Style Code: Style code of the widget. After the widget style is set, the style code is automatically displayed in this area. You can also customize the style code to configure the widget in detail. The customized code can be entered in multiple lines and the style parameters are highlighted.
    • Style Class: Name of the CSS style class of the widget, which can be referenced in the CSS code.

Event

Click the chat list widget and add events for the widget on the Events tab page.

Figure 8 Adding an event
Table 2 Event description

Event

Description

on-click-history

This event is triggered when you click the like button. You can obtain the content in the like area using the following script:

// Current widget
const _component = context.$component.current;
// Obtain the data of the current operation column.
const currentRecord = _component.getCurrentRecord();console.log(currentRecord);

on-change-history

This event is triggered when you click the dislike button. You can obtain the content in the dislike area using the following script:

// Current widget
const _component = context.$component.current;
// Obtain the modified data.
const currentRecord = _component.getCurrentRecord();
console.log(currentRecord);

on-delete-history

Click the stop button to end the conversation and terminate the connection with a foundation model.

// Current widget
const _component = context.$component.current;
// Obtain the data of the current operation column.
const currentRecord = _component.getCurrentRecord();
console.log(currentRecord);