Themes und Plugins aktualisieren, um den automatischen Dunkelmodus zu unterstützen

[Discourse]

Previously, all colors in Discourse were stored as SCSS variables. To support automatic dark mode color scheme switching, we have converted these colors in core to custom CSS properties. You can easily see the full list in the inspector now:

Themes and plugins need to switch all the $color SCSS variables used in stylesheets to the --color CSS property equivalents. In most cases, this is a simple find and replace task:

-   background-color: $primary-very-low;
+   background-color: var(--primary-very-low);

But there are some cases where a theme or a plugin is using a more complex variation of a color, for example, when darkening or lightening using SCSS color functions. These cases require a more complex refactoring, and for this we have added the capacity to extend color definitions in themes and plugins.

In plugins

This commit in the discourse-encrypt plugin is a good and simple example of such a refactor. It moves a mix($color1, $color2) SCSS declaration into a separate file and stores it as a CSS custom property. Then the new file is registered as a :color_definitions asset which ensures that the newly declared color property is included in the color definitions stylesheet.

In themes

In themes, you can do the same thing by declaring CSS custom properties in the common/color_definitions.scss stylesheet. You can look at this commit in the graceful theme for an example.

Some additional notes

• when using transparent colors via the rgba($color, 0.5) function, SCSS accepts HEX and RGB colors in the first parameter, whereas CSS custom properties only accept an RGB color. That is why we have introduced the hexToRGB() helper and some properties with the --rgb suffix in the color definitions. An example:

// color_definitions.scss
:root {
  --primary: #{$primary};
  --primary-rgb: #{hexToRGB($primary)};
}

// other stylesheet
.element {
  background-color: rgba(var(--primary-rgb), 0.05);
}

• note that in the snippet above, the SCSS variable is interpolated when passed to a custom property. That is a requirement in SCSS, see Sass: Property Declarations for more details.
• the CSS var() declaration can fallback to a second value if the first one is not available, as in, when writing var(--color1, red), CSS will fallback to the red color if the --color1 property is not found. In plugins, we use the SCSS color variables as fallbacks to ensure compatibility with previous versions of Discourse. So the earlier example, would look like this with a fallback:

-   background-color: $primary-very-low;
+   background-color: var(--primary-very-low, $primary-very-low);

---

This document is version controlled - suggest changes on github.

[pfaffman (Jay Pfaffman)]

@pmusaraj

Themes and plugins need to switch all the $color SCSS variables used in stylesheets to the --color CSS property equivalents. I

I’m not very good at this stuff and it’ll take me a while to figure this out myself. . . Does this mean that all themes that referred to colors before are now going to be broken?

[pmusaraj (Penar Musaraj)]

No, not at all. SCSS variables in themes will continue to work for a long time.

But any colors outputted via SCSS variables will stay static, i.e. they cannot be dynamically switched to a new color scheme when a browser goes from normal to dark mode. So those themes/plugins will continue to work, they just won’t be compatible with automatic dark mode switching.

[tomtjes (Thomas Reintjes)]

Thanks for the instructions. Is there a way to also change a background image depending on dark/light mode? (I’ve used the theme switcher component to do that.) Would a CSS class indicating the mode be possible?

[pmusaraj (Penar Musaraj)]

Great question, I tried this and noticed that we didn’t properly support using background images or theme variables in the special color definitions stylesheet. So I made some fixes in core, and you should be able to do this now (make sure you pull the latest core).

So, if you have two images in your theme or theme component, with SCSS vars of $bg-light and $bg-dark respectively, you can add this to your color_definitions.scss stylesheet:

$bg: url(dark-light-choose($bg-light, $bg-dark));

:root {
  --custom-bg: #{$bg};
}

And then you can use var(--custom-bg) in your regular stylesheet.

[riking (Kane York)]

For an image, all you need to do is the vanilla prefers-dark-theme CSS media query.

[pmusaraj (Penar Musaraj)]

@riking

vanilla prefers-dark-theme CSS media query

That won’t work well in all cases, because the media query is not aware of the user’s preferences. Users can disable auto-dark-mode switching, but the media query won’t be aware of that, and it will result in the background meant for the dark color scheme being rendered.

[j127]

Ist es möglich, dass Discourse auch eine CSS-Klasse zum <body>-Tag für das Farbschema oder die Farbschema-ID hinzufügt? Es scheint, als wäre das viel einfacher.

Ich versuche, ein Problem bei der Konvertierung eines Themes zu lösen, bei dem ich viele verschiedene CSS-Regeln und Variablen benötige, und es entwickelt sich zu einem komplexen Durcheinander in der Datei color_definitions.scss.

Wenn ich in einer isolierten SCSS-Datei im Theme einfach so etwas tun könnte, würde es 5 Minuten dauern, etwas zu tun, für das ich mit color_definitions.scss lange brauche, um es herauszufinden:

body.dark-palette .some-thing {
  // some styles
}

body.light-palette .some-thing {
  // some styles
}

[pmusaraj (Penar Musaraj)]

Ja, man kann viele Codezeilen in den Farldefinitionsdateien haben, insbesondere für Farbverläufe.

Es ist meiner Meinung nach immer noch der am besten geeignete „Ort“ dafür. Es ist zwar vom Element entfernt, das es verwendet, aber es ist ein praktischer, einzelner Ort, der Farben/Farbverläufe verarbeitet, die sich je nach Licht-/Dunkelmodus ändern.

Eine Alternative ist die Verwendung von etwas wie diesem:

@container style(--scheme-type: light){
  body{
    background: red;
  }
}

Unsere Farbschemata verfügen über eine Eigenschaft --scheme-type, die für helle Schemata light und für dunkle Schemata dark ist. Neuere Browser unterstützen Containerabfragen, sodass dies das tun sollte, was Sie hier versuchen zu erreichen, ohne der Body-Seite eine Klasse hinzuzufügen.

[j127]

Meine CSS/SCSS-Kenntnisse sind nicht besonders gut. Vielleicht ist das für Leute, die sich damit auskennen, einfacher.

Es hat die Datei color_definitions.scss unübersichtlich gemacht, also habe ich sie in eine andere Datei in scss/ verschoben, damit ich sie importieren kann. Ich bin mir nicht sicher, wie ich das alles benennen soll, daher sieht es so aus.

Ich denke, es wäre einfacher, dies mit einer Body-Klasse (oder vielleicht einigen weiteren Beispielen) zu tun, aber auf jeden Fall funktioniert es vorerst. Ich weiß nicht, wie Container Queries funktionieren, aber das werde ich später recherchieren.

[panic]

Beachten Sie, dass Style-Abfragen für benutzerdefinierte Eigenschaften unter Firefox nicht funktionieren (Stand: 14.11.2025).