rafaelmardojai / firefox-gnome-theme

A GNOME👣 theme for Firefox🔥
The Unlicense
3.53k stars 164 forks source link
css firefox gnome gtk theme userchrome
Firefox GNOME theme

Firefox GNOME theme

GitHub Donate Liberapay


A GNOME theme for Firefox

This theme follows latest GNOME Adwaita style.

[!WARNING]

Disclaimer:

Be aware that this theme might do things that are not supported by upstream Firefox. If you face an issue while using this theme, report it here first or test if it is reproducible in vanilla Firefox.

If you are a software distribution maintainer, please do not ship these changes by default to your users unless you make it extremely clear that they are using a modified version of the Firefox UI.

Screenshot of the theme

Description

This is a bunch of CSS code to make Firefox look closer to GNOME's native apps.

Getting in Touch

Matrix room: #firefox-gnome-theme:matrix.org

Firefox versions support

The master branch of this repo supports the current Firefox stable release 132.

Theme versions compatible with older Firefox releases are preserved as git tags.

We also have the beta and nightly branches for fixes only applicable to the current Firefox beta and nightly versions.

Installation

Package managers

Arch Linux

  1. Install the AUR package firefox-gnome-theme
  2. Follow the instructions at cat /usr/share/doc/firefox-gnome-theme/INSTALL.md

One command install with curl

To install this theme, you can run this command, which uses curl to download a script that will also download the latest released version of the theme (not the master version) and run the auto-install script for you.

Warning: Always be careful when running scripts from the Internet.

curl -s -o- https://raw.githubusercontent.com/rafaelmardojai/firefox-gnome-theme/master/scripts/install-by-curl.sh | bash

Installation scripts

If you want to use other version of the theme than the stable one you can manually download the theme and run its install scripts.

First you need to grab a fresh copy of the theme repository by cloning it with git.

  1. Clone this repo and enter folder:

    git clone https://github.com/rafaelmardojai/firefox-gnome-theme.git
    cd firefox-gnome-theme
  2. Checkout a git branch or tag if needed, otherwise use master and ignore this step.
    git checkout beta # Set beta branch
    git checkout v78.1 # Set v78.1 tag

This theme provides two installation scripts in addition to the curled one.

Auto install script

This script will look for Firefox profiles from various known locations (~/.mozilla/firefox/, Flatpak, Snap, etc) and install the theme in each one. It will also enable a color variant for your GTK theme if it exists.

You can execute it by running:

./scripts/auto-install.sh

Manual install script

This script will only install the theme into the profiles found in the default Firefox folder ~/.mozilla/firefox/. The script accepts various flags to change its behavior.

Here are some examples of how to use it:

./scripts/install.sh # Standard
./scripts/install.sh -p pc8577yz.default-release # Only install in a profile named pc8577yz.default-release
./scripts/install.sh -f ~/.var/app/org.mozilla.firefox/.mozilla/firefox # Flatpak
./scripts/install.sh -f ~/snap/firefox/common/.mozilla/firefox #Snap

Script options

Advanced notes ### Advanced notes If you want to checkout the theme version tag matching you Firefox version you can run: ```sh git checkout v$(firefox --version | cut -d ' ' -f 3 | cut -d '.' -f 1) # Using Firefox version ```
Manual installation ## Manual installation 1. Go to `about:support` in Firefox. 2. Application Basics > Profile Directory > Open Directory. 3. Open directory in a terminal. 4. Create a `chrome` directory if it doesn't exist: ```sh mkdir -p chrome cd chrome ``` 5. Clone this repo to a subdirectory: ```sh git clone https://github.com/rafaelmardojai/firefox-gnome-theme.git ``` 6. Create single-line user CSS files if non-existent or empty (at least one line is needed for `sed`): ```sh [[ -s userChrome.css ]] || echo >> userChrome.css [[ -s userContent.css ]] || echo >> userContent.css ``` 7. Import this theme at the beginning of the CSS files (all `@import`s must come before any existing `@namespace` declarations): ```sh sed -i '1s/^/@import "firefox-gnome-theme\/userChrome.css";\n/' userChrome.css sed -i '1s/^/@import "firefox-gnome-theme\/userContent.css";\n/' userContent.css ``` 8. Symlink preferences file: ```sh cd .. # Go back to the profile directory ln -fs chrome/firefox-gnome-theme/configuration/user.js user.js ``` 9. Restart Firefox. 10. Open Firefox customization panel and move the new tab button to headerbar. 11. Be happy with your new gnomish Firefox.

Required Firefox preferences

We provide a user.js configuration file in configuration/user.js that enable some preferences required by this theme to work.

You should already have this file installed if you followed one of the installation methods, but in any case be sure this preferences are enabled under about:config:

For other non essential preferences checkout configuration/user.js.

Updating

You can follow the installation script steps again to update the theme.

Uninstalling

  1. Go to your profile folder. (Go to about:support in Firefox > Application Basics > Profile Directory > Open Directory)
  2. Remove chrome folder.
  3. Remove the unwanted preferences from your user.js inside your profile folder. The install script append the needed prefs in that file, you can check what preferences does it append by checking configuration/user.js in this repo.

Enabling optional features

Optional features can be enabled by creating new boolean preferences in about:config.

  1. Go to the about:config page
  2. Type the key of the feature you want to enable
  3. Set it as a boolean and click on the add button
  4. Restart Firefox

Features

Extensions support

We also have optional features to enable support for some Firefox extensions.

Be aware that extensions support are maintained by the community, so requests to support new extensions are not allowed and the included ones could get broken until someone shows up to fix them.

Known bugs

CSD have sharp corners

See upstream bug.

Wayland fix:

  1. Go to the about:config page
  2. Search for the layers.acceleration.force-enabled preference and set it to true.
  3. Now restart Firefox, and it should look good!

X11 fix:

  1. Go to the about:config page
  2. Type mozilla.widget.use-argb-visuals
  3. Set it as a boolean and click on the add button
  4. Now restart Firefox, and it should look good!

Icons color broken with System icons

Icons might appear black where they should be white on some systems. I have no idea why, but you can adjust them directly in the system-icons.css file, look for --gnome-icons-hack-filter & --gnome-window-icons-hack-filter vars and play with css filters.

Development

If you wanna mess around the styles and change something, you might find these things useful.

To use the Inspector to debug the UI, open the developer tools (F12) on any page, go to options, check both of those:

Now you can close those tools and press Ctrl+Alt+Shift+I to Inspect the browser UI.

Also you can inspect any GTK3 application, for example type this into a terminal and it will run Epiphany with the GTK Inspector, so you can check the CSS styles of its elements too.

GTK_DEBUG=interactive epiphany

Feel free to use any parts of my code to develop your own themes, I don't force any specific license on your code.

Credits

Developed by Rafael Mardojai CM and contributors. Based on Luna Kurame's original work.

Donate

If you want to support development, consider donating via PayPal. Also consider donating upstream, Firefox & GNOME.