Komponenthydrering

Hydrering vil sige at føje JavaScript-funktionsmåden til den kompilerede HTML-kode på siden igen, når HTML-koden gengives i browseren.

Hvis du for eksempel har to komponenter på siden, som du vil gengive som master/detalje, skal detaljekomponenten opdateres, når der klikkes på et element i masteren. Dette håndteres alt sammen af den JavaScript-kode, der udføres på siden. For at få dette til at fungere skal du hydrere HTML-koden for de to komponenter, efter at de er gengivet på siden, ved at føje en on click-begivenheds-handler til elementerne i masterkomponenten og en listener til den detaljekomponentcontainer, der skal gengives, når on click-begivenheden opstår, på basis af det payload, der videregives i begivenheden.

Komponent-compilere indsætter HTML-kode på siden. Hvis komponenten kræver, at der udføres yderligere JavaScript-kode under runtime for at tilføje ting som begivenheds-handlere, kan du vælge enten integreret JavaScript-kode eller funktionen Hydrer. Den løsning, du vælger, afhænger af dine krav.

Inline-JavaScript

Du kan indsætte et <script>-tag direkte i den returnerede kompilerede markup. Scriptet udføres, når siden udføres.

Eksempel:

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

Funktionen Hydrate

I stedet for at integrere JavaScript-koden kan du inkludere en hydrate-funktion i render.js-fil og bemærke, at komponenten kræver hydrering under runtime, når du returnerer den kompilerede markup. Denne hydrering forhindrer gentagne <script>-tags og lader dig bruge eksisterende JavaScript-kode til håndtering af begivenheder.

Selv om render.js-filen indlæses, kaldes render()-funktionen ikke under hydrering. Kun hydrate()-funktionen kaldes.

Bemærk:

Hvis en kompileret komponent ikke fortæller, at den har brug for hydrering, bliver komponentens render.js-fil aldrig indlæst.

Den tilpassede indholdslayoutcompiler ville for eksempel blive returneret med - { 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
});

Hvis det er påkrævet, kan den tilpassede compiler tilføje hydrate-egenskaber, som den vil søge efter under runtime. Eksempel:

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}}">

Hvis en komponent fortæller, at den har brug for hydrering, indlæses dens render.js-fil under runtime, og hydrate()-funktionen kaldes, hvor containeren <div>, der indeholder den kompilerede markup, videregives.

For eksempel render.js - se hydrate()-funktion:

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