FilesExpand file tree

 master

/

document-state.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

155 lines (136 loc) · 4.27 KB

 master

/

document-state.js

Copy path

Top

File metadata and controls

• Code
• Blame

155 lines (136 loc) · 4.27 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

/**

* Copyright 2015 The AMP HTML Authors. All Rights Reserved.

*

* 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.

*/

import {Observable} from './observable';

import {fromClass} from './service';

import {getVendorJsPropertyName} from './style';

import {waitForChild} from './dom';

/**

*/

export class DocumentState {

/**

* @param {!Window} win

*/

constructor(win) {

/** @const {!Window} */

this.win = win;

/** @private @const {!Document} */

this.document_ = win.document;

/** @private {string|null} */

this.hiddenProp_ = getVendorJsPropertyName(this.document_, 'hidden', true);

if (this.document_[this.hiddenProp_] === undefined) {

this.hiddenProp_ = null;

}

/** @private {string|null} */

this.visibilityStateProp_ = getVendorJsPropertyName(this.document_,

'visibilityState', true);

if (this.document_[this.visibilityStateProp_] === undefined) {

this.visibilityStateProp_ = null;

}

/** @private @const {!Observable} */

this.visibilityObservable_ = new Observable();

/** @private {string|null} */

this.visibilityChangeEvent_ = null;

if (this.hiddenProp_) {

this.visibilityChangeEvent_ = 'visibilitychange';

const vendorStop = this.hiddenProp_.indexOf('Hidden');

if (vendorStop != -1) {

this.visibilityChangeEvent_ =

this.hiddenProp_.substring(0, vendorStop) + 'Visibilitychange';

}

}

/** @private @const {!Function} */

this.boundOnVisibilityChanged_ = this.onVisibilityChanged_.bind(this);

if (this.visibilityChangeEvent_) {

this.document_.addEventListener(this.visibilityChangeEvent_,

this.boundOnVisibilityChanged_);

}

/** @private {?Observable} */

this.bodyAvailableObservable_ = null;

}

/** @private */

cleanup_() {

if (this.visibilityChangeEvent_) {

this.document_.removeEventListener(this.visibilityChangeEvent_,

this.boundOnVisibilityChanged_);

}

}

/**

* Returns the value of "document.hidden" property. The reasons why it may

* not be visible include document in a non-active tab or when the document

* is being pre-rendered via link with rel="prerender".

* @return {boolean}

*/

isHidden() {

if (!this.hiddenProp_) {

return false;

}

return this.document_[this.hiddenProp_];

}

/**

* Returns the value of "document.visibilityState" property. Possible values

* are: 'hidden', 'visible', 'prerender', and 'unloaded'.

* @return {string}

*/

getVisibilityState() {

if (!this.visibilityStateProp_) {

return this.isHidden() ? 'hidden' : 'visible';

}

return this.document_[this.visibilityStateProp_];

}

/**

* @param {function()} handler

* @return {!UnlistenDef}

*/

onVisibilityChanged(handler) {

return this.visibilityObservable_.add(handler);

}

/** @private */

onVisibilityChanged_() {

this.visibilityObservable_.fire();

}

/**

* If body is already available, callback is called synchronously and null

* is returned.

* @param {function()} handler

* @return {?UnlistenDef}

*/

onBodyAvailable(handler) {

const doc = this.document_;

if (doc.body) {

handler();

return null;

}

if (!this.bodyAvailableObservable_) {

this.bodyAvailableObservable_ = new Observable();

waitForChild(doc.documentElement, () => !!doc.body,

this.onBodyAvailable_.bind(this));

}

return this.bodyAvailableObservable_.add(handler);

}

/** @private */

onBodyAvailable_() {

this.bodyAvailableObservable_.fire();

this.bodyAvailableObservable_.removeAll();

this.bodyAvailableObservable_ = null;

}

}

/**

* @param {!Window} window

* @return {!DocumentState}

*/

export function documentStateFor(window) {

return fromClass(window, 'documentState', DocumentState);

}