-
Notifications
You must be signed in to change notification settings - Fork 91
/
is-hidden.js
107 lines (103 loc) · 2.9 KB
/
is-hidden.js
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
import { assign, every } from '../helpers';
import { getExecutionContext } from '../execution_context';
/**
* Validates if an element or set of elements is hidden or does not exist in the DOM.
*
* @example
*
* // Lorem <span style="display:none">ipsum</span>
*
* const page = PageObject.create({
* spanIsHidden: PageObject.isHidden('span')
* });
*
* assert.ok(page.spanIsHidden);
*
* @example
*
* // <span>ipsum</span>
* // <span style="display:none">dolor</span>
*
* const page = create({
* spansAreHidden: PageObject.isHidden('span', { multiple: true })
* });
*
* // not all spans are hidden
* assert.notOk(page.spansAreHidden);
*
* @example
*
* // <span style="display:none">dolor</span>
* // <span style="display:none">dolor</span>
*
* const page = create({
* spansAreHidden: PageObject.isHidden('span', { multiple: true })
* });
*
* // all spans are hidden
* assert.ok(page.spansAreHidden);
*
* @example
*
* // Lorem <strong>ipsum</strong>
*
* const page = PageObject.create({
* spanIsHidden: PageObject.isHidden('span')
* });
*
* // returns true when element doesn't exist in DOM
* assert.ok(page.spanIsHidden);
*
* @example
*
* // <div><span>lorem</span></div>
* // <div class="scope"><span style="display:none">ipsum</span></div>
* // <div><span>dolor</span></div>
*
* const page = PageObject.create({
* scopedSpanIsHidden: PageObject.isHidden('span', { scope: '.scope' })
* });
*
* assert.ok(page.scopedSpanIsHidden);
*
* @example
*
* // <div><span>lorem</span></div>
* // <div class="scope"><span style="display:none">ipsum</span></div>
* // <div><span>dolor</span></div>
*
* const page = PageObject.create({
* scope: '.scope',
* scopedSpanIsHidden: PageObject.isHidden('span')
* });
*
* assert.ok(page.scopedSpanIsHidden);
*
* @public
*
* @param {string} selector - CSS selector of the element to check
* @param {Object} options - Additional options
* @param {string} options.scope - Nests provided scope within parent's scope
* @param {number} options.at - Reduce the set of matched elements to the one at the specified index
* @param {boolean} options.resetScope - Override parent's scope
* @param {boolean} options.multiple - Check if all elements matched by selector are hidden
* @param {string} options.testContainer - Context where to search elements in the DOM
* @return {Descriptor}
*
* @throws Will throw an error if multiple elements are matched by selector and multiple option is not set
*/
export function isHidden(selector, userOptions = {}) {
return {
isDescriptor: true,
get(key) {
let executionContext = getExecutionContext(this);
let options = assign({ pageObjectKey: key }, userOptions);
return executionContext.run((context) => {
let elements = context.find(selector, options);
return every(elements, function(element) {
return element.is(':hidden');
});
});
}
};
}