Aggiungi contenuti personalizzati che appaiono solo sulla tua homepage

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:

:file_folder: javascripts/discourse/components/
:file_folder: 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.

:page_facing_up: 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

:page_facing_up: 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:

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

<CustomHomepageContent />

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


This document is version controlled - suggest changes on github.

47 Mi Piace

Ciao @awesomerobot,

Grazie per la spiegazione. Ho provato i passaggi che hai suggerito ma l’ after_header che ho implementato viene ancora visualizzato nelle pagine di dettaglio dei post. Puoi consigliarmi come posso risolvere questo problema per mostrarlo solo sulla mia home page?

1 Mi Piace

Ciao @Cornelius, posso vedere il tuo codice?

2 Mi Piace

Sarebbe fantastico riscrivere questo per l’uso moderno del filesystem anziché inserire tutto nei tag di intestazione.

La maggior parte di queste vecchie guide per i temi è obsoleta rispetto a come vengono fatte le cose ora.

7 Mi Piace

Sì, questo era piuttosto obsoleto! L’ho aggiornato per riflettere la struttura dei temi remoti e i nostri moderni componenti Ember.

6 Mi Piace

Fantastico!

E quel getter è la stessa cosa di questo http://ember-cli-page-object.js.org/docs/v1.11.x/api/getter.html? So abbastanza da essere pericoloso. Se è la stessa cosa, modificherò l’OP per collegarlo.

3 Mi Piace

@awesomerobot Ciao Kris, ho installato Discourse localmente sul mio sistema. Qual è il percorso corretto per aggiungere questi file nella mia istanza locale di Discourse? Volevo aggiungere un nuovo componente tematico nella mia istanza locale di Discourse.

1 Mi Piace

Creeresti il tuo componente tema e lo installeresti tramite l’ux.

Installa un tema o un componente tema

Installa l’app console Discourse Theme CLI per aiutarti a creare temi

4 Mi Piace

Se costruisco la mia homepage sopra la vista della categoria, ottengo comunque i miei contenuti personalizzati anche se vado su /categories che non è l’URL principale. Voglio limitare questo solo all’URL principale / che credo sia ciò che faceva il codice precedente, ma mi chiedo se defaultHomepage() dovrebbe farlo.

3 Mi Piace

discovery.${defaultHomepage()} corrisponderà al percorso impostato come percorso di destinazione dall’impostazione top-menu. Corrisponderà sia all’URL principale / SIA al percorso specifico, come /categories.

Nella mia esperienza ci sono due complicazioni quando si costruisce una homepage personalizzata basata su defaultHomepage():

  • il percorso su cui si basa non è più disponibile come semplice visualizzazione elenco
  • i membri possono impostare la propria homepage predefinita nelle impostazioni della loro interfaccia. Quindi, o si disabilita quella funzionalità o si dispone di un concetto di homepage che funzioni su uno qualsiasi dei percorsi del menu principale

Per costruire una homepage personalizzata solo sull’URL principale è possibile verificare router.currentURL === '/'. Per impostazione predefinita, questo corrisponde solo all’URL principale / e non al percorso di destinazione impostato dall’impostazione del menu principale. Tuttavia, ora esiste una logica sui collegamenti della barra laterale che mira inoltre a far corrispondere un dato URL a un percorso. Quindi, per impostazione predefinita, non funzionerà sui collegamenti della barra laterale. Ho appena pubblicato un argomento su questo: Can I have sidebar links that don’t resolve an url to a route?

Per quanto ne so, attualmente non esiste un modo predefinito per costruire una homepage personalizzata sull’URL principale senza prendere di mira un percorso dal menu principale o incorrere in problemi con la barra laterale. Sarebbe fantastico avere questa opzione.

4 Mi Piace

Giusto, è una specie di “hack” di lunga data che / e il corrispondente /route possano visualizzare contenuti diversi. Abbiamo un’attività da fare:

  1. Consentire l’impostazione della home page indipendentemente dall’impostazione top_menu
  2. Aggiungere un nuovo modello di home page autonomo che possa essere personalizzato senza sovrascrivere un percorso esistente

Le home page personalizzate sono una richiesta molto comune a questo punto, quindi potremmo certamente utilizzare maggiore flessibilità qui.

6 Mi Piace