Mettre à jour les thèmes et les plugins pour supporter le mode sombre automatique

[Discourse]

Auparavant, toutes les couleurs dans Discourse étaient stockées sous forme de variables SCSS. Pour prendre en charge la bascule automatique du thème de couleur en mode sombre, nous avons converti ces couleurs dans le cœur en propriétés CSS personnalisées. Vous pouvez facilement voir la liste complète dans l’inspecteur maintenant :

Les thèmes et les plugins doivent remplacer toutes les variables SCSS $color utilisées dans les feuilles de style par les équivalents de propriétés CSS --color. Dans la plupart des cas, il s’agit d’une simple tâche de recherche et remplacement :

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

Mais il existe des cas où un thème ou un plugin utilise une variation plus complexe d’une couleur, par exemple, lors de l’assombrissement ou de l’éclaircissement à l’aide de fonctions de couleur SCSS. Ces cas nécessitent un refactoring plus complexe, et pour cela, nous avons ajouté la capacité d’étendre les définitions de couleurs dans les thèmes et les plugins.

Dans les plugins

Ce commit dans le plugin discourse-encrypt est un bon et simple exemple d’un tel refactoring. Il déplace une déclaration SCSS mix($color1, $color2) dans un fichier séparé et la stocke en tant que propriété personnalisée CSS. Ensuite, le nouveau fichier est enregistré en tant qu’actif :color_definitions, ce qui garantit que la propriété de couleur nouvellement déclarée est incluse dans la feuille de style des définitions de couleur.

Dans les thèmes

Dans les thèmes, vous pouvez faire la même chose en déclarant des propriétés CSS personnalisées dans la feuille de style common/color_definitions.scss. Vous pouvez consulter ce commit dans le thème graceful pour un exemple.

Quelques notes supplémentaires

• lorsque vous utilisez des couleurs transparentes via la fonction rgba($color, 0.5), SCSS accepte les couleurs HEX et RVB dans le premier paramètre, tandis que les propriétés CSS personnalisées n’acceptent qu’une couleur RVB. C’est pourquoi nous avons introduit l’utilitaire hexToRGB() et certaines propriétés avec le suffixe --rgb dans les définitions de couleurs. Un exemple :

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

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

• notez que dans l’extrait ci-dessus, la variable SCSS est interpolée lorsqu’elle est transmise à une propriété personnalisée. C’est une exigence en SCSS, voir Sass: Property Declarations pour plus de détails.
• la déclaration CSS var() peut avoir une valeur de secours si la première n’est pas disponible, comme dans, lorsque vous écrivez var(--color1, red), CSS utilisera la couleur rouge si la propriété --color1 n’est pas trouvée. Dans les plugins, nous utilisons les variables de couleur SCSS comme valeurs de secours pour assurer la compatibilité avec les versions précédentes de Discourse. Ainsi, l’exemple précédent ressemblerait à ceci avec une valeur de secours :

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

---

Ce document est contrôlé par version - suggérez des modifications sur 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]

Est-il possible pour Discourse d’ajouter également une classe CSS à la balise <body> pour le schéma de couleurs ou l’ID du schéma de couleurs ? Cela semble beaucoup plus facile.

J’essaie de résoudre un problème lors de la conversion d’un thème où j’ai besoin de nombreuses règles CSS et variables différentes, et cela se transforme en un désordre complexe dans le fichier color_definitions.scss.

Si je pouvais simplement faire quelque chose comme ceci dans un fichier SCSS isolé dans le thème, cela prendrait 5 minutes pour faire quelque chose qui prend beaucoup de temps à comprendre avec color_definitions.scss :

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

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

[pmusaraj (Penar Musaraj)]

Oui, vous pouvez vous retrouver avec de nombreuses lignes de code dans les fichiers de définition de couleurs, en particulier pour les dégradés.

C’est toujours l’endroit le plus approprié à mon avis. C’est loin de l’élément où il est utilisé, oui, mais c’est un endroit unique et pratique qui gère les couleurs/dégradés qui changent en fonction du mode clair/sombre.

Une alternative consiste à utiliser quelque chose comme ceci :

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

Nos schémas de couleurs sont livrés avec une propriété --scheme-type qui est light pour les schémas clairs et dark pour les schémas sombres. Les navigateurs récents prennent en charge les requêtes de conteneur, donc cela devrait faire ce que vous essayez d’accomplir ici sans ajouter une classe au corps de la page.

[j127]

Mes compétences en CSS/SCSS ne sont pas excellentes. C’est peut-être plus facile pour les personnes qui sont très familières avec ces langages.

Cela causait des problèmes dans le fichier color_definitions.scss, alors je l’ai déplacé dans un autre fichier dans scss/ pour pouvoir l’importer. Je ne suis pas sûr de comment nommer tout cela, donc ça ressemble à ça.

Je pense que ce serait plus facile à faire avec une classe body (ou peut-être quelques exemples supplémentaires), mais en tout cas, ça fonctionne pour le moment. Je ne sais pas comment fonctionnent les requêtes de conteneur, mais je ferai des recherches plus tard.

[panic]

Notez que les requêtes de style pour les propriétés personnalisées ne fonctionnent pas sur Firefox à la date d’aujourd’hui (14/11/2025).