Komponenten-Compiler

Benutzerdefinierte Komponenten-Compiler folgen demselben Modell wie Seiten-Compiler und können für Abschnittslayouts, benutzerdefinierte Komponenten und Inhaltslayouts erstellt werden.

Bei der Kompilierung sucht der Befehl cec compile-template nach der Datei compile.js in demselben Speicherort, in dem auch die Datei render.js für die Komponente gespeichert ist:

src
- components
  - <yourComponent>
    - assets
      - render.js
      - compile.js

Wenn diese Datei nicht vorhanden ist, ist die Komponente nicht kompiliert und wird zur Laufzeit gerendert.

Wenn die Datei vorhanden ist, muss sie eine compile()-Schnittstelle implementieren, die einen Promise zurückgibt. Beispiel: Starter-Blog-Author-Summary ist ein benutzerdefinierter Inhaltslayout-Compiler:

var fs = require('fs'),
path = require('path'),
mustache = require('mustache');

var ContentLayout = function (params) {
    this.contentClient = params.contentClient;
    this.contentItemData = params.contentItemData || {};
    this.scsData = params.scsData;
};

ContentLayout.prototype = {
    contentVersion: '>=1.0.0 <2.0.0',

    compile: function () {
        var compiledContent = '',
            content = JSON.parse(JSON.stringify(this.contentItemData)),
            contentClient = this.contentClient;

         // Store the id
         content.fields.author_id = content.id;

         if (this.scsData) {
             content.scsData = this.scsData;
             contentType = content.scsData.showPublishedContent === true ? 
'published' : 'draft';            
             secureContent = content.scsData.secureContent;
        } 

        // calculate the hydrate data
        content.hydrateData = JSON.stringify({
            contentId: content.id,
            authorName: content.fields['starter-blog-author_name']
        });

        try {
            // add in style - possible to add to <head> but inline for 
simplicity
            var templateStyle = fs.readFileSync(path.join(__dirname,
'design.css'), 'utf8');
            content.style = '<style>' + templateStyle + '</style>';
 
            var templateHtml = fs.readFileSync(path.join(__dirname,
'layout.html'), 'utf8');
            compiledContent = mustache.render(templateHtml, content);
        } catch (e) {
            console.error(e.stack);
        }

        return Promise.resolve({
            content: compiledContent,
            hydrate: true // note that we want to hydrate this component using the render.js hydrate() function. This is required for when the user clicks on the author
        });
    }
};

module.exports = ContentLayout;