FilesExpand file tree

 master

/

document-click.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

213 lines (185 loc) · 7.02 KB

 master

/

document-click.js

Copy path

Top

File metadata and controls

• Code
• Blame

213 lines (185 loc) · 7.02 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

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

/**

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

closestByTag,

openWindowDialog,

escapeCssSelectorIdent,

} from './dom';

import {fromClassForDoc} from './service';

import {dev} from './log';

import {historyForDoc} from './history';

import {parseUrl} from './url';

import {viewerForDoc} from './viewer';

import {viewportForDoc} from './viewport';

import {platformFor} from './platform';

import {timerFor} from './timer';

import {urlReplacementsForDoc} from './url-replacements';

/**

* @param {!./service/ampdoc-impl.AmpDoc} ampdoc

*/

export function installGlobalClickListenerForDoc(ampdoc) {

fromClassForDoc(ampdoc, 'clickhandler', ClickHandler);

}

/**

* Intercept any click on the current document and prevent any

* linking to an identifier from pushing into the history stack.

* @visibleForTesting

*/

export class ClickHandler {

/**

* @param {!./service/ampdoc-impl.AmpDoc} ampdoc

*/

constructor(ampdoc) {

/** @const {!./service/ampdoc-impl.AmpDoc} */

this.ampdoc = ampdoc;

/** @private @const {!./service/viewport-impl.Viewport} */

this.viewport_ = viewportForDoc(this.ampdoc);

/** @private @const {!./service/viewer-impl.Viewer} */

this.viewer_ = viewerForDoc(this.ampdoc);

/** @private @const {!./service/history-impl.History} */

this.history_ = historyForDoc(this.ampdoc);

const platform = platformFor(this.ampdoc.win);

/** @private @const {boolean} */

this.isIosSafari_ = platform.isIos() && platform.isSafari();

// Only intercept clicks when iframed.

if (this.viewer_.isIframed() && this.viewer_.isOvertakeHistory()) {

/** @private @const {!function(!Event)|undefined} */

this.boundHandle_ = this.handle_.bind(this);

this.ampdoc.getRootNode().addEventListener('click', this.boundHandle_);

}

}

/**

* Removes all event listeners.

*/

cleanup() {

if (this.boundHandle_) {

this.ampdoc.getRootNode().removeEventListener('click', this.boundHandle_);

}

}

/**

* Click event handler which on bubble propagation intercepts any click on the

* current document and prevent any linking to an identifier from pushing into

* the history stack.

* @param {!Event} e

*/

handle_(e) {

onDocumentElementClick_(

e, this.ampdoc, this.viewport_, this.history_, this.isIosSafari_);

}

}

/**

* Intercept any click on the current document and prevent any

* linking to an identifier from pushing into the history stack.

*

* This also handles custom protocols (e.g. whatsapp://) when iframed

* on iOS Safari.

*

* @param {!Event} e

* @param {!./service/ampdoc-impl.AmpDoc} ampdoc

* @param {!./service/viewport-impl.Viewport} viewport

* @param {!./service/history-impl.History} history

* @param {boolean} isIosSafari

*/

export function onDocumentElementClick_(

e, ampdoc, viewport, history, isIosSafari) {

if (e.defaultPrevented) {

return;

}

const target = closestByTag(dev().assertElement(e.target), 'A');

if (!target || !target.href) {

return;

}

urlReplacementsForDoc(ampdoc).maybeExpandLink(target);

/** @const {!Window} */

const win = ampdoc.win;

const tgtLoc = parseUrl(target.href);

// On Safari iOS, custom protocol links will fail to open apps when the

// document is iframed - in order to go around this, we set the top.location

// to the custom protocol href.

const isFTP = tgtLoc.protocol == 'ftp:';

// In case of FTP Links in embedded documents always open then in _blank.

if (isFTP) {

openWindowDialog(win, target.href, '_blank');

e.preventDefault();

}

const isNormalProtocol = /^(https?|mailto):$/.test(tgtLoc.protocol);

if (isIosSafari && !isNormalProtocol) {

openWindowDialog(win, target.href, '_top');

// Without preventing default the page would should an alert error twice

// in the case where there's no app to handle the custom protocol.

e.preventDefault();

}

if (!tgtLoc.hash) {

return;

}

/** @const {!Location} */

const curLoc = parseUrl(win.location.href);

const tgtHref = `${tgtLoc.origin}${tgtLoc.pathname}${tgtLoc.search}`;

const curHref = `${curLoc.origin}${curLoc.pathname}${curLoc.search}`;

// If the current target anchor link is the same origin + path

// as the current document then we know we are just linking to an

// identifier in the document.

if (tgtHref != curHref) {

return;

}

// We prevent default so that the current click does not push

// into the history stack as this messes up the external documents

// history which contains the amp document.

e.preventDefault();

// Look for the referenced element.

const hash = tgtLoc.hash.slice(1);

let elem = null;

if (hash) {

const escapedHash = escapeCssSelectorIdent(ampdoc.win, hash);

elem = (ampdoc.getRootNode().getElementById(hash) ||

// Fallback to anchor[name] if element with id is not found.

// Linking to an anchor element with name is obsolete in html5.

ampdoc.getRootNode().querySelector(`a[name="${escapedHash}"]`));

}

// If possible do update the URL with the hash. As explained above

// we do `replace` to avoid messing with the container's history.

// The choice of `location.replace` vs `history.replaceState` is important.

// Due to bugs, not every browser triggers `:target` pseudo-class when

// `replaceState` is called. See http://www.zachleat.com/web/moving-target/

// for more details. Do this only if fragment has changed.

if (tgtLoc.hash != curLoc.hash) {

win.location.replace(`#${hash}`);

}

// Scroll to the element if found.

if (elem) {

// The first call to scrollIntoView overrides browsers' default

// scrolling behavior. The second call insides setTimeout allows us to

// scroll to that element properly.

// Without doing this, the viewport will not catch the updated scroll

// position on iOS Safari and hence calculate the wrong scrollTop for

// the scrollbar jumping the user back to the top for failing to calculate

// the new jumped offset.

// Without the first call there will be a visual jump due to browser scroll.

// See https://github.com/ampproject/amphtml/issues/5334 for more details.

viewport./*OK*/scrollIntoView(elem);

timerFor(win).delay(() => viewport./*OK*/scrollIntoView(

dev().assertElement(elem)), 1);

} else {

dev().warn('HTML',

`failed to find element with id=${hash} or a[name=${hash}]`);

}

if (tgtLoc.hash != curLoc.hash) {

// Push/pop history.

history.push(() => {

win.location.replace(`${curLoc.hash || '#'}`);

});

}

}