Compiladores de Componente

Os Compiladores de Componente Customizado seguem o mesmo modelo que os compiladores de página e podem ser criados para disposições de secção, componentes customizados e disposições de conteúdo.

Durante a compilação, o comando cec compile-template procurará um ficheiro compile.js na mesma localização que o ficheiro render.js para o componente:

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

Se este ficheiro não existir, o componente não é compilado e será apresentado em runtime.

Se o ficheiro não existir, precisa de implementar uma interface compile(), que devolve um objeto Promise. Por exemplo, o seguinte Starter-Blog-Author-Summary é um compilador de disposição de conteúdo customizado:

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;