Customizing Chat

Chat is a complex widget created with Webix Jet, the MV* framework for Webix Library.

Jet App Nature

Chat is built as a Jet app. Each Jet app is created as a class that extends the JetApp class.
Read more about JetApp:

The interface of Chat is split in parts. Each part is a module (class) that extends the JetView class.
Read more about JetView:

Jet Views in Chats

You can go to this page to see the list of all Jet views and where they are in the interface.

Advantages of Jet-based Approach

  • you can customize any part of Chat without the need to change the source
  • you can reuse any module (a view or a service) of Chat in your apps
  • customization is simple due to OOP
  • customization allows you to keep the UI and the logic of components together

Code for IE11 and Edge must be with different syntax.

How to Customize Jet Views in Chat

How to Make Changes to Views

First, you need to create you own view class and inherit it from one of the default views or from JetView:

class CustomToolbar extends chat.views["users/toolbar"] {
    /* your logic that will override or extend the default one */
}

There are two JetView methods that you can safely override to customize views:

  • config() for changes in the UI,
  • init() for changes in the UI and behavior,
  • you can also add and call your own methods.
class CustomToolbar extends userManager.views["messages/toolbar"] {
    init() {
        // default logic
        super.init();
        // custom logic below
        this.doSomething();
    }
    doSomething(){
        // do something on init
    }
}

Second, replace the default view with the new one:

webix.ui({
    view: "chat",
    url: "//localhost:3200/",
    override: [chat.views["messages/toolbar"], CustomToolbar]
});

Defining Custom Behavior

You can change the behavior of a view by adding methods to view classes. Follow these steps:

  1. Create a view class.
  2. Define the method.
  3. Call it.
class CustomToolbar extends chat.views["messages/toolbar"] {
  //  add "Add members" menu option
  GetMenuData() {
    let data = super.GetMenuData();
    const _ = this.app.getService("locale")._;
    data.push({ id: "addMembers", value: _("Add members") });
    return data;
  }
  //  call "Add members" handler on menu item click
  InitMenu() {
    const menu = super.InitMenu();
    menu.attachEvent("onItemClick", id => {
      if (id == "addMembers")
        this.app.callEvent("newMembers", [this.State.chatId]);
    });
  }
}

Related sample:  Chat: Custom View

Back to top