Ajoutez du contenu personnalisé qui n'apparaît que sur votre page d'accueil

[Discourse]

A very common situation you’ll find yourself in as a theme developer is the need to create content that only shows on the homepage of your community.

You might add some HTML to the “After Header” section of your theme, which will then appear on every page. You can jump through some hoops in CSS to hide this everywhere except the homepage… but instead let’s use a Discourse theme to create a component with content that is only visible on your homepage.

If you’re unfamiliar with Discourse themes check out Beginner's guide to using Discourse Themes and Structure of themes and theme components

In your Discourse theme you’ll need to setup the following directory structure:

javascripts/discourse/components/
javascripts/discourse/connectors/

From here we’re going to create an Ember component. You can find more about Ember components from their documentation: Ember.js Guides - Guides and Tutorials - Ember Guides

But for now this will be a simple component. The component will consist of two files, one containing the logic and another the template.

javascripts/discourse/components/custom-homepage-content.js

import Component from "@glimmer/component";
import { service } from "@ember/service";
import { defaultHomepage } from "discourse/lib/utilities";

export default class CustomHomepageContent extends Component {
  @service router;

  get isHomepage() {
    const { currentRouteName } = this.router;
    return currentRouteName === `discovery.${defaultHomepage()}`;
  }
}

This creates a isHomepage getter, which checks the router service for the currentRouteName — if the route name matches your homepage (as dictated by site settings) then it will return true

Now we need our template

javascripts/discourse/components/custom-homepage-content.hbs

{{#if this.isHomepage}}
  <h1>This is my homepage HTML content</h1>
{{/if}}

The template checks the isHomepage getter, and will display your content if it’s true. You can add any HTML you want between the {{#if}} blocks.

Now that our component is created, we need to add it to Discourse somewhere. For this step you’ll need to decide which plugin outlet to utilize. These are areas throughout Discourse where we’ve added a little code for developers to hook into. You can search Discourse for these on Github, or browse for them using the (deprecated) Plugin outlet locations theme component.

For custom homepages, above-main-container is a common choice, so let’s use that.

We need to create our connector file in the correct directory:

javascripts/discourse/connectors/above-main-container/custom-homepage-connector.hbs

<CustomHomepageContent />

and that’s all, it just needs a single line calling for your component

---

This document is version controlled - suggest changes on github.

[Cornelius (Cornelius Ashley)]

Salut @awesomerobot,

Merci pour l’explication. J’ai essayé les étapes que vous avez suggérées, mais le after_header que j’ai implémenté s’affiche toujours sur les pages de détails des articles. Pouvez-vous me recommander comment je peux corriger cela pour qu’il ne s’affiche que sur ma page d’accueil ?

[carson]

Salut @Cornelius, puis-je voir ton code ?

[pfaffman (Jay Pfaffman)]

Il serait formidable de réécrire cela pour une utilisation moderne du système de fichiers plutôt que de tout coller dans les balises d’en-tête.

La plupart de ces anciens guides pour les thèmes sont obsolètes par rapport à la façon dont les choses sont faites maintenant.

[awesomerobot (Kris)]

Oui, c’était assez obsolète ! Je l’ai mis à jour pour refléter la structure des thèmes distants et nos composants Ember modernes.

[pfaffman (Jay Pfaffman)]

@awesomerobot

Je l’ai mis à jour pour refléter la structure des thèmes distants et de nos composants Ember modernes.

C’est génial !

@awesomerobot

Cela crée un getter isHomepage, qui vérifie le service de routage pour le currentRouteName — si le nom de la route correspond à votre page d’accueil (tel que dicté par les paramètres du site), alors il renverra true.

Et ce getter est la même chose que ceci http://ember-cli-page-object.js.org/docs/v1.11.x/api/getter.html ? Je n’en sais juste assez pour être dangereux. Si c’est la même chose, alors je modifierai l’OP pour y faire référence.

[Prayas_Arora]

@awesomerobot Salut Kris, j’ai installé Discourse localement sur mon système. Quel est le bon chemin pour ajouter ces fichiers dans mon instance locale de Discourse. Je voulais ajouter un nouveau composant de thème dans mon instance locale de Discourse.

[pfaffman (Jay Pfaffman)]

Vous créeriez votre composant de thème et l’installeriez via l’expérience utilisateur.

Installer un thème ou un composant de thème

Installer l’application de console Discourse Theme CLI pour vous aider à créer des thèmes

[carson]

Si je construis ma page d’accueil par-dessus la vue de catégorie, j’obtiens toujours mon contenu personnalisé même si je vais sur /categories qui n’est pas l’URL d’accueil. Je veux limiter cela à l’URL racine / uniquement, ce qui, je crois, était ce que faisait le code précédent, mais je me demande si defaultHomepage() devrait faire cela.

[manuel (Manuel Kostka)]

discovery.${defaultHomepage()} correspondra à la route définie comme page d’accueil par le paramètre top-menu. Elle correspondra à la fois à l’URL racine / ET à la route spécifique, comme /categories.

D’après mon expérience, il y a deux complications lors de la création d’une page d’accueil personnalisée basée sur defaultHomepage() :

• la route sur laquelle elle est construite n’est plus disponible en tant que simple vue de liste
• les membres peuvent définir leur propre page d’accueil par défaut dans les paramètres de leur interface. Il faut donc soit désactiver cette fonctionnalité, soit avoir un concept de page d’accueil qui fonctionne sur n’importe quelle route du menu supérieur.

Pour construire une page d’accueil personnalisée uniquement sur l’URL racine, on peut vérifier router.currentURL === '/'. Par défaut, cela ne correspond qu’à l’URL racine / et non à la route d’atterrissage définie par le paramètre top-menu. Cependant, il existe maintenant une logique sur les liens de la barre latérale qui vise en plus à faire correspondre une URL donnée à une route. Donc, cela ne fonctionnera pas par défaut sur les liens de la barre latérale. J’ai juste posté un sujet à ce sujet : Can I have sidebar links that don’t resolve an url to a route?

D’après ce que je comprends, il n’existe actuellement aucun moyen par défaut de construire une page d’accueil personnalisée sur l’URL racine sans cibler également une route du menu supérieur ou rencontrer des problèmes avec la barre latérale. Ce serait formidable d’avoir cette option.

[awesomerobot (Kris)]

@manuel

discovery.${defaultHomepage()} correspondra à la route définie comme page d’accueil par le paramètre top-menu. Elle correspondra à la fois à l’URL racine / ET à la route spécifique, comme /categories.

C’est exact, c’est une sorte de solution de contournement de longue date qui permet à / et à la route correspondante /route d’afficher un contenu différent. Nous avons une tâche à accomplir :

1. Permettre de définir la page d’accueil indépendamment du paramètre top_menu.
2. Ajouter un nouveau modèle de page d’accueil autonome qui peut être personnalisé sans empiéter sur une route existante.

Les pages d’accueil personnalisées sont une demande très fréquente à ce stade, nous pourrions donc certainement utiliser plus de flexibilité à cet égard.