3 * An abstract Backbone View that controls an in-place editor.
6 (function($, Backbone, Drupal) {
7 Drupal.quickedit.EditorView = Backbone.View.extend(
8 /** @lends Drupal.quickedit.EditorView# */ {
10 * A base implementation that outlines the structure for in-place editors.
12 * Specific in-place editor implementations should subclass (extend) this
13 * View and override whichever method they deem necessary to override.
15 * Typically you would want to override this method to set the
16 * originalValue attribute in the FieldModel to such a value that your
17 * in-place editor can revert to the original value when necessary.
20 * <caption>If you override this method, you should call this
21 * method (the parent class' initialize()) first.</caption>
22 * Drupal.quickedit.EditorView.prototype.initialize.call(this, options);
26 * @augments Backbone.View
28 * @param {object} options
29 * An object with the following keys:
30 * @param {Drupal.quickedit.EditorModel} options.model
31 * The in-place editor state model.
32 * @param {Drupal.quickedit.FieldModel} options.fieldModel
35 * @see Drupal.quickedit.EditorModel
36 * @see Drupal.quickedit.editors.plain_text
39 this.fieldModel = options.fieldModel;
40 this.listenTo(this.fieldModel, 'change:state', this.stateChange);
47 // The el property is the field, which should not be removed. Remove the
48 // pointer to it, then call Backbone.View.prototype.remove().
50 Backbone.View.prototype.remove.call(this);
54 * Returns the edited element.
56 * For some single cardinality fields, it may be necessary or useful to
57 * not in-place edit (and hence decorate) the DOM element with the
58 * data-quickedit-field-id attribute (which is the field's wrapper), but a
59 * specific element within the field's wrapper.
60 * e.g. using a WYSIWYG editor on a body field should happen on the DOM
61 * element containing the text itself, not on the field wrapper.
64 * A jQuery-wrapped DOM element.
66 * @see Drupal.quickedit.editors.plain_text
75 * Returns 3 Quick Edit UI settings that depend on the in-place editor:
76 * - Boolean padding: indicates whether padding should be applied to the
77 * edited element, to guarantee legibility of text.
78 * - Boolean unifiedToolbar: provides the in-place editor with the ability
79 * to insert its own toolbar UI into Quick Edit's tightly integrated
81 * - Boolean fullWidthToolbar: indicates whether Quick Edit's tightly
82 * integrated toolbar should consume the full width of the element,
83 * rather than being just long enough to accommodate a label.
85 getQuickEditUISettings() {
88 unifiedToolbar: false,
89 fullWidthToolbar: false,
95 * Determines the actions to take given a change of state.
97 * @param {Drupal.quickedit.FieldModel} fieldModel
98 * The quickedit `FieldModel` that holds the state.
99 * @param {string} state
100 * The state of the associated field. One of
101 * {@link Drupal.quickedit.FieldModel.states}.
103 stateChange(fieldModel, state) {
104 const from = fieldModel.previous('state');
108 // An in-place editor view will not yet exist in this state, hence
109 // this will never be reached. Listed for sake of completeness.
113 // Nothing to do for the typical in-place editor: it should not be
114 // visible yet. Except when we come from the 'invalid' state, then we
116 if (from === 'invalid') {
117 this.removeValidationErrors();
122 // Nothing to do for the typical in-place editor: it should not be
127 // The user has indicated he wants to do in-place editing: if
128 // something needs to be loaded (CSS/JavaScript/server data/…), then
129 // do so at this stage, and once the in-place editor is ready,
130 // set the 'active' state. A "loading" indicator will be shown in the
131 // UI for as long as the field remains in this state.
132 const loadDependencies = function(callback) {
133 // Do the loading here.
136 loadDependencies(() => {
137 fieldModel.set('state', 'active');
143 // The user can now actually use the in-place editor.
147 // Nothing to do for the typical in-place editor. The UI will show an
148 // indicator that the field has changed.
152 // When the user has indicated he wants to save his changes to this
153 // field, this state will be entered. If the previous saving attempt
154 // resulted in validation errors, the previous state will be
155 // 'invalid'. Clean up those validation errors while the user is
157 if (from === 'invalid') {
158 this.removeValidationErrors();
164 // Nothing to do for the typical in-place editor. Immediately after
165 // being saved, a field will go to the 'candidate' state, where it
166 // should no longer be visible (after all, the field will then again
167 // just be a *candidate* to be in-place edited).
171 // The modified field value was attempted to be saved, but there were
172 // validation errors.
173 this.showValidationErrors();
179 * Reverts the modified value to the original, before editing started.
182 // A no-op by default; each editor should implement reverting itself.
183 // Note that if the in-place editor does not cause the FieldModel's
184 // element to be modified, then nothing needs to happen.
188 * Saves the modified value in the in-place editor for this field.
191 const fieldModel = this.fieldModel;
192 const editorModel = this.model;
193 const backstageId = `quickedit_backstage-${this.fieldModel.id.replace(
198 function fillAndSubmitForm(value) {
199 const $form = $(`#${backstageId}`).find('form');
200 // Fill in the value in any <input> that isn't hidden or a submit
203 .find(':input[type!="hidden"][type!="submit"]:not(select)')
204 // Don't mess with the node summary.
205 .not('[name$="\\[summary\\]"]')
208 $form.find('.quickedit-form-submit').trigger('click.quickedit');
211 const formOptions = {
212 fieldID: this.fieldModel.get('fieldID'),
215 other_view_modes: fieldModel.findOtherViewModes(),
216 // Reset an existing entry for this entity in the PrivateTempStore (if
217 // any) when saving the field. Logically speaking, this should happen in
218 // a separate request because this is an entity-level operation, not a
219 // field-level operation. But that would require an additional request,
220 // that might not even be necessary: it is only when a user saves a
221 // first changed field for an entity that this needs to happen:
223 reset: !this.fieldModel.get('entity').get('inTempStore'),
227 Drupal.quickedit.util.form.load(formOptions, (form, ajax) => {
228 // Create a backstage area for storing forms that are hidden from view
229 // (hence "backstage" — since the editing doesn't happen in the form, it
230 // happens "directly" in the content, the form is only used for saving).
231 const $backstage = $(
232 Drupal.theme('quickeditBackstage', { id: backstageId }),
234 // Hidden forms are stuffed into the backstage container for this field.
235 const $form = $(form).appendTo($backstage);
236 // Disable the browser's HTML5 validation; we only care about server-
237 // side validation. (Not disabling this will actually cause problems
238 // because browsers don't like to set HTML5 validation errors on hidden
240 $form.prop('novalidate', true);
241 const $submit = $form.find('.quickedit-form-submit');
242 self.formSaveAjax = Drupal.quickedit.util.form.ajaxifySaving(
247 function removeHiddenForm() {
248 Drupal.quickedit.util.form.unajaxifySaving(self.formSaveAjax);
249 delete self.formSaveAjax;
253 // Successfully saved.
254 self.formSaveAjax.commands.quickeditFieldFormSaved = function(
260 // First, transition the state to 'saved'.
261 fieldModel.set('state', 'saved');
262 // Second, set the 'htmlForOtherViewModes' attribute, so that when
263 // this field is rerendered, the change can be propagated to other
264 // instances of this field, which may be displayed in different view
266 fieldModel.set('htmlForOtherViewModes', response.other_view_modes);
267 // Finally, set the 'html' attribute on the field model. This will
268 // cause the field to be rerendered.
269 fieldModel.set('html', response.data);
272 // Unsuccessfully saved; validation errors.
273 self.formSaveAjax.commands.quickeditFieldFormValidationErrors = function(
279 editorModel.set('validationErrors', response.data);
280 fieldModel.set('state', 'invalid');
283 // The quickeditFieldForm AJAX command is only called upon loading the
284 // form for the first time, and when there are validation errors in the
285 // form; Form API then marks which form items have errors. This is
286 // useful for the form-based in-place editor, but pointless for any
287 // other: the form itself won't be visible at all anyway! So, we just
289 self.formSaveAjax.commands.quickeditFieldForm = function() {};
291 fillAndSubmitForm(editorModel.get('currentValue'));
296 * Shows validation error messages.
298 * Should be called when the state is changed to 'invalid'.
300 showValidationErrors() {
302 '<div class="quickedit-validation-errors"></div>',
303 ).append(this.model.get('validationErrors'));
304 this.getEditedElement()
305 .addClass('quickedit-validation-error')
310 * Cleans up validation error messages.
312 * Should be called when the state is changed to 'candidate' or 'saving'. In
313 * the case of the latter: the user has modified the value in the in-place
314 * editor again to attempt to save again. In the case of the latter: the
315 * invalid value was discarded.
317 removeValidationErrors() {
318 this.getEditedElement()
319 .removeClass('quickedit-validation-error')
320 .next('.quickedit-validation-errors')
325 })(jQuery, Backbone, Drupal);