Guide de référence rapide pour développeur de thèmes

Alors que les thèmes deviennent plus puissants, il y a plus de choses à retenir sur leur fonctionnement. Nous avons beaucoup de documentation détaillée sous #howto / #themes, mais si vous avez juste besoin de quelque chose pour vous rafraîchir la mémoire, ce guide peut vous aider.

Ressources Générales

:scroll: Guide du débutant
:scroll: Guide du concepteur
:scroll: Guide du développeur
:paintbrush: Theme Creator
:desktop_computer: Theme CLI
:notebook_with_decorative_cover: Répertoire des thèmes
:jigsaw: Répertoire des composants
:wrench: Theme Modifiers
:wrench: Paramètres du site modifiables par le thème

Structure des Fichiers/Dossiers lire la suite

about.json
settings.yml
common/, desktop/, mobile/
  {common|desktop|mobile}.scss
  head_tag.html
  header.html
  after_header.html
  body_tag.html
  footer.html
  embedded.scss (common seulement)
locales/
  en.yml
  ...
assets/
  (fichiers nommés arbitrairement, référencés dans about.json)
stylesheets/
  (fichiers nommés arbitrairement, peuvent être importés les uns des autres, et common/desktop/mobile.scss)
javascripts/
  (fichiers nommés arbitrairement. Supporte .js .hbs et .raw.hbs)

about.json informations sur la structure, métadonnées disponibles

{
  "name": "Mon Thème",
  "component": false,
  "license_url": null,
  "about_url": null,
  "authors": null,
  "theme_version": null,
  "minimum_discourse_version": null,
  "maximum_discourse_version": null,
  "assets": {
    "variable-name": "assets/my-asset.jpg"
  },
  "color_schemes": {
    "Mon Schéma de Couleurs": {
      "primary": "222222"
    }
  }
}

SCSS

:link: Variables CSS disponibles

Javascript lire la suite

// {theme}/javascripts/api-initializers/init-theme.gjs
import { apiInitializer } from "discourse/lib/api";

export default apiInitializer((api) => {
  // Votre code ici
});

:link: JS Plugin API

:link: Javascript multi-fichiers

Paramètres lire la suite

settings.yml:

fruit:
  default: apples|oranges
  type: list
  description: # Ancienne méthode. Il est préférable de les définir dans les fichiers de localisation (voir ci-dessous)
    en: English Description
    fr: Description Française

Accès depuis JavaScript :

console.log(settings.fruit);

Accès depuis les modèles gjs :

<template>{{settings.fruit}}</template>

Accès depuis scss :

html {
  font-size: #{$global-font-size}px;
  background: $site-background;
}

Paramètres du site modifiables par le thème lire la suite

about.json:

"theme_site_settings": {
  "enable_welcome_banner": false
}

Accès depuis JavaScript :

@service siteSettings;

this.siteSettings.enable_welcome_banner;

Accès depuis les modèles gjs :

<template>{{this.siteSettings.enable_welcome_banner}}</template>

Traductions lire la suite

locales/en.yml

en:
  my_translation_key: "I love themes"
  theme_metadata: # Celles-ci sont utilisées dans le panneau d'administration. Elles ne sont pas mises à disposition de vos fichiers js/hbs
    description: Ce thème vous permet de faire des choses incroyables sur votre Discourse
    settings:
      fruit: Une description du paramètre whitelisted_fruits

Accès depuis JavaScript :

import { i18n } from "discourse-i18n";
i18n(themePrefix("my_translation_key"));

Accès depuis les modèles gjs :

import { i18n } from "discourse-i18n";

<template>
  {{i18n (themePrefix "my_translation_key")}}
  <DButton @label={{theme-prefix "my_translation_key"}} />
</template>

Ce document est contrôlé par version - suggérez des modifications sur github.

40 « J'aime »

This is super useful.

Could I also suggest that a useful reference to add is the list of available color transformations:

3 « J'aime »

I must be missing something here, I’m trying to use I18n.t(themePrefix("my_translation_key")) but the Firefox console reports that themePrefix is undefined.
How can I invoke that function from an api function?

Le lien ne semble plus être valide.

2 « J'aime »

Vous avez raison. Ce devrait être maintenant :

https://github.com/discourse/discourse/blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.js

2 « J'aime »

Merci @th21 et @Arkshine - j’ai mis à jour le lien

2 « J'aime »

Le lien de l’API des plugins a encore changé :

https://github.com/discourse/discourse/blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.gjs

2 « J'aime »

Merci ! Mis à jour :writing_hand:

3 « J'aime »