SEF 2012 - A jQuery Primer for Sharepoint

A jQuery Primer for SharePoint

Marc D AndersonCo-Founder & PresidentSympraxis Consulting [email protected]

What is jQuery?

is

GETTING STARTED

Getting Started

• Add references to the jQuery library– Master page– Page layout– Individual aspx pages

<link type="text/css" rel="stylesheet" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.18/themes/start/jquery-ui.css" /><script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script><script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.18/jquery-ui.min.js"></script><script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/jquery.SPServices/0.7.2/jquery.SPServices-0.7.2.min.js"></script>

Referencing Script Libraries from CDNs

More:http://sympmarc.com/2012/04/20/referencing-jquery-jqueryui-and-spservices-from-cdns/

http://sympmarc.com/2012/04/20/referencing-jquery-jqueryui-and-spservices-from-cdns/

• HTML– Hypertext Markup Language– Content and structure

• CSS– Cascading Style Sheets– Presentation and style

• JavaScript and jQuery– Interactive behavior

SharePoint Web Technology

HTML Elements

Powered by <a href="http://office365.com">Office365</a>.

Opening tag Closing tag

Attribute Value

INTRO TO CSS

• CSS = Cascading Style Sheets• jQuery uses selectors that are very

similar to CSS selectors• CSS is the fundamental styling

mechanism for the Web• HTML + CSS + jQuery = AWESOME

Intro to CSS:Why does CSS matter?

CSS Styles

.article { color: red;}

Select HTML element(s)

Modify them!

CSS Element Selectors

<p>

Paragraph of

text.

</p>

p {

color:

red;

}

Paragraph of text.

CSS Class Selectors

<div

class="article">

This is an

article.

</div>

.article {

color: red;

}

This is an article.

CSS ID Selectors

<div id="header">

This is a header.

</div>

#header {

color: red;

}

This is a header.

CSS Descendant Selectors

<div id="header"> <h1> This is a header. </h1></div>

#header h1 {

color: red;

}

This is a header.

CSS Composite Selectors<div id="header">

<ul class="top-nav">

<li>Item 1</li>

<li>Item 2</li>

<li>Item 3</li>

</ul>

</div>

#header ul.top-nav li {

color: red;

}

• Item 1

• Item 2

• Item 3

CSS Complex Selectors<ul class="top-nav"> <li>Item 1</li> <li> Item 2 <ul class="menu"> <li>Menu 1</li> </ul> </li></ul>

ul.top-nav > li

{

color: red;

}

• Item 1

• Item 2

• Menu 1

• Use truly unique class and id names• Choose a prefix for your project, e.g.

‘xyz-’ or ‘x51-’• All of your classes and ids will be easy

to select:xyz-home-page-articlex51-top-section

• Don’t be afraid of verbose class and ID names!

My CSS "Best" Practices

DOCUMENT OBJECT MODEL (DOM)

• The DOM starts as the page’s markup (HTML) as delivered to the browser by the server: View Source

• Styled by the CSS which gives the page its look and feel

• The DOM is acted upon by any script in the page

What is the Document Object Model (DOM)?

• Add or remove CSS classes• Create new HTML elements• Remove HTML elements• Change HTML element attributes• And so much more

What Can We Do With the DOM?

The DOM is HTML, which is XML, which is data!

IMPORTANT TOOLS

• Shows the Internet Explorer view of the DOM in SharePoint’s pages – some pages and controls are rendered differently in other browsers

Internet Explorer Developer Tools (F12)

• Better for debugging and looking at Net traffic

The Firebug Add-On for Firefox

JQUERY BASICS

The Basic Idea of jQuery

$('.article').hide();

Select something

Do something!

