Namespace fiveui.jquery

Defined in: jquery-plugins.js.

Namespace Summary

Constructor Attributes	Constructor Name and Description
	fiveui.jquery This module provides several useful jQuery plugins related to checking and reporting UI consistency issues.

Method Summary

Method Attributes	Method Name and Description
<static>	fiveui.jquery.attrFilter(a, fn) General attribute filter This plugin filters for elements whose attribute `a` pass the predicate `fn`, which should take a string and return true or false.
<static>	fiveui.jquery.cssIs(prop, set, fn) General CSS property checker plugin This plugin filters elements, keeping only elements whose CSS property `prop` is a member of the given array `cset`.
<static>	fiveui.jquery.cssIsNot(prop, set, fn) Negated version of fiveui.jquery.cssIs Behaves exactly like fiveui.jquery.cssIs - except that this version excludes elements that have CSS properties and values that match.
<static>	fiveui.jquery.hasText(text) Wrapper for the :contains('text') selector
<static>	fiveui.jquery.highlight(hint) Visually highlight elements in the jQuery object.
<static>	fiveui.jquery.linksTo(href) Filter out elements that do not contain the attribute href=`href`.
<static>	fiveui.jquery.noAttr(attribute) Filter for elements which lack of the given attribute.
<static>	fiveui.jquery.noSubElt(sel, A) Filter for elements having no sub-elements matching the given selector.
<static>	fiveui.jquery.notColorSet(cset) Color checker plugin: filters for elements whose CSS color property is not in the given set.
<static>	fiveui.jquery.propDist(prop, log) Returns a list of css properties that element in the jQuery object have.

$('input').attrFilter('type', function(t) { return t === 'checkbox'; });

Parameters:

{string} a

element attribute name

{Function} fn

a predicate to run on the element attribute

Returns:

{Object} jQuery object

---

var div = $('<div style="visibility:hidden"></div>')
div.cssIs('visibility', ['hidden', 'visible'])  // returns the same div

Parameters:

{string} prop

CSS property selector

{string|string[]} set

allowable values (either a string or an array of strings)

{function(string):string} fn Optional

Function to apply to return values of $(this).css(prop), fn defaults to the identity function.

Returns:

{Object} jQuery object

---

var div = $('<div style="visibility:hidden"></div>')
div.cssIsNot('visibility', ['hidden', 'visible'])  // returns empty result

Parameters:

{string} prop

CSS property selector

{string|string[]} set

allowable values (either a string or an array of strings)

{function(string):string} fn Optional

Function to apply to return values of $(this).css(prop), fn defaults to the identity function.

Returns:

{Object} jQuery object

---

$('div').hasText('to remove').remove();

Parameters:

{!string} text

Text to select for

Returns:

{!Object} A modified jQuery object

---

> $5("p").hasText("foo").highlight();

Parameters:

{string} hint Optional

Highlighted border color, defaults to "red"

Returns:

{!Object} A modified jQuery object

---

Parameters:

{string} href

the href to look for

Returns:

{Object} jQuery object

---

$('<table></table>').noAttr('summary').each(function(idx, table) {
  // `table` is a table element that does not have a "summary"
  // attribute or that has a "summary" attribute that is empty.
});

Parameters:

{!string} attribute

name

Returns:

{!Object} a filtered jQuery object

---

// Returns an empty result because the <div> contains a <p> element.
$('<div><p>hello</p></div>').noSubElt('p')

Parameters:

{!string} sel

a jQuery selector

{!Object} A

filtered jQuery object

---

Parameters:

{string[]} cset

An array of allowable color strings

Returns:

{!Object} A modified jQuery object

See:

---

> $5("*").propDist("font-size", true);

Parameters:

{string} prop

CSS property to be inspected

{boolean} log Optional

Boolean which enables console logging of the result; default is `false`.

Returns:

{Object} A frequence map { "property": frequency }

---