mirrors/zotero
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Deprecate setFontSize(), replace with new Zotero.UIProperties

Browse source 
This new XPCOM module handles font size and UI density and automatically keeps
registered roots up to date when prefs change. Roots receive a
UIPropertiesChanged event after their properties are updated.
This commit is contained in:
Abe Jellinek 2023-09-29 11:47:24 -04:00 committed by Dan Stillman
parent d6e5da403c
commit 1dd3812e00
18 changed files with 116 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
chrome/content/scaffold/scaffold.js
View file

@ -165,7 +165,7 @@ var Scaffold = new function () {
this.initTestsEditor();
// Set font size from general pref
Zotero.setFontSize(document.getElementById('scaffold-pane'));
Zotero.UIProperties.registerRoot(document.getElementById('scaffold-pane'));
// Set font size of code editor
var size = Zotero.Prefs.get("scaffold.fontSize");

2
chrome/content/zotero/advancedSearch.js
View file

@ -45,7 +45,7 @@ var ZoteroAdvancedSearch = new function() {
// Set font size from pref
var sbc = document.getElementById('zotero-search-box-container');
Zotero.setFontSize(sbc);
Zotero.UIProperties.registerRoot(sbc);
_searchBox.onLibraryChange = this.onLibraryChange;
var io = window.arguments[0];

2
chrome/content/zotero/bibliography.js
View file

@ -57,7 +57,7 @@ var Zotero_File_Interface_Bibliography = new function() {
// Affects bibliography.xhtml and integrationDocPrefs.xul
var bibContainer = document.getElementById("zotero-bibliography-container");
if(bibContainer) {
Zotero.setFontSize(document.getElementById("zotero-bibliography-container"));
Zotero.UIProperties.registerRoot(document.getElementById("zotero-bibliography-container"));
}
if(window.arguments && window.arguments.length) {

2
chrome/content/zotero/createParentDialog.js
View file

@ -35,7 +35,7 @@ function toggleAccept(enabled) {
function doLoad() {
// Set font size from pref
let sbc = document.getElementById('zotero-create-parent-container');
Zotero.setFontSize(sbc);
Zotero.UIProperties.registerRoot(sbc);
io = window.arguments[0];

4
chrome/content/zotero/exportOptions.js
View file

@ -45,7 +45,7 @@ var Zotero_File_Interface_Export = new function() {
this.init = function () {
// Set font size from pref
var sbc = document.getElementById('zotero-export-options-container');
Zotero.setFontSize(sbc);
Zotero.UIProperties.registerRoot(sbc);
var addedOptions = new Object();
@ -286,4 +286,4 @@ var Zotero_File_Interface_Export = new function() {
function cancel() {
window.arguments[0].selectedTranslator = false;
}
}
}

2
chrome/content/zotero/hardConfirmationDialog.js
View file

@ -31,7 +31,7 @@ Zotero.HardConfirmationDialog = {
this.io = window.arguments[0];
Zotero.setFontSize(document.documentElement);
Zotero.UIProperties.registerRoot(document.documentElement);
var dialog = document.getElementById('commonDialog');
var vbox = document.getElementById('infoContainer');
var sep = vbox.firstChild;

2
chrome/content/zotero/ingester/selectitems.js
View file

@ -44,7 +44,7 @@ Zotero_Ingester_Interface_SelectItems.init = function () {
// Set font size from pref
var sbc = document.getElementById('zotero-select-items-container');
Zotero.setFontSize(sbc);
Zotero.UIProperties.registerRoot(sbc);
this.io = window.arguments[0];
var listbox = document.getElementById("zotero-selectitems-links");

2
chrome/content/zotero/merge.js
View file

@ -48,7 +48,7 @@ var Zotero_Merge_Window = new function () {
_wizard.addEventListener('wizardfinish', this.onFinish.bind(this));
// Set font size from pref
Zotero.setFontSize(_wizardPage);
Zotero.UIProperties.registerRoot(_wizardPage);
_wizard.getButton('cancel').setAttribute('label', Zotero.getString('sync.cancel'));

4
chrome/content/zotero/note.js
View file

@ -61,7 +61,7 @@ async function onLoad() {
noteEditor.viewMode = 'window';
// Set font size from pref
Zotero.setFontSize(noteEditor);
Zotero.UIProperties.registerRoot(noteEditor);
if (itemID) {
var ref = await Zotero.Items.getAsync(itemID);
@ -120,4 +120,4 @@ var NotifyCallback = {
}
addEventListener("load", function(e) { onLoad(e); }, false);
addEventListener("unload", function(e) { onUnload(e); }, false);
addEventListener("unload", function(e) { onUnload(e); }, false);

4
chrome/content/zotero/searchDialog.js
View file

@ -33,7 +33,7 @@ function doLoad()
{
// Set font size from pref
var sbc = document.getElementById('zotero-search-box-container');
Zotero.setFontSize(sbc);
Zotero.UIProperties.registerRoot(sbc);
io = window.arguments[0];
@ -65,4 +65,4 @@ function doAccept()
Components.utils.reportError(e);
throw (e);
}
}
}

4
chrome/content/zotero/selectItemsDialog.js
View file

@ -40,7 +40,7 @@ const isAddEditItemsDialog = !!document.querySelector('#zotero-add-citation-dial
var doLoad = async function () {
// Set font size from pref
var sbc = document.getElementById('zotero-select-items-container');
Zotero.setFontSize(sbc);
Zotero.UIProperties.registerRoot(sbc);
io = window.arguments[0];
if(io.wrappedJSObject) io = io.wrappedJSObject;
@ -138,4 +138,4 @@ function onItemSelected()
function doAccept() {
io.dataOut = itemsView.getSelectedItems(true);
}
}

2
chrome/content/zotero/tagColorChooser.js
View file

@ -37,7 +37,7 @@ var Zotero_Tag_Color_Chooser = new function() {
try {
// Set font size from pref
Zotero.setFontSize(document.getElementById("tag-color-chooser-container"));
Zotero.UIProperties.registerRoot(document.getElementById("tag-color-chooser-container"));
if (window.arguments && window.arguments.length) {
_io = window.arguments[0];

12
chrome/content/zotero/xpcom/prefs.js
View file

@ -268,13 +268,11 @@ Zotero.Prefs = new function() {
Zotero.Schema.stopRepositoryTimer();
}
}],
["fontSize", function (val) {
Zotero.setFontSize(
Zotero.getActiveZoteroPane().document.getElementById('zotero-pane')
);
Zotero.setFontSize(Zotero.getActiveZoteroPane().document.getElementById('zotero-context-pane'));
Zotero.getActiveZoteroPane().collectionsView && Zotero.getActiveZoteroPane().collectionsView.updateFontSize();
Zotero.getActiveZoteroPane().itemsView && Zotero.getActiveZoteroPane().itemsView.updateFontSize();
["fontSize", function () {
Zotero.UIProperties.setAll();
}],
["uiDensity", function () {
Zotero.UIProperties.setAll();
}],
["recursiveCollections", function() {
Zotero.getActiveZoteroPane().itemsView.refreshAndMaintainSelection();

2
chrome/content/zotero/xpcom/progressQueueDialog.js
View file

@ -84,7 +84,7 @@ Zotero.ProgressQueueDialog = function (progressQueue) {
function _onWindowLoaded() {
var rootElement = _progressWindow.document.getElementById('zotero-progress-box');
Zotero.setFontSize(rootElement);
Zotero.UIProperties.registerRoot(rootElement);
_progressIndicator = _progressWindow.document.getElementById('progress-indicator');
_progressWindow.document.getElementById('cancel-button')

85
chrome/content/zotero/xpcom/uiProperties.js Normal file
View file

@ -0,0 +1,85 @@
/*
***** BEGIN LICENSE BLOCK *****
Copyright © 2023 Corporation for Digital Scholarship
Vienna, Virginia, USA
https://www.zotero.org
This file is part of Zotero.
Zotero 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.
Zotero 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 Zotero. If not, see <http://www.gnu.org/licenses/>.
***** END LICENSE BLOCK *****
*/
Zotero.UIProperties = new class {
_roots = new Set();
registerRoot(root) {
if (root.nodeType !== Node.ELEMENT_NODE) {
throw new Error('Root must be an element');
}
this._roots.add(new WeakRef(root));
this.set(root);
}
setAll() {
for (let rootRef of this._roots) {
let root = rootRef.deref();
if (!root) {
this._roots.delete(rootRef);
continue;
}
this.set(root);
}
}
set(root) {
this._setFontSize(root);
this._setUIDensity(root);
root.dispatchEvent(new Event('UIPropertiesChanged', { bubbles: false }));
}
_setFontSize(root) {
let size = Zotero.Prefs.get('fontSize');
root.style.fontSize = root.style['--zotero-font-size'] = size + 'em';
if (size <= 1) {
size = 'small';
}
else if (size <= 1.15) {
size = 'medium';
}
else if (size <= 1.3) {
size = 'large';
}
else {
size = 'x-large';
}
// Custom attribute -- allows for additional customizations in zotero.css
root.setAttribute('zoteroFontSize', size);
if (Zotero.rtl) {
root.setAttribute('dir', 'rtl');
}
else {
root.removeAttribute('dir');
}
}
_setUIDensity(root) {
let density = Zotero.Prefs.get('uiDensity');
root.style.setProperty('--zotero-ui-density', density);
root.setAttribute('zoteroUIDensity', density);
}
};

25
chrome/content/zotero/xpcom/utilities_internal.js
View file

@ -1876,30 +1876,9 @@ Zotero.Utilities.Internal = {
return returns;
},
/*
* Sets font size based on prefs -- intended for use on root element
* (zotero-pane, note window, etc.)
*/
setFontSize: function (rootElement) {
var size = Zotero.Prefs.get('fontSize');
rootElement.style.fontSize = rootElement.style['--zotero-font-size'] = size + 'em';
if (size <= 1) {
size = 'small';
}
else if (size <= 1.15) {
size = 'medium';
}
else if (size <= 1.3) {
size = 'large';
}
else {
size = 'x-large';
}
// Custom attribute -- allows for additional customizations in zotero.css
rootElement.setAttribute('zoteroFontSize', size);
if (Zotero.rtl) {
rootElement.setAttribute('dir', 'rtl');
}
Zotero.debug("setFontSize() is deprecated -- use Zotero.UIProperties");
Zotero.UIProperties.set(rootElement);
},
getAncestorByTagName: function (elem, tagName){

8
chrome/content/zotero/zoteroPane.js
View file

@ -103,8 +103,12 @@ var ZoteroPane = new function()
_loaded = true;
var zp = document.getElementById('zotero-pane');
Zotero.setFontSize(zp);
Zotero.setFontSize(document.getElementById('zotero-context-pane'));
Zotero.UIProperties.registerRoot(zp);
zp.addEventListener('UIPropertiesChanged', () => {
this.collectionsView?.updateFontSize();
this.itemsView?.updateFontSize();
});
Zotero.UIProperties.registerRoot(document.getElementById('zotero-context-pane'));
ZoteroPane_Local.updateLayout();
ZoteroPane_Local.updateToolbarPosition();
this.updateWindow();

1
components/zotero-service.js
View file

@ -63,6 +63,7 @@ const xpcomFilesAll = [
'translation/translate_firefox',
'isbn',
'preferencePanes',
'uiProperties',
];
/** XPCOM files to be loaded only for local translation and DB access **/