XWIKI-20953: Edit autosave frequency visibility #4682
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,18 @@ | ||
| #autosaveControl { | ||
| display: inline; | ||
| white-space: nowrap; | ||
| } | ||
|
|
||
| #autosaveControl .interval { | ||
| display: none; | ||
| margin-left: 2em; | ||
|
|
||
| & .autosave-interval { | ||
| width: 3em; | ||
| margin-left: 1em; | ||
| } | ||
| } | ||
|
|
||
| #autosaveControl .autosave:has(input:checked) + .interval { | ||
| display: inline-block; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,7 +31,7 @@ editors.AutoSave = Class.create({ | |
| /** Is the autosave enabled ? */ | ||
| enabled: false, | ||
| /** If enabled, how frequent are the savings */ | ||
| interval: 5, // minutes | ||
|
Contributor
There was a problem hiding this comment. This is a breaking API change as this is a public API, e.g., documented at https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/FrontendResources/Autosave/. I would suggest not modifying the API and just modifying the displayed text. |
||
| /** Is the UI for configuring the autosave enabled or not? */ | ||
| showConfigurationUI: true, | ||
| /** | ||
|
|
@@ -45,7 +45,7 @@ editors.AutoSave = Class.create({ | |
| /** Initialization */ | ||
| initialize : function(options) { | ||
| this.options = Object.extend(Object.clone(this.options), options || { }); | ||
| this.form = $(this.options.form) || $("xwikieditcontent")?.up('form'); | ||
| if (!this.form || this.form.down('#autosaveControl')) { | ||
| return; | ||
| } | ||
|
|
@@ -83,44 +83,40 @@ editors.AutoSave = Class.create({ | |
| }, | ||
|
|
||
| /** | ||
| * The UI of the autosave feature is created and introduced towards the end of the edit form. | ||
| * It contains a checkbox for toggling the autosave and an input that allows to set the autosave interval in minutes. | ||
| */ | ||
| createUIElements : function() { | ||
| // Toggle for the autosave feature. | ||
| this.autosaveCheckbox = new Element('input', { | ||
| type: "checkbox", | ||
| checked: this.options.enabled, | ||
| name: "doAutosave", | ||
| id: "doAutosave" | ||
| }); | ||
| // Input for setting the autosave interval | ||
| this.autosaveIntervalInput = new Element('input', { | ||
| type: "text", | ||
| value: this.options.interval, | ||
| size: "2", | ||
| "class": "autosave-interval" | ||
| }); | ||
| // Labels | ||
| let autosaveLabel = new Element('label', {'class': 'autosave'}); | ||
| autosaveLabel.appendChild(this.autosaveCheckbox); | ||
| autosaveLabel.appendChild(document.createTextNode("$escapetool.javascript($services.localization.render('core.edit.autosave'))")); | ||
|
Contributor
There was a problem hiding this comment. It would be much simpler to use the |
||
| let intervalLabel = new Element('label', {'class': 'interval'}); | ||
| intervalLabel.appendChild(document.createTextNode("$escapetool.javascript($services.localization.render('core.edit.autosave.interval.label'))")); | ||
| intervalLabel.appendChild(this.autosaveIntervalInput); | ||
| // A paragraph containing the whole thing | ||
| let container = new Element('div', {"id": "autosaveControl"}); | ||
| this.classNameAutosaveDisabled = 'autosaveDisabled'; | ||
| if (!this.options.enabled) { | ||
| container.addClassName(this.classNameAutosaveDisabled); | ||
| } | ||
| container.appendChild(autosaveLabel); | ||
| container.appendChild(document.createTextNode(" ")); | ||
| container.appendChild(intervalLabel); | ||
| container.appendChild(document.createTextNode(" ")); | ||
| // Insert in the editing UI | ||
| this.form.down('.buttons').insert(container); | ||
|
|
@@ -138,7 +134,7 @@ editors.AutoSave = Class.create({ | |
| } | ||
| }; | ||
| ["keydown", "keyup", "keypress"].each(function(eventName) { | ||
| this.autosaveIntervalInput.observe(eventName, preventSubmit); | ||
| this.autosaveCheckbox.observe(eventName, preventSubmit); | ||
| }.bind(this)); | ||
|
|
||
|
|
@@ -147,38 +143,24 @@ editors.AutoSave = Class.create({ | |
| this.toggleTimer(this.autosaveCheckbox.checked); | ||
| }.bindAsEventListener(this)); | ||
|
|
||
| // Set autosave interval | ||
| Event.observe(this.autosaveIntervalInput, "blur", function() { | ||
| // is the given value valid? | ||
| let newInterval = Number(this.autosaveIntervalInput.value); | ||
| if (newInterval > 0) { | ||
| // yes: memorize it | ||
| this.options.interval = newInterval; | ||
| // reset autosave loop | ||
| this.startTimer(); | ||
| } else { | ||
| // no: restore the previous value in the input | ||
| this.autosaveIntervalInput.value = this.options.interval; | ||
| } | ||
| }.bindAsEventListener(this)); | ||
|
|
||
| this._toggleTimerWhenSaveButtonIsEnabledOrDisabled(); | ||
| }, | ||
|
|
||
| /** | ||
| * Stop the timer when the save button is disabled (e.g. because there is another save in progress or because the save | ||
| * button was hidden) and restart the timer, if needed, when the save button is enabled. | ||
|
|
@@ -207,30 +189,30 @@ editors.AutoSave = Class.create({ | |
| } | ||
| if (this.options.enabled) { | ||
| this.startTimer(); | ||
| if (this.autosaveIntervalInput) { | ||
| this.autosaveIntervalInput.up(1).removeClassName(this.classNameAutosaveDisabled); | ||
| } | ||
| } else { | ||
| this.stopTimer(); | ||
| if (this.autosaveIntervalInput) { | ||
| this.autosaveIntervalInput.up(1).addClassName(this.classNameAutosaveDisabled); | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| /** | ||
| * Start autosave timer when the autosave is enabled. | ||
| * Every (this.options.interval * 60) seconds, the callback function doAutosave is called. | ||
| */ | ||
| startTimer : function() { | ||
| // Make sure we stop the existing timer. | ||
| this.stopTimer(); | ||
| this.timer = new PeriodicalExecuter(this.doAutosave.bind(this), | ||
| this.options.interval * 60 /* seconds in a minute */); | ||
| }, | ||
|
|
||
| /** | ||
| * Stop the autosave loop when the autosave is disabled or when the autosave interval is changed | ||
| * and the loop needs to be restarted. | ||
| */ | ||
| stopTimer : function() { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The term "mins" is colloquial English, I think we should use a proper formal term like "minutes".