Skip to main content

Frontend e Resolver

Come spiegato nella documentazione percorsi e contenuti, possiamo usare il sistema di routing di Mithril per mostrare diversi componenti per differenti percorsi. Mithril ti consente di utilizzare qualsiasi componente che ti piace, anche un Modal o Alert, ma ti consigliamo di attenersi alle classi di componenti che ereditano il componente Page.

I componenti Page

Forniamo flarum/components/Page come classe base per le pagine sia in admin che nel frontend di forum. Questi i vantaggi:

  • Aggiornamenti automatici di app.current e app.previous PageState quando si passa da un percorso ad un altro.
  • Chiude automaticamente il modal quando si passa da un percorso a un altro.
  • Si applica this.bodyClass (se definito) all'elemento HTML "#app" quando la pagina viene visualizzata.
  • È anche utile per motivi di coerenza utilizzare una classe base comune per tutte le pagine.
  • Se l'attributo delle pagine scrollTopOnCreate è impostato su false in oninit, la pagina non verrà spostata verso l'alto quando viene modificata.
  • Se useBrowserScrollRestoration è impostato su false in oninit, il ripristino dello scorrimento automatico del browser non verrà utilizzato su quella pagina.

I componenti della pagina funzionano esattamente come qualsiasi altro componente ereditato. Per esempio (molto semplice):

import Page from 'flarum/components/Page';


export default class CustomPage extends Page {
view() {
return <p>Hello!</p>
}
}

Usare i Route Resolvers

Flarum utilizza un'impostazione per determinare quale pagina dovrebbe essere la homepage: questo dà flessibilità agli amministratori per personalizzare le loro community. Per aggiungere una pagina personalizzata alla homepage in Admin, è necessario estendere il metodo BasicsPage.homePageItems con il percorso della tua nuova pagina.

I dati possono essere impostati e recuperati dallo stato della pagina utilizzando:

import IndexPage from 'flarum/components/DiscussionPage';
import DiscussionPage from 'flarum/components/DiscussionPage';

// To just check page type
app.current.matches(DiscussionPage);

// To check page type and some data
app.current.matches(IndexPage, {routeName: 'following'});

Ad esempio, questo è il modo in cui la pagina di discussione fa la sua istanza di PostStreamState disponibile a livello globale.

Resolvers personalizzati

Spesso, la prima cosa che si modifica è il testo personalizzato che appare nel titolo della scheda del browser. Per esempio, una pagina di tag potrebbe voler mostrare "Tag - NOME FORUM", o una pagina di discussione potrebbe voler mostrare il titolo della discussione.

Per fare ciò, dovrai aggiungere alla tua pagina la call app.setTitle() e app.setTitleCount() nel metodo oncreate del lifecycle hook (o quando i dati sono stati caricati, se richiesti tramite API).

Per esempio:

import Page from 'flarum/common/components/Page';


export default class CustomPage extends Page {
oncreate(vnode) {
super.oncreate(vnode);

app.setTitle("Cool Page");
app.setTitleCount(0);
}

view() {
// ...
}
}

export default class CustomPageLoadsData extends Page {
oninit(vnode) {
super.oninit(vnode);

app.store.find("users", 1).then(user => {
app.setTitle(user.displayName());
app.setTitleCount(0);
})
}

view() {
// ...
}
}

Si prega di notare che se la pagina è impostata come homepage, app.setTitle() cancellerà il titolo per semplicità. Dovrebbe comunque essere impostato, per evitare che i titoli delle pagine precedenti vengano applicati.

PageState

A volte, vogliamo ottenere informazioni sulla pagina in cui ci troviamo attualmente o sulla pagina da cui proveniamo. Per consentire ciò, Flarum crea (e memorizza) istanze di PageState come app.current e app.previous. Cioè:

  • La classe del componente utilizzata per la pagina
  • Una raccolta di dati che ogni pagina imposta su se stessa. Il nome della rotta corrente è sempre incluso.

I dati possono essere impostati e recuperati da Page State utilizzando:

app.current.set(KEY, DATA);
app.current.get(KEY);

Ad esempio, ecco come la Pagina di Discussione rende PostStreamState disponibile globalmente.

Puoi anche controllare il tipo e i dati di una pagina usando PostStreamState ed il metodo matches. Ad esempio, se vogliamo sapere se siamo attualmente su una pagina di discussione:

// Vedi sopra per un esempio di pagina personalizzata
import CustomPage from './components/CustomPage';
// Vedi sotto per un esempio di resolver personalizzato
import CustomPageResolver from './resolvers/CustomPageResolver';

// Utilizza un'istanza del resolver di percorsi
app.routes['resolverInstance'] = {path: '/custom/path/1', resolver: {
onmatch: function(args) {
if (!app.session.user) return m.route.SKIP;

return CustomPage;
}
}};

