Hydrering avser processen för att lägga till JavaScript-beteendet igen i kompilerad HTML på sidan när HTML återges i webbläsaren.
Om du till exempel har två komponenter på sidan som du vill återge som huvud/detalj så behöver detaljkomponenten uppdateras när någon klickar på ett objekt i huvudkomponenten. Allt det här hanteras av JavaScript som exekveras på sidan. För att det här ska fungera måste du hydrera HTML:en för de två komponenterna efter att de har återgetts på sidan, genom att lägga till en on click
-händelsehanterare i elementen i huvudkomponenten och en avlyssnare i detaljkomponentcontainern för förnyad återgivning när on click
-händelsen inträffar baserat på den nyttolast som överförs i händelsen.
Komponentkompilerare infogar HTML på sidan. Om komponenten kräver att ytterligare JavaScript körs vid exekvering för att lägga till t.ex. händelsehanterare, har du ett par alternativ att välja mellan: infogat JavaScript eller hydreringsfunktionen. Vilken lösning du väljer beror på dina krav.
Du kan infoga en <script>-tagg direkt i den returnerade kompilerade uppmärkningen. Skriptet exekveras när sidan exekveras.
Exempel:
<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>
Istället för att infoga JavaScript kan du inkludera en hydreringsfunktion i filen render.js
och notera att komponenten kräver hydrering vid exekvering när du returnerar den kompilerade uppmärkningen. Denna hydrering undviker upprepade <script>
-taggar och låter dig dra nytta av befintlig JavaScript-kod för att hantera händelser.
Även om filen render.js
laddas, anropas inte funktionen render()
under hydrering. Endast funktionen hydrate()
anropas.
Obs!:
Om en kompilerad komponent inte anger att den behöver hydreras så laddas aldrig komponentensrender.js
-fil.Till exempel skulle den anpassade kompileraren för innehållslayout returnera 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 });
Dessutom kan den anpassade kompileraren vid behov lägga till hydrate-egenskaper som den söker efter vid exekvering. Exempel:
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}}">
Slutligen gäller att om en komponent noterar att den kräver hydrering så laddas komponentens render.js
-fil och anropas funktionen hydrate()
vid exekvering, så att containern <div>
som innehåller den kompilerade uppmärkningen överförs.
Till exempel render.js
– se funktionen 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); } }