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

[Discourse]

Zuvor wurden alle Farben in Discourse als SCSS-Variablen gespeichert. Um automatisches Umschalten des Farbschemas für den Dunkelmodus zu unterstützen, haben wir diese Farben im Kern in benutzerdefinierte CSS-Eigenschaften umgewandelt. Sie können die vollständige Liste jetzt einfach im Inspektor einsehen:

Themes und Plugins müssen alle $color SCSS-Variablen, die in Stylesheets verwendet werden, auf die entsprechenden --color CSS-Eigenschaften umstellen. In den meisten Fällen handelt es sich dabei um eine einfache Suchen-und-Ersetzen-Aufgabe:

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

Es gibt jedoch einige Fälle, in denen ein Theme oder ein Plugin eine komplexere Variation einer Farbe verwendet, beispielsweise beim Abdunkeln oder Aufhellen mit SCSS-Farbfunktionen. Diese Fälle erfordern eine komplexere Refaktorierung, und dafür haben wir die Möglichkeit hinzugefügt, Farbdefinitionen in Themes und Plugins zu erweitern.

In Plugins

Dieser Commit im discourse-encrypt-Plugin ist ein gutes und einfaches Beispiel für eine solche Refaktorierung. Er verschiebt eine mix($color1, $color2) SCSS-Deklaration in eine separate Datei und speichert sie als CSS-Benutzereigenschaft. Anschließend wird die neue Datei als :color_definitions-Asset registriert, was sicherstellt, dass die neu deklarierte Farbeigenschaft in das Stylesheet für Farbdefinitionen aufgenommen wird.

In Themes

In Themes können Sie dasselbe tun, indem Sie CSS-Benutzereigenschaften in der Stylesheet-Datei common/color_definitions.scss deklarieren. Ein Beispiel hierfür finden Sie in diesem Commit im graceful-Theme.

Einige zusätzliche Hinweise

• Wenn transparente Farben über die Funktion rgba($color, 0.5) verwendet werden, akzeptiert SCSS HEX- und RGB-Farben als ersten Parameter, während CSS-Benutzereigenschaften nur eine RGB-Farbe akzeptieren. Deshalb haben wir den Hilfsfunktion hexToRGB() und einige Eigenschaften mit dem Suffix --rgb in den Farbdefinitionen eingeführt. Ein Beispiel:

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

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

• Beachten Sie, dass in dem obigen Snippet die SCSS-Variable interpoliert wird, wenn sie an eine benutzerdefinierte Eigenschaft übergeben wird. Dies ist eine Anforderung in SCSS, siehe Sass: Property Declarations für weitere Details.
• Die CSS var()-Deklaration kann einen zweiten Wert als Fallback verwenden, falls der erste nicht verfügbar ist, z. B. wenn Sie var(--color1, red) schreiben, wird CSS auf die Farbe Rot zurückfallen, falls die Eigenschaft --color1 nicht gefunden wird. In Plugins verwenden wir die SCSS-Farbvariablen als Fallbacks, um die Kompatibilität mit früheren Versionen von Discourse zu gewährleisten. Das frühere Beispiel würde mit einem Fallback wie folgt aussehen:

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

---

Dieses Dokument wird versioniert – schlagen Sie Änderungen auf github vor.

[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).