$(document).ready(function({ // do something});

• Processing is suspended until the page’s DOM is fully loaded

• Ensures that all of the elements you need are available

jQuery’s Document Ready

• The jQuery documentation is arranged to help you

• What you need to know is arranged sequentially from top to bottom

jQuery Documentation: Your Friend

SELECTORS

• Selectors are the most important jQuery concept

• Selecting the right DOM object(s) is half the battle

• Selectors return a collection of DOM objects – 0 to n matching elements

jQuery Selectors

jQuery Element Selectors

$("p")

<p>

Paragraph of

text.

</p>

jQuery Element Selectors

var allParagraphs = $("p");

<p>Paragraph 1 of text.</p><p>Paragraph 2 of text.</p>

allParagraphs is now defined as a jQuery object which contains pointers to all of the paragraphs in the page

jQuery Class Selectors

$(".article")

<div class="article"> This is an article.</div>

jQuery ID Selectors

$("#header")

<div id="header"> This is a header.</div>

jQuery Descendant Selectors

$("#header h1")

<div id="header"> <h1> This is a header. </h1></div>

jQuery Composite Selectors

$("#header ul.top-nav li")

<div id="header"> <ul class="top-nav"> <li>Item 1</li> <li>Item 2</li> <li>Item 3</li> </ul></div>

jQuery Complex Selectors

$("#header ul.top-nav ul.menu

li")

<div id="header"> <ul class="top-nav"> <li>Item 1</li> <li> Item 2 <ul class="menu"> <li>Menu 1</li> </ul> </li> </ul></div>

Selectors for SharePoint<DIV id=ctl00_PlaceHolderLeftNavBar_QuickLaunchNavigationManager class=ms-quicklaunch-navmgr> <DIV> <DIV id=zz18_V4QuickLaunchMenu class=s4-ql> <DIV class="menu vertical menu-vertical"> <UL class="root static"> <LI class=static> <A class="static menu-item" href="/sitename/_layouts/viewlsts.aspx?BaseType=1">

$("div.ms-quicklaunch-

navmgr")

Selectors for SharePoint

$

("#ctl00_PlaceHolderLeftNavBar_QuickLaunchNavigationMana

ger")

<DIV id=ctl00_PlaceHolderLeftNavBar_QuickLaunchNavigationManager class=ms-quicklaunch-navmgr> <DIV> <DIV id=zz18_V4QuickLaunchMenu class=s4-ql> <DIV class="menu vertical menu-vertical"> <UL class="root static"> <LI class=static> <A class="static menu-item" href="/sitename/_layouts/viewlsts.aspx?BaseType=1">

Selectors for SharePoint

$(".ms-quicklaunch-navmgr a.static.menu-item")


• .NET Applications like SharePoint generate some long and ugly markup and IDs• These selector tricks really help$("[id='foo']"); // Equal to$("[id!='foo']"); // Not equal to$("[id^='foo']"); // Starts with$("[id$='foo']"); // Ends with$("[id*='foo']"); // Contains$("[id~='foo']"); // Contains word$("[id|='foo']"); // Contains prefix$("[id]"); // Has$("[id][class][style]"); // Has all

Useful jQuery Selector Tricks

NEXT SESSION AT 12:50

A jQuery Primer for SharePoint: Attributes, Traversing, Manipulation, Events, and Effects

ATTRIBUTES

• Once you’ve selected the right DOM element, you can use jQuery to get or set its attributes

• As of jQuery 1.6, the .prop() method provides a way to explicitly retrieve property values, while .attr() retrieves attributes

jQuery Attributes

jQuery Attributes: Get and Set

GET: var thisClass = $

("#helloDiv").attr("class");

SET: $("#helloDiv").attr("class", "ms-

hidden");

<div id="helloDiv" class="ms-bold"> Hello, world! </div>

Example with SharePoint Attributes: Get


var thisHref = $(".ms-quicklaunch-navmgr a.static.menu-

item:first")

.attr("href");

Example with SharePoint Attributes: Set

<DIV id=ctl00_PlaceHolderLeftNavBar_QuickLaunchNavigationManager class=ms-quicklaunch-navmgr> <DIV> <DIV id=zz18_V4QuickLaunchMenu class=s4-ql> <DIV class="menu vertical menu-vertical"> <UL class="root static"> <LI class=static> <A class="static menu-item" href="/sitename/mypage.aspx">

$(".ms-quicklaunch-navmgr a.static.menu-item:first")

.attr("href", "/sitename/mypage.aspx");

TRAVERSING

• Traversing lets you move around the DOM based on your initial selection

• This is how you get at elements which are difficult to select directly

• Ancestry matters in XML / HTML

Traversing

Find an Element’s Ancestors<div id="helloDiv" class="ms-bold"> <ul> <li>Item 1</li> <li>Item 2</li> <li>Item 3</li> </ul></div>

$("ul").parent();

$("ul").closest("div");=

Traversing Down:Initial Selector

<DIV class=ms-quicklaunchheader> <A accessKey=3 id=ctl00_PlaceHolderLeftNavBar_idNavLinkViewAll href="/Intranet/JQueryLib/_layouts/viewlsts.aspx"> View All Site Content </A> </DIV>

$("div.ms-quicklaunchheader").find("a");

Traversing Down:Finding Specific Children


$("div.ms-quicklaunchheader").find("a");

Traversing Up:Initial Selector

$("a[id$='NavLinkViewAll']").parent();


Traversing Up:Finding Specific Ancestors


$("a[id$='NavLinkViewAll']").parent();

Traversal Example from SPServices


var possibleValues = $("select[ID$='SelectCandidate'][Title^='" + opt.multiSelectColumn + " ']");var selectedValues = possibleValues.closest("span").find("select[ID$='SelectResult'][Title^='" + opt.multiSelectColumn + " ']");

SelectCandidate SelectResult

MANIPULATION

• Once you’ve gotten the right element(s), you can:– Manipulate their attributes or

properties– Change their contents– Move them in the DOM

Manipulation

Manipulation:Adding Text


$("#helloDiv").append(" And you're welcome to it!");

<div id="helloDiv" class="ms-bold"> Hello, world! And you're welcome to it!</div>

Manipulation:Adding CSS Classes


$("#helloDiv").addClass("my-class");

<div id="helloDiv" class="ms-bold my-class"> Hello, world! </div>

Manipulation:Wrapping Elements


$("#helloDiv") .wrap("<a href='http://cnn.com'></a>");

<a href="http://cnn.com"> <div id="helloDiv" class="ms-bold">

Hello, world! </div></a>

Manipulation:Inserting Elements


$("#helloDiv") .before("<div>In the beginning...</div>");

<div>In the beginning...</div><div id="helloDiv" class="ms-bold"> Hello, world! </div>

Manipulation:Changing CSS


$("#helloDiv") .css("background-color", "fuchsia");

$("h3.ms-WPTitle a").css({ border: "5px black solid", color: "red"});

EVENTS

• jQuery’s events enable you to work with all of the standard JavaScript events

• These methods are used to register behaviors to take effect when the user interacts with the browser, and to further manipulate those registered behaviors.

Events

jQuery Events

$('.article').click(function(){ // do something});

$('.article').mouseover(function(){ // do something});

jQuery Events for Web Part Titles

$("h3.ms-WPTitle").click(function() { alert("Go directly to the list!");});

$("h3.ms-WPTitle").mouseover(function() { $(this).css("background-color", "fuchsia");});

EFFECTS

Effects

• jQuery gives you a set of effects you can use to change the elements in the page

• Effects can be:– Visual: Change how the user sees

existing elements with animations– Manipulative: Change where and how

elements are shown by moving them around in the DOM

$('.article').hide();$('.article').slideUp();$('.article').after("<em>Hello!</em>");$('.article').css("color", "red");

jQuery Effects Examples

Putting It Together: Example

Change what happens when you click on a Web Part Title

// Remove the links on the Web Part Titles$("h3.ms-WPTitle").find("nobr").unwrap("<a></a>");

// Add click behavior that toggles the visibility// of the Web Part$("h3.ms-WPTitle").click(function() { $(this).closest("table").closest("tr").next().toggle();});

Putting It Together: Example

This example shows part of SPArrangeChoices from SPServices.

// Collect all of the choices$(thisFormField).find("tr").each(function() { columnOptions.push($(this).html());});

out = "<TR>";// Add all of the options to the out stringfor(i=0; i < columnOptions.length; i++) { out += columnOptions[i]; // If we've already got perRow columnOptions in the row, close off the row if((i+1) % opt.perRow === 0) { out += "</TR><TR>"; }}out += "</TR>";

// Remove the existing rows...$(thisFormField).find("tr").remove();// ...and append the out string$(thisFormField).find("table").append(out);

$('.article').tabs();$('input').autocomplete();$('#infoBox').dialog();

…and many more

jQueryUI Takes Effects Further

• If you want to do something sophisticated, look for an existing plugin

• Due diligence is up to you– some of the plugins aren’t written very well

• Beware of "plugin sprawl"

jQuery Plugins Abound!

• JavaScript Compressorator – Minifies script files using multiple methods http://compressorrater.thruhere.net/

• JSLint – Checks your script against accepted standards http://jslint.com/ "Warning: JSLint will hurt your feelings."

More Useful Tools

http://compressorrater.thruhere.net/



http://jslint.com/

http://jslint.com/

http://jslint.com/

Contact InformationeMail [email protected]

Blog http://sympmarc.comSPServices http://spservices.codeplex.com

SPXSLT http://spxslt.codeplex.comeBook http://bit.ly/UnlockingDVWP

The Middle Tier Manifesto http://bit.ly/middletier

mailto:[email protected]

http://sympmarc.com/

http://spservices.codeplex.com/

http://spxslt.codeplex.com/

http://bit.ly/UnlockingDVWP

http://bit.ly/middletier

SEF 2012 - A jQuery Primer for Sharepoint

Technology

Transcript of SEF 2012 - A jQuery Primer for Sharepoint