Atualize temas e plugins para suportar modo escuro automático

[Discourse]

Anteriormente, todas as cores no Discourse eram armazenadas como variáveis SCSS. Para suportar a troca automática de esquema de cores do modo escuro, convertemos essas cores no núcleo para propriedades CSS personalizadas. Você pode ver facilmente a lista completa no inspetor agora:

Temas e plugins precisam trocar todas as variáveis SCSS $color usadas em folhas de estilo pelas equivalentes propriedades CSS --color. Na maioria dos casos, esta é uma tarefa simples de localizar e substituir:

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

Mas há alguns casos em que um tema ou plugin está usando uma variação mais complexa de uma cor, por exemplo, ao escurecer ou clarear usando funções de cor SCSS. Esses casos exigem uma refatoração mais complexa, e para isso adicionamos a capacidade de estender as definições de cores em temas e plugins.

Em plugins

Este commit no plugin discourse-encrypt é um bom e simples exemplo de tal refatoração. Ele move uma declaração SCSS mix($color1, $color2) para um arquivo separado e a armazena como uma propriedade customizada CSS. Então, o novo arquivo é registrado como um asset :color_definitions, o que garante que a propriedade de cor recém-declarada seja incluída na folha de estilo de definições de cores.

Em temas

Em temas, você pode fazer a mesma coisa declarando propriedades customizadas CSS na folha de estilo common/color_definitions.scss. Você pode ver este commit no tema graceful como um exemplo.

Algumas notas adicionais

• ao usar cores transparentes através da função rgba($color, 0.5), o SCSS aceita cores HEX e RGB no primeiro parâmetro, enquanto as propriedades customizadas CSS só aceitam uma cor RGB. É por isso que introduzimos o helper hexToRGB() e algumas propriedades com o sufixo --rgb nas definições de cores. Um exemplo:

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

// outra folha de estilo
.element {
  background-color: rgba(var(--primary-rgb), 0.05);
}

• note que no trecho acima, a variável SCSS é interpolada quando passada para uma propriedade customizada. Isso é um requisito no SCSS, veja Sass: Property Declarations para mais detalhes.
• a declaração CSS var() pode ter um valor de fallback para um segundo valor se o primeiro não estiver disponível, como em, ao escrever var(--color1, red), o CSS fará fallback para a cor vermelha se a propriedade --color1 não for encontrada. Em plugins, usamos as variáveis de cor SCSS como fallbacks para garantir compatibilidade com versões anteriores do Discourse. Então, o exemplo anterior ficaria assim com um fallback:

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

---

Este documento é controlado por versão - sugira alterações no 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]

É possível o Discourse também adicionar uma classe CSS ao <body> para o esquema de cores ou ID do esquema de cores? Parece que seria muito mais fácil.

Estou tentando resolver um problema durante a conversão de um tema onde preciso de muitas regras CSS e variáveis diferentes, e isso está se tornando uma bagunça complexa no arquivo color_definitions.scss.

Se eu pudesse fazer algo como isto em um arquivo SCSS isolado no tema, levaria 5 minutos para fazer algo que está demorando muito para descobrir com color_definitions.scss:

body.dark-palette .some-thing {
  // alguns estilos
}

body.light-palette .some-thing {
  // alguns estilos
}

[pmusaraj (Penar Musaraj)]

Sim, você pode acabar com muitas linhas de código nos arquivos de definição de cores, especialmente para gradientes.

Ainda é o “lugar” mais apropriado para isso na minha opinião. Está longe do elemento onde é usado, sim, mas é um local único e conveniente que lida com cores/gradientes que mudam com base no modo claro/escuro.

Uma alternativa é usar algo como isto:

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

Nossos esquemas de cores vêm com uma propriedade --scheme-type que é light para esquemas claros e dark para esquemas escuros. Navegadores recentes suportam consultas de contêiner, então isso deve fazer o que você está tentando realizar aqui sem adicionar uma classe ao corpo da página.

[j127]

Minhas habilidades em CSS/SCSS não são ótimas. Talvez isso seja mais fácil para pessoas que estão imersas nessas linguagens.

Estava bagunçando o arquivo color_definitions.scss, então o movi para outro arquivo em scss/ para poder importá-lo. Não tenho certeza de como nomear tudo, então está assim.

Acho que seria mais fácil fazer com uma classe body (ou talvez mais alguns exemplos), mas, de qualquer forma, está funcionando por enquanto. Não sei como as consultas de contêiner funcionam, mas pesquisarei mais tarde.

[panic]

Note que consultas de estilo para propriedades personalizadas não funcionam no Firefox a partir de hoje (14/11/2025).