Skip to content

Persist view state of sidebar elements in browser local storage #1894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2025
Merged

Persist view state of sidebar elements in browser local storage #1894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 78 additions & 37 deletions src/moin/static/js/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
function MoinMoin() {
"use strict";
}

// Utility function to add a message to moin flash area. Message can be removed by clicking on it.
MoinMoin.prototype.MOINFLASHINFO = "moin-flash moin-flash-info";
MoinMoin.prototype.MOINFLASHWARNING = "moin-flash moin-flash-warning";
Expand All @@ -19,14 +20,12 @@ MoinMoin.prototype.moinFlashMessage = function (classes, message) {
});
};


// if /template/dictionary.js has not been loaded, untranslated strings will be returned by _(...)
function _(text) {
"use strict";
return $.i18n._(text);
}


// return true if browser localStorage is available
function localStorageAvailable() {
"use strict";
Expand All @@ -41,44 +40,70 @@ function localStorageAvailable() {
}
}

// executed when user clicks button to toggle modify textarea between fixed/variable width fonts
function moinFontChange() {
// executed on page ready, if this is a modify view add action to Cancel button
function cancelEdit() {
"use strict";
$(".moin-edit-content").toggleClass("moin-fixed-width");
$('.moin-cancel').click(function () {
// do not ask to leave page; any edits will be lost, but browser back button may restore edits
$('#moin-modify').removeClass('moin-changed-input');
window.location = $('#moin-wiki-root').val() + '/' + $('#moin-item-name').val();
});
}

// Initial user settings
MoinMoin.prototype.userSettings = {
'user-actions-collapsed': true,
'view-options-collapsed': true,
'item-actions-collapsed': true
};

MoinMoin.prototype.loadUserSettings = function () {
if (localStorageAvailable()) {
if ($(".moin-edit-content").hasClass("moin-fixed-width")) {
localStorage.setItem("moin-textarea-font", "moin-fixed-width");
} else {
localStorage.setItem("moin-textarea-font", "");
let jsonData = localStorage.getItem("moin-user-settings");
if (jsonData) {
this.userSettings = JSON.parse(jsonData);
}
}
}

// executed on page ready, change textarea font to last saved value fixed/proportional
function moinFontChangeOnReady() {
"use strict";
if ($(".moin-edit-content")) {
if (localStorageAvailable()) {
if (localStorage.getItem("moin-textarea-font") === "moin-fixed-width") {
$(".moin-edit-content").addClass("moin-fixed-width");
} else {
$(".moin-edit-content").removeClass("moin-fixed-width");
}
}
MoinMoin.prototype.saveUserSettings = function () {
if (localStorageAvailable()) {
localStorage.setItem("moin-user-settings", JSON.stringify(this.userSettings));
}
}

MoinMoin.prototype.applyUserSettings = function () {

// executed on page ready, if this is a modify view add action to Cancel button
function cancelEdit() {
"use strict";
$('.moin-cancel').click(function () {
// do not ask to leave page; any edits will be lost, but browser back button may restore edits
$('#moin-modify').removeClass('moin-changed-input');
window.location = $('#moin-wiki-root').val() + '/' + $('#moin-item-name').val();
});
}
if (this.userSettings['user-actions-collapsed']) {
$('#moin-user-actions').addClass('hidden');
$('.moin-useractions > i').removeClass('fa-rotate-90');
} else {
$('#moin-user-actions').removeClass('hidden');
$('.moin-useractions > i').addClass('fa-rotate-90');
}

if (this.userSettings['view-options-collapsed']) {
$('#moin-view-options').addClass('hidden');
$('.moin-viewoptions > i').removeClass('fa-rotate-90');
} else {
$('#moin-view-options').removeClass('hidden');
$('.moin-viewoptions > i').addClass('fa-rotate-90');
}

if (this.userSettings['item-actions-collapsed']) {
$('#moin-item-actions').addClass('hidden');
$('.moin-itemactions > i').removeClass('fa-rotate-90');
} else {
$('#moin-item-actions').removeClass('hidden');
$('.moin-itemactions > i').addClass('fa-rotate-90');
}

if (this.userSettings["textarea-use-fixed-width-font"]) {
$(".moin-edit-content").addClass("moin-fixed-width");
} else {
$(".moin-edit-content").removeClass("moin-fixed-width");
}
}

// Highlight currently selected link in side panel. Executed on page load
MoinMoin.prototype.selected_link = function () {
Expand Down Expand Up @@ -760,6 +785,9 @@ $(document).ready(function () {
"use strict";
var moin = new MoinMoin();

moin.loadUserSettings()
moin.applyUserSettings();

moin.diffScroll();
moin.selected_link();
moin.initTransclusionOverlays();
Expand All @@ -781,26 +809,41 @@ $(document).ready(function () {
moin.toggleSubtree(this);
});

$('.moin-useractions').click(function () {
$('.moin-useractions').click(function (event) {
event.preventDefault();
$('#moin-user-actions').toggleClass('hidden');
$('.moin-useractions > i').toggleClass('fa-rotate-90');
return false;
moin.userSettings['user-actions-collapsed'] = $('#moin-user-actions').hasClass('hidden');
moin.saveUserSettings();
});

$('.moin-viewoptions').click(function () {
$('.moin-viewoptions').click(function (event) {
event.preventDefault();
$('#moin-view-options').toggleClass('hidden');
$('.moin-viewoptions > i').toggleClass('fa-rotate-90');
return false;
moin.userSettings['view-options-collapsed'] = $('#moin-view-options').hasClass('hidden');
moin.saveUserSettings();
});

$('.moin-itemactions').click(function () {
$('.moin-itemactions').click(function (event) {
event.preventDefault();
$('#moin-item-actions').toggleClass('hidden');
$('.moin-itemactions > i').toggleClass('fa-rotate-90');
return false;
moin.userSettings['item-actions-collapsed'] = $('#moin-item-actions').hasClass('hidden');
moin.saveUserSettings();
});

// executed when user clicks button to toggle modify textarea between fixed/variable width fonts
$('#moin-toggle-fixed-font-button').on('click', function (event) {
event.preventDefault();
$(".moin-edit-content").toggleClass("moin-fixed-width");
moin.userSettings['textarea-use-fixed-width-font'] = $(".moin-edit-content").hasClass("moin-fixed-width");
moin.saveUserSettings();
});

moin.enhanceUserSettings();
moin.enhanceEdit();

$('.moin-sortable').tablesorter();

$('#moin-modify').on('change keyup keydown', 'input, textarea, select', function (e) {
Expand Down Expand Up @@ -859,8 +902,6 @@ $(document).ready(function () {
}
});

moinFontChangeOnReady();

$('textarea.moin-autosize').autosize();

showAllOptions();
Expand Down
2 changes: 1 addition & 1 deletion src/moin/templates/modify_text.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{% macro data_editor(form, item_name) %}
{% set textarea_rows = '1' if edit_rows == '0' else edit_rows %}
{% set cls = 'moin-edit-content moin-autosize' if edit_rows == '0' else 'moin-edit-content' %}
<input type="button" onclick="moinFontChange()" value="{{ _('Toggle font width') }}" class="moin-button moin-textarea-font" >
<input type="button" id="moin-toggle-fixed-font-button" value="{{ _('Toggle font width') }}" class="moin-button moin-textarea-font" >
{{ gen.textarea(form['data_text'], rows=textarea_rows|string, class=cls, **kwargs) }}
{{ base_editor(form) }}
<br>
Expand Down
2 changes: 1 addition & 1 deletion src/moin/themes/basic/templates/modify_text.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% from "modify_binary.html" import data_editor as base_editor %}

{% macro basic_data_editor(form, item_name) %}
<input type="button" onclick="moinFontChange()" value="{{ _('Toggle font width') }}" class="moin-button moin-textarea-font" >
<input type="button" id="moin-toggle-fixed-font-button" value="{{ _('Toggle font width') }}" class="moin-button moin-textarea-font" >
{{ gen.textarea(form['data_text'], rows=form.rows|string, cols=form.cols|string, class="moin-edit-content", **kwargs) }}
{{ base_editor(form) }}
<br>
Expand Down