JS Link: was man sonst noch wissen sollte

Teil1: JSLink: you’ve got the whole SharePoint in your hands
Teil2: JSLink: was man sonst noch wis­sen sollte (die­ser Artikel)
Teil3: JSLink – Problemfall Minimal Download Strategy (MDS)

Das grund­le­gende Prinzip und die genaue Verwendung von JS Link habe ich euch in mei­nem letz­ten Artikel  "JS Link: you’ve got the whole SharePoint in your hands" bereits erläu­tert. Ein paar Details soll­ten jedoch noch ein­mal ange­spro­chen wer­den, die Euch den Umgang mit JS Link noch etwas erleich­tern könnten.

Mehrere JavaScript Dateien gleich­zei­tig verwenden

Der erste inter­es­sante Fakt ist, dass meh­rere JavaScript Dateien ver­wen­det wer­den kön­nen. Der ein oder andere fragt sich dabei viel­leicht, was das für einen Sinn macht. Das habe ich am Anfang auch getan, bis sich der erste Anwendungsfall von selbst ergab. Folgende bei­den Anwendungsfälle sind mei­nes Erachtens sinnvoll.

1. Beim Einsatz kom­ple­xe­rer Funktionen, die even­tu­ell in meh­re­ren Klassen über meh­rere Dateien ver­teilt werden.
2. Unter Umständen kön­nen Standard SharePoint Funktionen nach dem Einsatz von JS Link nicht mehr funk­tio­nie­ren. Zum Beispiel die Einfärbung der über­fäl­li­gen Aufgaben inner­halb einer Aufgabenliste. (Siehe Punkt 2)

Um zwei oder mehr Skripte gleich­zei­tig ein­zu­set­zen, muss der Separator "|" ver­wen­det werden.

"~site/_catalogs/masterpage/script1.js|~site/_catalogs/masterpage/script2.js"

Standard SharePoint Funktionen zer­stört durch JS Link

Wie unter Punkt 1 bereits erwähnt, ist es mög­lich Standard Funktionen von SharePoint, durch den Einsatz von JS Link, zu zer­stö­ren. Aufgefallen ist mir die­ses Verhalten beim Anpassen der SharePoint Aufgabenliste. Nach Hinzufügen des JS Link Skriptes wur­den über­fäl­lige Aufgaben nicht mehr rot mar­kiert. Eine mög­li­che Lösung für die­ses Problem, ist das zusätz­li­che Laden der Datei "hierarchytaskslist.js". Hierbei kommt der Separator "|" zum Einsatz. Nach Einbinden bei­der Skripte wer­den die Aufgaben wie­der rot eingefärbt.

Mehr Informationen fin­det Ihr hier: Link

"~sitecollection/_layouts/15/hierarchytaskslist.js|~site/_catalogs/masterpage/script1.js"

JavaScript onDemand mit­tels JS Link laden

In man­chen Situationen ist es von Nöten, Skripte erst bei Bedarf nach­zu­la­den. Paradebeispiel dafür, sind Timing Probleme beim Laden der Seite. SharePoint bie­tet hier­für einen nütz­li­chen Mechanismus um Skripte bei Bedarf dyna­misch nach­zu­la­den – Die Klasse SP.SOD (SharePoint Scripts on Demand).

SP.SOD wird von SharePoint selbst sehr häu­fig ver­wen­det, um Seiten schon auf­zu­bauen, bevor alle Skripte gela­den wurden.

Skripte, wel­che per RegisterSod nach­ge­la­den wer­den sol­len, müs­sen durch das Tag "(d)" gekenn­zeich­net werden.

"~site/_catalogs/masterpage/script1.js(d)|~site/_catalogs/masterpage/script2.js(d)"

JS Link ver­hält sich merk­wür­dig in Kombination mit MDS

Die Minimal Download Strategy (MDS) wurde mit SharePoint 2013 zusam­men ein­ge­führt und soll für schnel­le­ren Seitenaufbau, durch dyna­mi­sches Nachladen von Inhalten, sorgen.

JS Link und MDS sind nicht die bes­ten Freunde. Wie Ihr damit am bes­ten umgeht erfahrt Ihr in Teil 3 der Artikelserie.

Token wel­che durch JS Link ersetzt wer­den können

Folgende Token kön­nen ver­wen­det wer­den, um sich die Angabe von Pfaden mit JS Link zu vereinfachen:

• ~site
  • Referenz zum aktu­el­len Web (SharePoint Site)
• ~site­collec­tion
  • Referenz zur aktu­el­len SiteCollection
• ~lay­outs
  • Referenz zum aktu­el­len SharePoint Layouts Ordner der Webapplikation (/_layouts/15)
• ~site­collec­tion­lay­outs
  • Referenz zur rela­ti­ven Url der Site Colelction +  " /_layouts/15"
• ~sitelay­outs
  • Referenz zur rela­ti­ven Url der Webseite +  " /_layouts/15"

Im ers­ten Artikel der Serie wurde bereits ein all­tags­taug­li­cher Anwendungsfall gezeigt. Zusammen mit den Grundlagen aus die­sem Artikel kann JS Link nun schon ein­ge­setzt wer­den um eigene Anwendungsfälle abzudecken.

Noch mehr Beispiele für den all­täg­li­chen Einsatz von JS Link und einige wei­tere Tipps und Tricks wer­den in den nächs­ten Artikeln der Serie gezeigt.

Bleibt uns nur noch eins: Das SharePoint Team von Communardo wünscht euch allen einen guten Rutsch in das SharePoint Jahr 2014. Bleibt gespannt!