Minimal Download Strategy. Simple

Anatoly Mironov

There are many correct ways (1, 2, 3, 4, 5…) of making scripts work with the Minimal Download Strategy Feature (MDS) in SharePoint 2013 and 2016. But to be honest - every time I need it, I get confused. So now it is time to find a simple solution for that. Who is better at it than the developers of the SharePoint themselves? Look at the MDS code in the built-in Display Templates:

mds-001

Let’s keep it as simple as Item_Default.js, let’s take it as it is and create our own scripts. Here is a skeletton of and MDS-ready script:

function runMyCode() {
  var time = new Date().toISOString();
  console.log('runMyCode', time);
}
runMyCode();
if (typeof (RegisterModuleInit) == 'function') {
  var scriptUrl = '/Style Library/runMyCode.js';
  RegisterModuleInit(scriptUrl, runMyCode);
}

Which boils down to this in pseudocode:

  1. Execute your code
  2. Determine if MDS is enabled
  3. If MDS is enabled
  4.       Register your code for execution

That’s it. No more overcomplicating.

External scripts (outside SharePoint Site Collection, from CDN) within ScriptBlock of a custom action (like AddJSLink in PnP)  work withou any MDS-adjustments. The ScriptBlock adds a script tag to the head of the html document, and it the js reference is added to every AjaxDelta load. I would need more time to find out why. The good news is: it is an argument for using more CDN solutions in SharePoint.

Old stuff

A while ago I wrote two blog posts about MDS. Now I realise they were overcomplicated and the solution required customizations of the master page and 3rd-party scripts.

  1. Make your javascript code work with MDS part 1
  2. Make your javascript code work with MDS part 2

comments from wordpress

Make javascript code work with Minimal Download Strategy Part 2 | CHUVASH.eu — 2016-04-03

[…] have a newer blog post about MDS, that provides a much simpler solution. Please check it before reading […]

Make javascript code work with Minimal Download Strategy Part 1 | CHUVASH.eu — 2016-04-03

[…] have a newer blog post about MDS, that provides a much simpler solution. Please check it before reading […]

Sharepoint 2016: Add custom js and deal with MDS problems! – Viktor's storage — 2017-08-04

[…] https://chuvash.eu/2016/04/27/minimal-download-strategy-simple/ […]