1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
odoo.define('web.OwlDialog', function (require) {
"use strict";
const patchMixin = require('web.patchMixin');
const { Component, hooks, misc } = owl;
const { Portal } = misc;
const { useExternalListener, useRef } = hooks;
const SIZE_CLASSES = {
'extra-large': 'modal-xl',
'large': 'modal-lg',
'small': 'modal-sm',
};
/**
* Dialog (owl version)
*
* Represents a bootstrap-styled dialog handled with pure JS. Its implementation
* is roughly the same as the legacy dialog, the only exception being the buttons.
* @extends Component
**/
class Dialog extends Component {
/**
* @param {Object} [props]
* @param {(boolean|string)} [props.backdrop='static'] The kind of modal backdrop
* to use (see Bootstrap documentation).
* @param {string} [props.contentClass] Class to add to the dialog
* @param {boolean} [props.fullscreen=false] Whether the dialog should be
* open in fullscreen mode (the main usecase is mobile).
* @param {boolean} [props.renderFooter=true] Whether the dialog footer
* should be rendered.
* @param {boolean} [props.renderHeader=true] Whether the dialog header
* should be rendered.
* @param {string} [props.size='large'] 'extra-large', 'large', 'medium'
* or 'small'.
* @param {string} [props.stopClicks=true] whether the dialog should stop
* the clicks propagation outside of itself.
* @param {string} [props.subtitle='']
* @param {string} [props.title='Odoo']
* @param {boolean} [props.technical=true] If set to false, the modal will have
* the standard frontend style (use this for non-editor frontend features).
*/
constructor() {
super(...arguments);
this.modalRef = useRef('modal');
this.footerRef = useRef('modal-footer');
useExternalListener(window, 'keydown', this._onKeydown);
}
mounted() {
this.constructor.display(this);
this.env.bus.on('close_dialogs', this, this._close);
if (this.props.renderFooter) {
// Set up main button : will first look for an element with the
// 'btn-primary' class, then a 'btn' class, then the first button
// element.
let mainButton = this.footerRef.el.querySelector('.btn.btn-primary');
if (!mainButton) {
mainButton = this.footerRef.el.querySelector('.btn');
}
if (!mainButton) {
mainButton = this.footerRef.el.querySelector('button');
}
if (mainButton) {
this.mainButton = mainButton;
this.mainButton.addEventListener('keydown', this._onMainButtonKeydown.bind(this));
this.mainButton.focus();
}
}
this._removeTooltips();
}
willUnmount() {
this.env.bus.off('close_dialogs', this, this._close);
this._removeTooltips();
this.constructor.hide(this);
}
//--------------------------------------------------------------------------
// Getters
//--------------------------------------------------------------------------
/**
* @returns {string}
*/
get size() {
return SIZE_CLASSES[this.props.size];
}
//--------------------------------------------------------------------------
// Private
//--------------------------------------------------------------------------
/**
* Send an event signaling that the dialog must be closed.
* @private
*/
_close() {
this.trigger('dialog-closed');
}
/**
* Remove any existing tooltip present in the DOM.
* @private
*/
_removeTooltips() {
for (const tooltip of document.querySelectorAll('.tooltip')) {
tooltip.remove(); // remove open tooltip if any to prevent them staying when modal is opened
}
}
//--------------------------------------------------------------------------
// Handlers
//--------------------------------------------------------------------------
/**
* @private
* @param {MouseEvent} ev
*/
_onBackdropClick(ev) {
if (!this.props.backdrop || ev.target !== ev.currentTarget) {
return;
}
if (this.props.backdrop === 'static') {
if (this.mainButton) {
this.mainButton.focus();
}
} else {
this._close();
}
}
/**
* @private
* @param {MouseEvent} ev
*/
_onClick(ev) {
if (this.props.stopClicks) {
ev.stopPropagation();
}
}
/**
* @private
*/
_onFocus() {
if (this.mainButton) {
this.mainButton.focus();
}
}
/**
* Manage the TAB key on the main button. If the focus is on a primary
* button and the user tries to tab to go to the next button : a tooltip
* will be displayed.
* @private
* @param {KeyboardEvent} ev
*/
_onMainButtonKeydown(ev) {
if (ev.key === 'Tab' && !ev.shiftKey) {
ev.preventDefault();
$(this.mainButton)
.tooltip({
delay: { show: 200, hide: 0 },
title: () => this.env.qweb.renderToString('web.DialogButton.tooltip', {
title: this.mainButton.innerText.toUpperCase(),
}),
trigger: 'manual',
})
.tooltip('show');
}
}
/**
* @private
* @param {KeyboardEvent} ev
*/
_onKeydown(ev) {
if (
ev.key === 'Escape' &&
!['INPUT', 'TEXTAREA'].includes(ev.target.tagName) &&
this.constructor.displayed[this.constructor.displayed.length - 1] === this
) {
ev.preventDefault();
ev.stopImmediatePropagation();
ev.stopPropagation();
this._close();
}
}
//--------------------------------------------------------------------------
// Static
//--------------------------------------------------------------------------
/**
* Push the given dialog at the end of the displayed list then set it as
* active and all the others as passive.
* @param {(LegacyDialog|OwlDialog)} dialog
*/
static display(dialog) {
const activeDialog = this.displayed[this.displayed.length - 1];
if (activeDialog) {
// Deactivate previous dialog
const activeDialogEl = activeDialog instanceof this ?
// Owl dialog
activeDialog.modalRef.el :
// Legacy dialog
activeDialog.$modal[0];
activeDialogEl.classList.add('o_inactive_modal');
}
// Push dialog
this.displayed.push(dialog);
// Update body class
document.body.classList.add('modal-open');
}
/**
* Set the given displayed dialog as passive and the last added displayed dialog
* as active, then remove it from the displayed list.
* @param {(LegacyDialog|OwlDialog)} dialog
*/
static hide(dialog) {
// Remove given dialog from the list
this.displayed.splice(this.displayed.indexOf(dialog), 1);
// Activate last dialog and update body class
const lastDialog = this.displayed[this.displayed.length - 1];
if (lastDialog) {
lastDialog.el.focus();
const modalEl = lastDialog instanceof this ?
// Owl dialog
lastDialog.modalRef.el :
// Legacy dialog
lastDialog.$modal[0];
modalEl.classList.remove('o_inactive_modal');
} else {
document.body.classList.remove('modal-open');
}
}
}
Dialog.displayed = [];
Dialog.components = { Portal };
Dialog.defaultProps = {
backdrop: 'static',
renderFooter: true,
renderHeader: true,
size: 'large',
stopClicks: true,
technical: true,
title: "Odoo",
};
Dialog.props = {
backdrop: { validate: b => ['static', true, false].includes(b) },
contentClass: { type: String, optional: 1 },
fullscreen: { type: Boolean, optional: 1 },
renderFooter: Boolean,
renderHeader: Boolean,
size: { validate: s => ['extra-large', 'large', 'medium', 'small'].includes(s) },
stopClicks: Boolean,
subtitle: { type: String, optional: 1 },
technical: Boolean,
title: String,
};
Dialog.template = 'web.OwlDialog';
return patchMixin(Dialog);
});
|
