EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 EspoCRM, Inc.
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
import ModalView from 'views/modal';
import Model from 'model';
import EditForModalRecordView from 'views/record/edit-for-modal';
class BaseDashletOptionsModalView extends ModalView {
template = 'dashlets/options/base'
cssName = 'options-modal'
className = 'dialog dialog-record'
/**
* @protected
* @type {string}
*/
name
/**
* @protected
* @type {boolean}
*/
escapeDisabled = true
/**
* @protected
* @type {boolean}
*/
saveDisabled = false;
buttonList = [
{
name: 'save',
label: 'Apply',
style: 'primary',
title: 'Ctrl+Enter',
},
{
name: 'cancel',
label: 'Cancel',
title: 'Esc',
},
]
shortcutKeys = {
/** @this BaseDashletOptionsModalView */
'Control+Enter': function (e) {
this.handleShortcutKeyCtrlEnter(e);
},
/** @this BaseDashletOptionsModalView */
'Escape': function (e) {
if (this.saveDisabled) {
return;
}
e.stopPropagation();
e.preventDefault();
const focusedFieldView = this.getRecordView().getFocusedFieldView();
if (focusedFieldView) {
this.model.set(focusedFieldView.fetch(), {skipReRender: true});
}
if (this.getRecordView().hasChanged()) {
this.confirm(this.translate('confirmLeaveOutMessage', 'messages'))
.then(() => this.actionClose());
return;
}
this.actionClose();
},
}
data() {
return {
options: this.optionsData,
};
}
getDetailLayout() {
let layout = this.getMetadata().get(['dashlets', this.name, 'options', 'layout']);
if (layout) {
return layout;
}
layout = [{rows: []}];
let i = 0;
let row = [];
for (const field in this.fields) {
if (!(i % 2)) {
row = [];
layout[0].rows.push(row);
}
row.push({name: field});
i++;
}
return layout;
}
init() {
super.init();
this.fields = Espo.Utils.cloneDeep(this.options.fields);
this.fieldList = Object.keys(this.fields);
this.optionsData = this.options.optionsData;
this.name = this.options.name;
}
setup() {
this.id = 'dashlet-options';
const model = this.model = new Model();
model.name = 'DashletOptions';
model.setDefs({fields: this.fields});
model.set(this.optionsData);
this.dataObject = {
dashletName: this.name,
userId: this.options.userId,
};
model.dashletName = this.name;
model.userId = this.options.userId;
this.middlePanelDefs = {};
this.middlePanelDefsList = [];
this.setupBeforeFinal();
this.recordView = new EditForModalRecordView({
model: model,
detailLayout: this.getDetailLayout(),
dataObject: this.dataObject,
});
this.assignView('record', this.recordView, '.record');
this.$header =
$('<span>')
.append(
$('<span>').text(this.getLanguage().translate('Dashlet Options')),
' · ',
$('<span>').text(this.getLanguage().translate(this.name, 'dashlets')),
);
}
setupBeforeFinal() {}
onBackdropClick() {
if (this.getRecordView().hasChanged()) {
return;
}
this.close();
}
/**
* @return {import('views/record/edit').default}
*/
getRecordView() {
return this.recordView;
}
/**
* @return {Object|null}
*/
fetchAttributes() {
const attributes = this.getRecordView().fetch();
if (this.getRecordView().validate()) {
return null;
}
return attributes;
}
actionSave() {
const attributes = this.fetchAttributes();
if (attributes == null) {
return;
}
this.trigger('save', attributes);
}
getFieldViews(withHidden) {
if (!this.hasView('record')) {
return {};
}
return this.getRecordView().getFieldViews(withHidden);
}
getFieldView(name) {
return (this.getFieldViews(true) || {})[name] || null;
}
hideField(name, locked) {
if (!this.getRecordView()) {
this.whenRendered().then(() => this.hideField(name), locked);
return;
}
this.getRecordView().hideField(name, locked);
}
showField(name) {
if (!this.getRecordView()) {
this.whenRendered().then(() => this.showField(name));
return;
}
this.getRecordView().showField(name);
}
/**
* @protected
* @param {KeyboardEvent} e
*/
handleShortcutKeyCtrlEnter(e) {
e.preventDefault();
e.stopPropagation();
if (
document.activeElement instanceof HTMLInputElement ||
document.activeElement instanceof HTMLTextAreaElement
) {
document.activeElement.dispatchEvent(new Event('change', {bubbles: true}));
}
this.actionSave();
}
}
export default BaseDashletOptionsModalView;