What is userChrome.js?

Posted by jscher2000 on November 25, 2017

The subject of this site is the userChrome.css file and style recipes that can modify the appearance of Firefox's user interface. However, style rules cannot change the fundamental behavior of user interface features, and userChrome.css is not able to override certain built-in style rules, such as the appearance of scrollbars and form controls. If you are intent on making deeper changes, and you can't find a compatible extension, one option to consider would be applying scripts directly to the interface, like the Legacy extension userChromeJS made possible.

SAFETY FIRST! Unlike style rules that mess up the interface a bit, scripts implemented through userChrome.js have the potential to do anything that a Legacy extension could do. Please exercise great caution in adding scripts to your Firefox as they may not have gone through any kind of review process to screen for malicious code.

How it Works

XBL Binding

The gHacks Tech News site recently ran an article about how you can deploy the power of userChrome.js in Firefox Quantum. The featured example involves using the Firefox-specific -moz-binding style property in the userChrome.css file to sneak in the modification:

toolbarbutton#alltabs-button {
  -moz-binding: url("userChrome.xml#js");
}

The accompanying userChrome.xml file directs Firefox to load the userChrome.js file, where you would add your scripts. Source: https://github.com/nuchi/firefox-quantum-userchromejs via Run userchrome.js scripts in Firefox 57 or newer. Copyright (c) 2017 Haggai Nuchi. Available for use under the MIT License: https://opensource.org/licenses/MIT.

Autoconfig File

At startup, Firefox checks for JavaScript files in the program folder under /defaults/pref. An Autoconfig file — which may be named autoconfig.js, local-settings.js, or whatever.js — directs Firefox to another JavaScript file, sometimes but not always named mozilla.cfg, that contains the actual script code. This Autoconfig mechanism is most often used by companies to preconfigure or lock down Firefox, but it has wide ranging applications. As Mike Kaply reminds us in his 2012 series on the topic, "Autoconfig files are Javascript files that have full access to all components of Firefox." See: Customizing Firefox – Advanced Autoconfig Files. Mozilla has some basic documentation on MDN: Deploying Firefox in an enterprise environment.

By placing a config-prefs.js file in /defaults/pref, and three other files in suitable locations, Firefox can load and run the basic functionality of the userChromeJS extension. The installation procedure is set forth in German at https://github.com/Endor8/userChrome.js/tree/master/userChrome. There are existing repositories of scripts in at least two locations, and more are likely to emerge:

Needless to say (but I'll say it anyway), any use of these approaches is at your own risk.

Share Your Experience!

If you try any of these solutions, please post comments using the FEEDBACK button in the bar at the top of the page (you can be anonymous if you like). Let me know how it went, and let others know if you recommend particular scripts.