#SPSLondon - Session 2 JSLink for IT Pros

  • Published on
    06-Aug-2015

  • View
    409

  • Download
    3

Transcript

  1. 1. Using JSLink and Display Templates with the List View Web Part for ITPros Paul Hunt July 11th, 2015
  2. 2. Thanks to our Sponsors
  3. 3. Who Am I? SharePoint Architect for Trustmarque Co-organiser of SUGUK London Region Member of the SharePoint community since 2007 In my spare time Im a woodturner, making Pots, Pens and artistic pieces! Paul Hunt Twitter: @Cimares www.myfatblog.co.uk www.trinityservice.co.uk
  4. 4. Who Am I? SharePoint Architect for Trustmarque Co-organiser of SUGUK London Region Member of the SharePoint community since 2007 In my spare time Im a woodturner, making Pots, Pens and artistic pieces! Paul Hunt Twitter: @Cimares www.myfatblog.co.uk www.trinityservice.co.uk
  5. 5. What is this session all about? The List View Web Part
  6. 6. Whos 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 isnt comfortable with JavaScript, HTML and CSS. Though if you used to play in SPD 2010 youre halfway there! If you want to know what's achievable without deployed solutions
  7. 7. What did we used to do? We used SPD and the Design View We did conditional formatting Played with colours Injected Hyperlinks
  8. 8. What did we used to do? But No design view anymore!
  9. 9. What did we used to do? We used XSLT Overrides (Still exist, but deprecated!)
  10. 10. What did we used to do? We used XSLT Overrides (Still exist, but deprecated!) Which took boring list data views
  11. 11. What did we used to do? We used XSLT Overrides (Still exist, but deprecated!) And transformed them into engaging visual representations
  12. 12. 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
  13. 13. So why the focus on Client Side Rendering?
  14. 14. Its 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?
  15. 15. Its 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?
  16. 16. Specifically why JavaScript, HTML and CSS? Its 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
  17. 17. 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
  18. 18. Display Template Content Types There are 5 Content Types that represent display templates. JavaScript Display Template Control Display Template Group Display Template Item Display Template Filter Display Template These 4 relate to Search.
  19. 19. LVWP Templates != Search Display Templates LVWP Display Templates are JavaScript only. They do not start life as HTML like Display Templates for search do. They do not require embedded properties. CONTEXT (ctx) is king! 23
  20. 20. Were 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
  21. 21. Page Lifecycle The Foundations
  22. 22. Page lifecycle The Foundations SharePoint outputs JSLink in the Header of the page This registers our Display Template
  23. 23. Page lifecycle The Foundations SharePoint LVWP outputs the list data into the page JSON Object Format
  24. 24. Page lifecycle The Foundations And finally after setting things up Calls the RenderListView() function for the web part. Which in turn: Calls the GetTemplates()
  25. 25. 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!
  26. 26. ###CALLOUT Internal Name Pain The_x0020_number_x0020_of_x0020_
  27. 27. Internal names get encoded once, then URL encoded when displayed in the browser adding to the confusion! The internal name of: The_x0020_number_x0020_of_x0020_ Is actually displayed in the browser as :- The%5Fx0020%5Fnumber%5Fx0020%5Fof%5Fx0020%5F Special characters such as & add to the fun! ###CALLOUT Internal Name Pain
  28. 28. ###CALLOUT Internal Name Pain Multiple long field names lose meaning The_x0020_number_x0020_of_x0020_ The_x0020_number_x0020_of_x0020_0
  29. 29. ###CALLOUT Internal Name Pain Creating your fields carefully will save you this pain! Create Rename
  30. 30. ###CALLOUT Internal Name Pain SharePoint 2013 introduces some new pain with the quick edit list functionality.
  31. 31. ###CALLOUT Internal Name Pain Im not a Dev, why do I care?
  32. 32. ###CALLOUT Internal Name Pain Im not a Dev, why do I care? Your Developers (if you have them) will love you!
  33. 33. 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 (This is processed when the DT is loaded)
  34. 34. 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
  35. 35. 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
  36. 36. Anatomy of a List View Display Template Call the function we defined when the page loads.
  37. 37. 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
  38. 38. Anatomy of a Field Rendering Display Template The render function is similar to the list view item function
  39. 39. How do we use them with List Views? First we need to upload/create them in the MasterPage gallery
  40. 40. How do we use them with List Views? Set some metadata
  41. 41. 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 |
  42. 42. How do we troubleshoot? IE Developers Toolbar (Other debuggers exist!)
  43. 43. How do we troubleshoot? Fiddler HTTP Proxy
  44. 44. How do we troubleshoot? Fiddler HTTP Proxy
  45. 45. http://bit.ly/12kMPvr
  46. 46. There has to be a catch? Minimal Download Strategy Multiple list views on a page Changing SharePoint functionality
  47. 47. 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 doesnt 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
  48. 48. There has to be a catch? Multiple list views on a page Because of the way Display Templates are registered, its 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
  49. 49. 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.
  50. 50. Questions?
  51. 51. #SPCSR www.facebook.com/hashspcsr https://github.com/spcsr
  52. 52. 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 60
  53. 53. Thanks to our Sponsors
  54. 54. Dont forget the SharePint Sponsored by Imperial College Union Bar 6pm - 8pm Beit Quadrangle, Prince Consort Road One street up from SPS London Dont forget to get Beer Tokens.
  55. 55. Dont forget SharePint! SHAREPINT: [SHAIR-PAHYNT] Noun 1. An assembly or meeting in relation to Microsoft SharePoint, accompanied with an alcoholic beverage.