Customizing User Manager

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

Jet App Nature

User Manager 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 User Manager is split in parts. Each part is a module (class) that extends the JetView class.
Read more about JetView:

Jet Views in User Manager

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 User Manager without the need to change the source
  • you can reuse any module (a view or a service) of User Manager 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 User Manager

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 userManager.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["users/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: "usermanager",
    url: "https://docs.webix.com/usermanager-backend/",
    override: [userManager.views["users/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 userManager.views["users/toolbar"] {
    config() {
        // get the original ui
        const ui = super.config();
 
        // get the main toolbar of the ui
        const mainToolbar = ui.rows[0].cols;
 
        // create new button to call your custom method
        const newButton = {
            view: "button",
            type: "icon",
            icon: "wxi-download",
            css: "webix_primary",
            label: "Export to Excel",
            autowidth: true,
            click: () => this.ExportUsers(),
        };
 
        // add new button to ui
        mainToolbar.splice(3, 0, newButton);
        return ui;
    }
 
    // new custom method
    ExportUsers() {
     // logic for exporting
    }
}

Related sample:  User Manager: Custom View

Back to top