Restauro de Componentes

O restauro refere-se ao processo de adição do comportamento JavaScript de volta ao HTML compilado na página quando o HTML for apresentado no browser.

Por exemplo, se tiver dois componentes na página que pretenda apresentar como principal/detalhe, clicar num item no principal implica atualizar o componente de detalhe. Tudo isto é processado pelo JavaScript que é executado na página. Para efetuar este trabalho, precisa de restaurar o HTML com os dois componentes depois de serem apresentados na página acrescentando uma rotina de tratamento de eventos on click aos elementos no componente principal e um listener no contentor de componentes de detalhes para voltar a apresentar quando o evento on click ocorrer com base no payload transmitido no evento.

Os compiladores de componente inserem HTML na página. Se o seu componente precisar de outro JavaScript para execução em runtime para acrescentar, por exemplo, rotinas de tratamento de eventos, terá duas opções, JavaScript inline ou a função de Restauro. As soluções que escolher dependerão dos seus requisitos.

JavaScript Inline

Pode inserir um identificador <script> diretamente no markup compilado devolvido. O script será executado à medida que a página é executada.

Por exemplo:

<script src="/_sitesclouddelivery/renderer/libs/scs-core/jssor-
slider/js/jssor.slider.min.js" type="text/javascript"></script>
<div id="slider_container_c46b122d-978a-429d-aa25-9b5698428f6f" 
style="position: relative; top: 0px; left: 0px; height: 400px; width: 600px;
background-color: rgb(68, 68, 68); visibility: visible;" data-jssor-
slider="1">
. . .
</div>
<script>
        (function () {
            // get the required options
            var options = 
{"$FillMode":2,"$AutoPlay":false,"$AutoPlayInterval":3000,"$SlideDuration":50
0,"$ArrowKeyNavigation":true,"$HWA":false,"$BulletNavigatorOptions":{"$Chance
ToShow":1,"$AutoCenter":1,"$SpacingX":5},"$ArrowNavigatorOptions":{"$ChanceTo
Show":1,"$AutoCenter":2,"$Steps":1},"$ThumbnailNavigatorOptions":{"$ChanceToS
how":0,"$DisplayPieces":7,"$SpacingX":8,"$ParkingPosition":240}};

            // select the JSSOR value options
            options.$BulletNavigatorOptions.$Class = $JssorBulletNavigator$;
            options.$ArrowNavigatorOptions.$Class = $JssorArrowNavigator$;
            options.$ThumbnailNavigatorOptions.$Class = 
$JssorThumbnailNavigator$;

            // create the slider
            var slider = new $JssorSlider$("slider_container_c46b122d-978a-
429d-aa25-9b5698428f6f", options);
  
            // resize, maintaining aspect ratio
            var container = slider.$Elmt.parentElement;
            if (container) {
                 slider.$ScaleWidth(container.getBoundingClientRect().width);
            }
        })();
    </script>

Função de Restauro

Em vez de colocar JavaScript inline, pode incluir uma função de restauro no seu ficheiro render.js e notará que o componente precisa de restauro em runtime quando regressar à markup compilada. Este restauro impede identificadores <script> repetitivos e permite-lhe aproveitar o código JavaScript existente para gerir eventos.

Mesmo que o ficheiro render.js seja carregado, a função render() não é chamada durante o restauro. Só é chamada a função hydrate().

Nota:

Se um componente compilado não indicar que precisa de restauro, o ficheiro render.js do componente nunca é carregado.

Por exemplo, o compilador de disposição de conteúdo customizado será devolvido com - { hydrate: true }.

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
});

Além disso, se for necessário, o compilador customizado pode acrescentar propriedades de restauro que serão procuradas em runtime. Por exemplo:

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

Template: 
<div class="author-container" data-hydrate="{{hydrateData}}">

Por fim, se um componente notar que precisa de restauro, o ficheiro render.js do componente será carregado em runtime e a hydrate() função chamada, transmitindo ao contentor <div> que contém a markup compilada.

Por exemplo, render.js - consulte a função hydrate():

function selectAuthor(parentObj, contentId, authorName) {
    var $parentObj = $(parentObj);
    $parentObj.find(".author-name").click($.proxy(function () {
        $(".author-name").removeClass('author-selected');
        $(event.target).addClass('author-selected');
    }, self));
    if (window.location.href.indexOf("default=" + contentId) >= 0) {
        $(".author-name").each(function () {
            if (this.innerText === authorName) {
                $(this).addClass('author-selected');
            }
        });
    }
}
. . .
 
 
    hydrate: function (parentObj) {
        var $parentObj = $(parentObj),
            hydrateData = $parentObj.find('.author-container').attr('data-
hydrate');
        if (hydrateData) {
            var data = JSON.parse(hydrateData);
            selectAuthor(parentObj, data.contentId, data.authorName);
        }
    },
    render: function (parentObj) {
    . . .
        try {
            // Mustache
            template = Mustache.render(templateHtml, content);
 
            if (template) {
                $(parentObj).append(template);
            }
            selectAuthor(parentObj, this.contentItemData.id, 
content.fields['starter-blog-author_name']);
        } catch (e) {
            console.error(e.stack);
        }
    }