1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* Module : injected/jquery-plugins.js
* Copyright : (c) 2011-2012, Galois, Inc.
*
* Maintainer :
* Stability : Provisional
* Portability: Portable
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This module provides several useful jQuery plugins related to checking and reporting
* UI consistency issues.
*
* @namespace
*/
fiveui.jquery = fiveui.jquery || {};
/**
* Wrapper for the :contains('text') selector
*
* Example:
*
* $('div').hasText('to remove').remove();
*
* @param {!String} text Text to select for
* @returns {!Object} A modified jQuery object
*/
fiveui.jquery.hasText = function (text) {
return this.filter(":contains('" + text + "')");
};
/**
* Filter for elements which lack of the given attribute.
*
* Example:
*
* This object will be non-empty:
*
* $('<table></table>').noAttr('summary')
*
* @param {!String} attribute name
* @returns {!Object} a filtered jQuery object
*/
fiveui.jquery.noAttr = function (name) {
return this.filter(function () {
$attr = $.trim($(this).attr(name));
return $attr == undefined || $attr == '';
});
};
/**
* Filter for elements having no sub-elements matching the given selector.
*
* Example: the following should contain no elements
*
* $('<div><p>hello</p></div>').noSubElt('p')
*
* @param {!String} sel a jQuery selector
* @param {!Object} A filtered jQuery object
*/
fiveui.jquery.noSubElt = function (sel) {
return this.filter(function () {
return $(this).find(sel).length == 0;
});
};
/**
* Color checker plugin: filters for elements whose CSS color property is
* not in the given set.
*
* @description Note: This is a special case of fiveui.jquery.cssIsNot, i.e.
* $(..).notColorSet(set) == $(..).cssIsNot("color", set, fiveui.color.colorToHex)
* @see {fiveui.color.colorToHex}
*
* @param {String[]} cset An array of allowable color strings
* @returns {!Object} A modified jQuery object
*/
fiveui.jquery.notColorSet = function (cset) {
var allowable = {};
// input array -> object
for (var i = 0; i < cset.length; i += 1) {
allowable[fiveui.color.colorToHex(cset[i])] = true;
}
return this.filter(function (index) {
var color = fiveui.color.colorToHexWithDefault($(this).css("color")); // .css("color") returns rgb(...)
return !(color in allowable);
});
};
/**
* General CSS propetry checker plugin
*
* @description This plugin filters for elements whose CSS property `prop` is not a member
* of the given array `cset`. The values checked are transformed using the
* optional given function `fn`. This may be used to normalize values that the
* browser returns so they can be compared to values in `cset`.
*
* @param {String} prop CSS property selector
* @param {String|String[]} set allowable values (either a string or an array of strings)
* @param {function(String):String} [fn] Function to apply to return values of $(this).css(prop), fn defaults to the identity function.
* @returns {Object} jQuery object
*/
fiveui.jquery.cssIsNot = function (prop, set, fn) {
var allowable = {};
fn = fn || function (x) { return x; }; // default is Id
if (typeof set === "string") {
allowable[fn(set)] = true;
}
else { // assume `set` is an array of strings
// array -> object
for (var i = 0; i < set.length; i += 1) {
allowable[fn(set[i])] = true;
}
}
return this.filter(function (index) {
var cssProp = fn($(this).css(prop));
return !(cssProp in allowable);
});
}
/**
* Filter out elements that do not contain the attribute
* href=`href`.
*
* @param {String} href the href to look for
* @returns {Object} jQuery object
*/
fiveui.jquery.linksTo = function (href) {
return this.filter('[href=' + href + ']');
}
/**
* Visually highlight elements in the jQuery object.
*
* @description This plugin is useful mostly in the process of writing
* guidelines, for example the guideline developer can load a page,
* click the "Break" button on the FiveUI window, enter the browser's
* Javascript console, and run:
*
* @example > $5("p").hasText("foo").highlight();
*
* @param {String} [hint] Highlighted border color, defaults to "red"
* @returns {!Object} A modified jQuery object
*/
fiveui.jquery.highlight = function (hint) {
hint = hint || "red"; // Default is "red"
return this.css("background-color", "rgba(255, 0, 0, 0.3)")
.css("border-style", "solid")
.css("border-color", hint);
}
/**
* Returns a list of css properties that element in the jQuery
* object have.
*
* @description This plugin is useful for analysis of a given page when
* writing guielines. For example if the guideline developer wants to
* know what font sizes are used on a loaded page, they can run from the
* Javascript console:
*
* @example > $5("*").propDist("font-size", true);
*
* @param {String} prop CSS property to be inspected
* @param {boolean} [log] Boolean which enables console logging of the result; default is `false`.
* @returns {Object} A frequence map { "property": frequency }
*/
fiveui.jquery.propDist = function (prop, log) {
var res = {};
log = log || false;
this.each(function (i, elt) {
var p = $(elt).css(prop);
if (p in res) {
res[p] += 1;
}
else {
res[p] = 1;
}
});
if (log) {
console.log("Property distribution:");
for (var p in res) {
console.log(" " + p + ": " + res[p]);
}
}
return res;
}
/**
* Register the plugins. This adds methods to the jQuery.fn namespace.
*/
fiveui.jquery.init = function () {
for (fn in fiveui.jquery) {
f = fiveui.jquery[fn];
if (jQuery.isFunction(f) && fn != "init") {
jQuery.fn[fn] = fiveui.jquery[fn];
}
}
}
fiveui.jquery.init();
|