// Usa una classe di resolver di percorsi personalizzata
app.routes['resolverClass'] = {path: '/custom/path/2', resolverClass: CustomPageResolver, component: CustomPage};

// Usa la classe di default (`flarum/resolvers/DefaultResolver`)
app.routes['resolverClass'] = {path: '/custom/path/2', component: CustomPage};

Route resolver (avanzato)

Vedi la documentazione Pannello di amministrazione per ulteriori informazioni sugli strumenti disponibili per le pagine di amministrazione (e su come sovrascrivere la pagina di amministrazione per la tua estensione).

Route Resolvers (Avanzato)

Casi d'uso avanzati possono ottenere vantaggi dal sistema di risoluzione dei percorsi di Mithril. Flarum in realtà avvolge già tutti i suoi componenti nel resolver flarum/resolvers/DefaultResolver. Ciò ha i seguenti vantaggi:

  • Passa un attributo routeName alla pagina corrente, che poi lo fornisce aPageState
  • Assegna una chiave al componente della pagina di primo livello. Quando il percorso cambia, se la chiave del componente di primo livello è cambiata, verrà riprodotto completamente (per impostazione predefinita, Mithril non esegue il rendering dei componenti quando si passa da una pagina all'altra se entrambi sono gestiti dallo stesso componente).

Usare i Route Resolvers

Ci sono in realtà 3 modi per impostare il componente/route resolver durante la registrazione di un nuovo percorso:

  • la chiave resolver può essere usata per fornire un istanza di un risolutore di percorsi. Questa istanza dovrebbe definire quale componente deve essere utilizzato e codificare il nome del percorso da passare al suo interno. Questa istanza verrà utilizzata senza alcuna modifica da Flarum.
  • Le chiavi resolverClass e component possono essere usate per fornire una classe che sarà utilizzata per istanziare un risolutore di percorsi, da usare al posto di quella predefinita di Flarum, così come il componente da usare. Il suo costrutto dovrebbe avere 2 argomenti: (component, routeName).
  • La chiave component può essere usata da sola per un componente. Ciò comporterà un comportamento predefinito.

Per esempio:

//Guarda in alto per le pagine personalizzate
import CustomPage from './components/CustomPage';
// Guarda in basso per i resolver personalizzati di esempio
import CustomPageResolver from './resolvers/CustomPageResolver';

// Usa un route resolver
app.routes['resolverInstance'] = {path: '/custom/path/1', resolver: {
onmatch: function(args) {
if (!app.session.user) return m.route.SKIP;

return CustomPage;
}
}};

// Utilizza un resolver personalizzato
app.routes['resolverClass'] = {path: '/custom/path/2', resolverClass: CustomPageResolver, component: CustomPage};

// Usa la classe di default (`flarum/common/resolvers/DefaultResolver`)
app.routes['resolverClass'] = {path: '/custom/path/2', component: CustomPage};

Resolver Personalizzati

Consigliamo vivamente di estendere i risolutori di percorsi personalizzati flarum/resolvers/DefaultResolver. Per esempio, Flarum flarum/resolvers/DiscussionPageResolver assegna la stessa chiave a tutti i collegamenti alla stessa discussione (indipendentemente dal post corrente) e attiva lo scorrimento quando si utilizza m.route.set per passare da un post all'altro nella stessa pagina di discussione:

import DefaultResolver from '../../common/resolvers/DefaultResolver';

/**
* Non viene esportato in quanto si tratta di una misura temporanea.
* Un sistema più robusto verrà implementato insieme al supporto UTF-8 nella beta 15.
*/
function getDiscussionIdFromSlug(slug: string | undefined) {
if (!slug) return;
return slug.split('-')[0];
}

/**
* Un risolutore di percorsi personalizzato per DiscussionPage che genera la stessa chiave per tutti i post
* nella stessa discussione. Attiva uno scorrimento quando si passa da un post all'altro
* nella stessa discussione.
*/
export default class DiscussionPageResolver extends DefaultResolver {
static scrollToPostNumber: number | null = null;

makeKey() {
const params = { ...m.route.param() };
if ('near' in params) {
delete params.near;
}
params.id = getDiscussionIdFromSlug(params.id);
return this.routeName.replace('.near', '') + JSON.stringify(params);
}

onmatch(args, requestedPath, route) {
if (route.includes('/d/:id') && getDiscussionIdFromSlug(args.id) === getDiscussionIdFromSlug(m.route.param('id'))) {
DiscussionPageResolver.scrollToPostNumber = parseInt(args.near);
}

return super.onmatch(args, requestedPath, route);
}

render(vnode) {
if (DiscussionPageResolver.scrollToPostNumber !== null) {
const number = DiscussionPageResolver.scrollToPostNumber;
// Scroll after a timeout to avoid clashes with the render.
setTimeout(() => app.current.get('stream').goToNumber(number));
DiscussionPageResolver.scrollToPostNumber = null;
}

return super.render(vnode);
}
}