Customizing Document Manager

Document Manager is a complex widget created with Webix Jet, the MV* framework for Webix Library. It is a ready-to-use application that needs minimal configuration and has an API for redefining the logic of inner modules.

Jet App and Inner Modules

Document Manager is built as a Jet App and wrapped in a Webix view, so you can initialize it in either way.

Views

The interface of Document Manager is split into parts (views). Each view is a class that extends the JetView class and has its own handlers for setting the configuration and logic.

The sources for interface parts (Jet Views) are located in the sources/views folder.

views
    cards.js
  editor.js
  menus
     addnewmenu.js
   ...

Models/Services

Document Manager models contain the logic for loading, storing and caching data, working with file versions, manipulating comments and tags, etc. They are defined as Jet Services.

The sources for models (Jet Services) are located in the sources/models folder.

models
    Backend.js
    LocalData.js
    LocalTags.js
    LocalUsers.js
    Operations.js
    Tags.js
    Users.js
    Versions.js

Service methods are called by the UI and can be called by a programmer as:

$$('dm').getService('versions').restore(id, version);

Customizing Views

When you customize a view, you can:

• override the config() method to change the UI
• override the init() method to change the UI and behavior
• override any existing method, but do it with caution
• add and call your own methods

Check the Class Map to find which view renders the part you want to modify.

First, create your own view class by inheriting it from one of the default views or from docmanager.views.JetView:

class CustomTopBar extends docManager.views.topbar {
    config() {
        // get JSON object with configuration
        const ui = super.config();
        // exact changes depend on a particular view
        ui.height = 50;
        return ui;
    }
    init() {
        // call default logic
        super.init();
        // custom logic below
        this.doSomething();
    }
    doSomething() {
        // do something on init
    }
}

Then, replace the default view via the override map:

webix.ui({
    view: 'docmanager',
    url: 'https://docs.webix.com/docmanager-backend/',
    override: new Map([[docManager.views.topbar, CustomTopBar]]),
});

Single Display Mode

To show a particular tab ("cards", "grid", "double") without the ability to switch between them, hide the Tabbar component from docManager.views.topbar class:

class CustomTopBar extends docManager.views.topbar {
    init() {
        // default logic
        super.init();
        // removing components can cause errors
        // hiding components is safe
        this.$$('modes').hide();
    }
}

Then, replace the default class with a custom one via the override map:

{
    view:"docmanager",
    mode: "cards", //show any tab other than "grid"
    override: new Map([[docManager.views.topbar, CustomTopBar]]),
}

Related sample:  Document Manager: Single Mode

Notes

Hiding Components

We do not recommend removing any component from the interface as the inner logic might still try accessing it. Instead, hide the components.

class CustomTopBar extends docManager.views.topbar {
    init() {
        // default logic
        super.init();
        // removing components can cause errors
        // hiding components is safe
        this.$$('modes').hide();
    }
}

Accessing Component Instances

Within a Jet view, you can access component instances in two ways.

Use the $$(id) method of JetView for an inner component that has the localId setting:

init() {
    // default logic
    super.init();
    // get instance of the component with "form" localId
    this.$$("form").hide();
}

Use queryView if localId is not defined:

init(view) {
    // default logic
    super.init();
    // get instance of the first segmented button
    view.queryView("segmented").hide();
}

Checking the Compact Mode

You can find out whether the app is currently compact from any view or service method:

const compact = this.getParam('compact', true);

Getting State Properties

You can get state properties from any view or service method:

const state = this.app.getState();
// or
const state = this.getParam('state');

Customizing Jet Services

When you customize a service, you can:

• add and call your own methods
• override any existing method, but do it with caution

First, create your own service class and inherit it from one of the default services:

class MyBackend extends docManager.services.Backend {
    folders() {
        // client-side data
        return webix.promise.resolve(folders);
    }
}

Then, replace the default service via the override map:

webix.ui({
    view: 'docmanager',
    url: 'https://docs.webix.com/docmanager-backend/',
    override: new Map([[docmanager.services.backend, MyBackend]]),
});

Related sample:  Document Manager: Data Source

You can find more information about Document Manager Backend service in the Working with Server article.

Backward Compatibility

Document Manager is flexible: you can change almost anything in it. However, keep in mind the following:

• The inner logic of Document Manager modules may change in future releases.
• We will try to maintain method signatures, but breaking changes might happen if they are necessary for further development of the widget.

Back to top