Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Spsbe using js-linkanddisplaytemplates

623 views

Published on

These are the slides from my #SPSBE session #SPSBE23 on Display Templates and JSLink for IT Pros. This is a slightly amended version of the session that I've uploaded for SPSUK and SPSSTHLM as a result of feedback from those earlier sessions.

As a result of conversations from this session and a twitter jam during the journey home, I'll announcing some great news about a community effort to make Display Template samples from many great speakers around the world available in one location.

Watch twitter using hashtag #SPCSR for more info as we announce it.

Published in: Technology, Business
  • Be the first to comment

  • Be the first to like this

Spsbe using js-linkanddisplaytemplates

  1. 1. Using JSLink and Display Templates with the List View Web Part for ITPros #SPSBE23 Paul Hunt April 26th, 2014
  2. 2. Gold Silver
  3. 3. Who Am I? • SharePoint Architect for Trinity Expert Systems • Co-organiser of SUGUK London Region • Member of the SharePoint community since 2007 • In my spare time I’m a woodturner, making Pots, Pens and artistic pieces! • Paul Hunt • Twitter: @Cimares • www.myfatblog.co.uk • www.trinityservice.co.uk
  4. 4. What is this session all about? • The List View Web Part
  5. 5. Who’s this session for? • Primarily First/Second tier developers  ITPros who customised 2010 list views in SPD  ITPros that used to write their own XSLT in SP2010  Developers that want to know what's available before opening VS2012 • On Premises or Office 365 Deployments • Might not be ideal for someone who isn’t comfortable with JavaScript, HTML and CSS. – Though if you used to play in SPD 2010 you’re halfway there! – If you want to know what's achievable without deployed solutions
  6. 6. What did we used to do? • We used SPD and the Design View  We did conditional formatting  Played with colours  Injected Hyperlinks
  7. 7. What did we used to do? • But  No design view anymore!
  8. 8. What did we used to do? • We used XSLT Overrides (Still exist, but deprecated!)
  9. 9. What did we used to do? • We used XSLT Overrides (Still exist, but deprecated!)  Which took boring list data views
  10. 10. What did we used to do? • We used XSLT Overrides (Still exist, but deprecated!)  And transformed them into engaging visual representations
  11. 11. What did we used to do? • We used custom code solutions (We still can!)  Custom CAML Rendering Templates  Custom List Views  Custom Web Parts • All bring additional headaches
  12. 12. So why the focus on Client Side Rendering?
  13. 13. • It’s client side, moving the impact of customisations off of the web server and onto the often powerful and under utilised client machine SETI@Home Folding@Home So why the focus on Client Side Rendering?
  14. 14. • It’s client side, moving the impact of customisations off of the web server and onto the often powerful and under utilised client machine • Some client machines may struggle with heavy Javascript loads! So why the focus on Client Side Rendering?
  15. 15. Specifically why JavaScript, HTML and CSS? • It’s easier to develop.. • Much simpler than XSLT • Certainly easier to troubleshoot than XSLT • Likely to have the skills in house • Cross-platform (ish!)  Some frameworks such as jQuery help with this
  16. 16. Exactly what is a JavaScript Display Template?• A small piece of JavaScript code that is called by the browser AFTER the page has been delivered. • They are prolific in SharePoint 2013  Some examples  Search Results  Field Rendering  Search Refiners  List Forms  List views  eDiscovery
  17. 17. These 4 relate to Search.
  18. 18. 22
  19. 19. We’re just looking at:- • List View Display Templates  These provide the ability to override the rendering of an entire view • Field Rendering Display Templates  These provide the ability to override the rendering of a single field in a list view
  20. 20. Page Lifecycle – The Foundations
  21. 21. Page lifecycle – The Foundations • SharePoint outputs JSLink in the Header of the page  This registers our Display Template
  22. 22. Page lifecycle – The Foundations • SharePoint LVWP outputs the list data into the page  JSON Object Format
  23. 23. Page lifecycle – The Foundations • And finally after setting things up  Calls the RenderListView() function for the web part. • Which in turn: – Calls the GetTemplates()
  24. 24. Page lifecycle – The Result • Which compares the Context object to the list of registered overrides • And if everything is in place, our override wins the battle!
  25. 25. ###CALLOUT – Internal Name Pain • Creating your fields carefully will save you pain!
  26. 26. ###CALLOUT – Internal Name Pain • Creating your fields carefully will save you pain! • Internal names get encoded once, then URL encoded when displayed. • The displayed name The%5Fx0020%5Fnumber%5Fx0020%5Fof%5Fx0020%5F • Is actually an internal name of: The_x0020_number_x0020_of_x0020_
  27. 27. ###CALLOUT – Internal Name Pain • Creating your fields carefully will save you pain! • Multiple long field names lose meaning • The_x0020_number_x0020_of_x0020_ • The_x0020_number_x0020_of_x0020_0
  28. 28. Anatomy of a List View Display Template• Start with an empty .JS (Or copy example templates) • Define a Function to register the Display Template • Define the Function called by the Display Template for each item. • Call the register function
  29. 29. Anatomy of a List View Display Template• Define a Function to register the Display Template For a list of template types see - http://bit.ly/169AbS9
  30. 30. Anatomy of a List View Display Template• Define the Function called by the Display Template • Note the use of ctx.CurrentItem.Title – Any field in the view can be obtained this way – You must use the internal name • Obtained from the edit column screen – Beware the double encoding issue! • Or using the browser debugger
  31. 31. Anatomy of a List View Display Template• Call the function we defined when the page loads.
  32. 32. Anatomy of a Field Rendering Display Template• All that really changes is the override set-up • This time there are no headers/footers • We only specify the Base View ID/Field Name
  33. 33. Anatomy of a Field Rendering Display Template• The render function is similar to the list view item function
  34. 34. How do we use them with List Views? • First we need to upload/create them in the MasterPage gallery
  35. 35. How do we use them with List Views? • Set some metadata
  36. 36. How do we use them with List Views? • Add a link into the JSLink on the web part • Note the ~token in use – ~sitecollection – ~site – ~layouts – ~sitecollectionlayouts – ~sitelayouts • You can have multiple JSLinks – Join them with |
  37. 37. How do we troubleshoot? • IE Developers Toolbar (Other debuggers exist!)
  38. 38. How do we troubleshoot? • Fiddler – HTTP Proxy
  39. 39. How do we troubleshoot? • Fiddler – HTTP Proxy
  40. 40. http://bit.ly/12kMPvr
  41. 41. There has to be a catch? • Minimal Download Strategy • Multiple list views on a page • Changing SharePoint functionality
  42. 42. There has to be a catch? • Minimal Download Strategy  Our display templates work on page load  But fail during a refresh.  This is because our JavaScript doesn’t get called a second time • Two workarounds! • Turn off the Minimal Download Feature in each Web • Include the relevant JavaScript in your Display Template code
  43. 43. There has to be a catch? • Multiple list views on a page  Because of the way Display Templates are registered, it’s not possible to have two on the page if the list templates are the same. (E.g. Custom TemplateType = 100)  There is a workaround though published on my blog  http://bit.ly/JSLinkIssues
  44. 44. There has to be a catch? • Changing/Breaking SharePoint functionality  For example, overriding the Tasks view breaks SharePoint rendering.  This is fixed in the earlier Field demo with a couple of lines of JavaScript.
  45. 45. Questions?
  46. 46. Call to Action! • Take a look at these sites for more detailed info • Wes Preston – JS Link a primer - http://bit.ly/102fcNa • Martin Hatch – JSLink 7 part series - http://bit.ly/Hh5zFk • My blog  Solving the multiple list view issue - http://bit.ly/JSLinkIssues  Editing local JS files using fiddler - http://bit.ly/EditUsingFiddler 54
  47. 47. Don’t forget SharePint! • SHARE·PINT: [SHAIR-PAHYNT] Noun 1. An assembly or meeting in relation to Microsoft SharePoint, accompanied with an alcoholic beverage.

×