forked from ampproject/amphtml
-
Notifications
You must be signed in to change notification settings - Fork 0
/
custom-element.js
1915 lines (1756 loc) · 60.7 KB
/
custom-element.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
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 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 {CommonSignals} from './common-signals';
import {Layout, getLayoutClass, getLengthNumeral, getLengthUnits,
isInternalElement, isLayoutSizeDefined, isLoadingAllowed,
parseLayout, parseLength, getNaturalDimensions,
hasNaturalDimensions} from './layout';
import {ElementStub, stubbedElements} from './element-stub';
import {Signals} from './utils/signals';
import {createLoaderElement} from '../src/loader';
import {dev, rethrowAsync, user} from './log';
import {documentStateFor} from './service/document-state';
import {
getIntersectionChangeEntry,
} from '../src/intersection-observer-polyfill';
import {getMode} from './mode';
import {parseSizeList} from './size-list';
import {reportError} from './error';
import {
ampdocServiceFor,
resourcesForDoc,
performanceForOrNull,
timerFor,
vsyncFor,
} from './services';
import * as dom from './dom';
import {setStyle, setStyles} from './style';
import {LayoutDelayMeter} from './layout-delay-meter';
import {ResourceState} from './service/resource';
import {AmpEvents} from './amp-events';
const TAG_ = 'CustomElement';
/**
* This is the minimum width of the element needed to trigger `loading`
* animation. This value is justified as about 1/3 of a smallish mobile
* device viewport. Trying to put a loading indicator into a small element
* is meaningless.
* @private @const {number}
*/
const MIN_WIDTH_FOR_LOADING_ = 100;
/**
* The elements positioned ahead of this threshold may have their loading
* indicator initialized faster. This is benefitial to avoid relayout during
* render phase or scrolling.
* @private @const {number}
*/
const PREPARE_LOADING_THRESHOLD_ = 1000;
/**
* @enum {number}
*/
const UpgradeState = {
NOT_UPGRADED: 1,
UPGRADED: 2,
UPGRADE_FAILED: 3,
UPGRADE_IN_PROGRESS: 4,
};
/**
* Caches whether the template tag is supported to avoid memory allocations.
* @type {boolean|undefined}
*/
let templateTagSupported;
/**
* Whether this platform supports template tags.
* @return {boolean}
*/
function isTemplateTagSupported() {
if (templateTagSupported === undefined) {
const template = self.document.createElement('template');
templateTagSupported = 'content' in template;
}
return templateTagSupported;
}
/**
* @param {!Window} win
* @return {!Object<string, function(new:./base-element.BaseElement, !Element)>}
*/
function getExtendedElements(win) {
if (!win.ampExtendedElements) {
win.ampExtendedElements = {};
}
return win.ampExtendedElements;
}
/**
* Registers an element. Upgrades it if has previously been stubbed.
* @param {!Window} win
* @param {string} name
* @param {function(new:./base-element.BaseElement, !Element)} toClass
*/
export function upgradeOrRegisterElement(win, name, toClass) {
const knownElements = getExtendedElements(win);
if (!knownElements[name]) {
registerElement(win, name, /** @type {!Function} */ (toClass));
return;
}
user().assert(knownElements[name] == ElementStub,
'%s is already registered. The script tag for ' +
'%s is likely included twice in the page.', name, name);
knownElements[name] = toClass;
for (let i = 0; i < stubbedElements.length; i++) {
const stub = stubbedElements[i];
// There are 3 possible states here:
// 1. We never made the stub because the extended impl. loaded first.
// In that case the element won't be in the array.
// 2. We made a stub but the browser didn't attach it yet. In
// that case we don't need to upgrade but simply switch to the new
// implementation.
// 3. A stub was attached. We upgrade which means we replay the
// implementation.
const element = stub.element;
if (element.tagName.toLowerCase() == name &&
element.ownerDocument.defaultView == win) {
tryUpgradeElementNoInline(element, toClass);
// Remove element from array.
stubbedElements.splice(i--, 1);
}
}
}
/**
* This method should not be inlined to prevent TryCatch deoptimization.
* NoInline keyword at the end of function name also prevents Closure compiler
* from inlining the function.
* @private
*/
function tryUpgradeElementNoInline(element, toClass) {
try {
element.upgrade(toClass);
} catch (e) {
reportError(e, element);
}
}
/**
* Stub extended elements missing an implementation.
* @param {!Window} win
*/
export function stubElements(win) {
const knownElements = getExtendedElements(win);
const list = win.document.head.querySelectorAll('script[custom-element]');
for (let i = 0; i < list.length; i++) {
const name = list[i].getAttribute('custom-element');
if (knownElements[name]) {
continue;
}
registerElement(win, name, ElementStub);
}
// Repeat stubbing when HEAD is complete.
if (!win.document.body) {
const docState = documentStateFor(win);
docState.onBodyAvailable(() => stubElements(win));
}
}
/**
* Stub element if not yet known.
* @param {!Window} win
* @param {string} name
*/
export function stubElementIfNotKnown(win, name) {
const knownElements = getExtendedElements(win);
if (!knownElements[name]) {
registerElement(win, name, ElementStub);
}
}
/**
* Stub element in the child window.
* @param {!Window} childWin
* @param {string} name
*/
export function stubElementInChildWindow(childWin, name) {
registerElement(childWin, name, ElementStub);
}
/**
* Copies the specified element to child window (friendly iframe). This way
* all implementations of the AMP elements are shared between all friendly
* frames.
* @param {!Window} parentWin
* @param {!Window} childWin
* @param {string} name
*/
export function copyElementToChildWindow(parentWin, childWin, name) {
const toClass = getExtendedElements(parentWin)[name];
registerElement(childWin, name, toClass || ElementStub);
}
/**
* Upgrade element in the child window.
* @param {!Window} parentWin
* @param {!Window} childWin
* @param {string} name
*/
export function upgradeElementInChildWindow(parentWin, childWin, name) {
const toClass = getExtendedElements(parentWin)[name];
// Some extensions unofficially register unstubbed elements, e.g. amp-bind.
// Can be changed to assert() once official support (#9143) is implemented.
if (!toClass) {
dev().warn(TAG_, '%s is not stubbed yet', name);
}
dev().assert(toClass != ElementStub, '%s is not upgraded yet', name);
upgradeOrRegisterElement(childWin, name, toClass);
}
/**
* Applies layout to the element. Visible for testing only.
*
* \ \ / \ / / / \ | _ \ | \ | | | | | \ | | / _____|
* \ \/ \/ / / ^ \ | |_) | | \| | | | | \| | | | __
* \ / / /_\ \ | / | . ` | | | | . ` | | | |_ |
* \ /\ / / _____ \ | |\ \----.| |\ | | | | |\ | | |__| |
* \__/ \__/ /__/ \__\ | _| `._____||__| \__| |__| |__| \__| \______|
*
* The equivalent of this method is used for server-side rendering (SSR) and
* any changes made to it must be made in coordination with caches that
* implement SSR. For more information on SSR see bit.ly/amp-ssr.
*
* @param {!Element} element
* @return {!Layout}
*/
export function applyLayout_(element) {
// Check if the layout has already been done by server-side rendering. The
// document may be visible to the user if the boilerplate was removed so
// please take care in making changes here.
const completedLayoutAttr = element.getAttribute('i-amphtml-layout');
if (completedLayoutAttr) {
const layout = /** @type {!Layout} */ (dev().assert(
parseLayout(completedLayoutAttr)));
if (layout == Layout.RESPONSIVE && element.firstElementChild) {
// Find sizer, but assume that it might not have been parsed yet.
element.sizerElement_ =
element.querySelector('i-amphtml-sizer') || undefined;
} else if (layout == Layout.NODISPLAY) {
applyNoDisplayLayout_(element);
}
return layout;
}
// If the layout was already done by server-side rendering (SSR), then the code
// below will not run. Any changes below will necessitate a change to SSR and must
// be coordinated with caches that implement SSR. See bit.ly/amp-ssr.
// Parse layout from the element.
const layoutAttr = element.getAttribute('layout');
const widthAttr = element.getAttribute('width');
const heightAttr = element.getAttribute('height');
const sizesAttr = element.getAttribute('sizes');
const heightsAttr = element.getAttribute('heights');
// Input layout attributes.
const inputLayout = layoutAttr ? parseLayout(layoutAttr) : null;
user().assert(inputLayout !== undefined, 'Unknown layout: %s', layoutAttr);
const inputWidth = (widthAttr && widthAttr != 'auto') ?
parseLength(widthAttr) : widthAttr;
user().assert(inputWidth !== undefined, 'Invalid width value: %s', widthAttr);
const inputHeight = heightAttr ? parseLength(heightAttr) : null;
user().assert(inputHeight !== undefined, 'Invalid height value: %s',
heightAttr);
// Effective layout attributes. These are effectively constants.
let width;
let height;
let layout;
// Calculate effective width and height.
if ((!inputLayout || inputLayout == Layout.FIXED ||
inputLayout == Layout.FIXED_HEIGHT) &&
(!inputWidth || !inputHeight) && hasNaturalDimensions(element.tagName)) {
// Default width and height: handle elements that do not specify a
// width/height and are defined to have natural browser dimensions.
const dimensions = getNaturalDimensions(element);
width = (inputWidth || inputLayout == Layout.FIXED_HEIGHT) ? inputWidth :
dimensions.width;
height = inputHeight || dimensions.height;
} else {
width = inputWidth;
height = inputHeight;
}
// Calculate effective layout.
if (inputLayout) {
layout = inputLayout;
} else if (!width && !height) {
layout = Layout.CONTAINER;
} else if (height && (!width || width == 'auto')) {
layout = Layout.FIXED_HEIGHT;
} else if (height && width && (sizesAttr || heightsAttr)) {
layout = Layout.RESPONSIVE;
} else {
layout = Layout.FIXED;
}
// Verify layout attributes.
if (layout == Layout.FIXED || layout == Layout.FIXED_HEIGHT ||
layout == Layout.RESPONSIVE) {
user().assert(height, 'Expected height to be available: %s', heightAttr);
}
if (layout == Layout.FIXED_HEIGHT) {
user().assert(!width || width == 'auto',
'Expected width to be either absent or equal "auto" ' +
'for fixed-height layout: %s', widthAttr);
}
if (layout == Layout.FIXED || layout == Layout.RESPONSIVE) {
user().assert(width && width != 'auto',
'Expected width to be available and not equal to "auto": %s',
widthAttr);
}
if (layout == Layout.RESPONSIVE) {
user().assert(getLengthUnits(width) == getLengthUnits(height),
'Length units should be the same for width and height: %s, %s',
widthAttr, heightAttr);
} else {
user().assert(heightsAttr === null,
'Unexpected "heights" attribute for none-responsive layout');
}
// Apply UI.
element.classList.add(getLayoutClass(layout));
if (isLayoutSizeDefined(layout)) {
element.classList.add('i-amphtml-layout-size-defined');
}
if (layout == Layout.NODISPLAY) {
// CSS defines layout=nodisplay automatically with `display:none`. Thus
// no additional styling is needed.
applyNoDisplayLayout_(element);
} else if (layout == Layout.FIXED) {
setStyles(element, {
width: dev().assertString(width),
height: dev().assertString(height),
});
} else if (layout == Layout.FIXED_HEIGHT) {
setStyle(element, 'height', dev().assertString(height));
} else if (layout == Layout.RESPONSIVE) {
const sizer = element.ownerDocument.createElement('i-amphtml-sizer');
setStyles(sizer, {
display: 'block',
paddingTop:
((getLengthNumeral(height) / getLengthNumeral(width)) * 100) + '%',
});
element.insertBefore(sizer, element.firstChild);
element.sizerElement_ = sizer;
} else if (layout == Layout.FILL) {
// Do nothing.
} else if (layout == Layout.CONTAINER) {
// Do nothing. Elements themselves will check whether the supplied
// layout value is acceptable. In particular container is only OK
// sometimes.
} else if (layout == Layout.FLEX_ITEM) {
// Set height and width to a flex item if they exist.
// The size set to a flex item could be overridden by `display: flex` later.
if (width) {
setStyle(element, 'width', width);
}
if (height) {
setStyle(element, 'height', height);
}
}
return layout;
}
/**
* @param {!Element} element
*/
function applyNoDisplayLayout_(element) {
// TODO(dvoytenko, #9353): once `toggleLayoutDisplay` API has been deployed
// everywhere, switch all relevant elements to this API. In the meantime,
// simply unblock display toggling via `style="display: ..."`.
setStyle(element, 'display', 'none');
element.classList.add('i-amphtml-display');
}
/**
* Returns "true" for internal AMP nodes or for placeholder elements.
* @param {!Node} node
* @return {boolean}
*/
function isInternalOrServiceNode(node) {
if (isInternalElement(node)) {
return true;
}
if (node.tagName && (node.hasAttribute('placeholder') ||
node.hasAttribute('fallback') ||
node.hasAttribute('overflow'))) {
return true;
}
return false;
}
/**
* Creates a new custom element class prototype.
*
* Visible for testing only.
*
* @param {!Window} win The window in which to register the custom element.
* @param {string} name The name of the custom element.
* @param {function(new:./base-element.BaseElement, !Element)=} opt_implementationClass For
* testing only.
* @return {!Object} Prototype of element.
*/
export function createAmpElementProto(win, name, opt_implementationClass) {
const ElementProto = createCustomElementClass(win, name).prototype;
if (getMode().test && opt_implementationClass) {
ElementProto.implementationClassForTesting = opt_implementationClass;
}
return ElementProto;
}
/**
* Creates a named custom element class.
*
* @param {!Window} win The window in which to register the custom element.
* @param {string} name The name of the custom element.
* @return {!Function} The custom element class.
*/
function createCustomElementClass(win, name) {
const baseCustomElement = createBaseCustomElementClass(win);
/** @extends {HTMLElement} */
class CustomAmpElement extends baseCustomElement {
/**
* @see https://github.com/WebReflection/document-register-element#v1-caveat
*/
constructor(self) {
return super(self);
}
elementName() {
return name;
}
}
return CustomAmpElement;
}
/**
* Creates a base custom element class.
*
* @param {!Window} win The window in which to register the custom element.
* @return {!Function}
*/
function createBaseCustomElementClass(win) {
if (win.BaseCustomElementClass) {
return win.BaseCustomElementClass;
}
const htmlElement = win.HTMLElement;
/** @abstract @extends {HTMLElement} */
class BaseCustomElement extends htmlElement {
/**
* @see https://github.com/WebReflection/document-register-element#v1-caveat
* @suppress {checkTypes}
*/
constructor(self) {
self = super(self);
self.createdCallback();
return self;
}
/**
* Called when elements is created. Sets instance vars since there is no
* constructor.
* @final @this {!Element}
*/
createdCallback() {
// Flag "notbuilt" is removed by Resource manager when the resource is
// considered to be built. See "setBuilt" method.
/** @private {boolean} */
this.built_ = false;
/** @type {string} */
this.readyState = 'loading';
/** @type {boolean} */
this.everAttached = false;
/**
* Ampdoc can only be looked up when an element is attached.
* @private {?./service/ampdoc-impl.AmpDoc}
*/
this.ampdoc_ = null;
/**
* Resources can only be looked up when an element is attached.
* @private {?./service/resources-impl.Resources}
*/
this.resources_ = null;
/** @private {!Layout} */
this.layout_ = Layout.NODISPLAY;
/** @private {number} */
this.layoutWidth_ = -1;
/** @private {number} */
this.layoutCount_ = 0;
/** @private {boolean} */
this.isFirstLayoutCompleted_ = false;
/** @private {boolean} */
this.isInViewport_ = false;
/** @private {string|null|undefined} */
this.mediaQuery_ = undefined;
/** @private {!./size-list.SizeList|null|undefined} */
this.sizeList_ = undefined;
/** @private {!./size-list.SizeList|null|undefined} */
this.heightsList_ = undefined;
/**
* This element can be assigned by the {@link applyLayout_} to a child
* element that will be used to size this element.
* @private {?Element|undefined}
*/
this.sizerElement_ = undefined;
/** @private {boolean|undefined} */
this.loadingDisabled_ = undefined;
/** @private {boolean|undefined} */
this.loadingState_ = undefined;
/** @private {?Element} */
this.loadingContainer_ = null;
/** @private {?Element} */
this.loadingElement_ = null;
/** @private {?Element|undefined} */
this.overflowElement_ = undefined;
// `opt_implementationClass` is only used for tests.
const knownElements = getExtendedElements(win);
let Ctor = knownElements[this.elementName()];
if (getMode().test && this.implementationClassForTesting) {
Ctor = this.implementationClassForTesting;
}
/** @private {!./base-element.BaseElement} */
this.implementation_ = new Ctor(this);
/**
* An element always starts in a unupgraded state until it's added to DOM
* for the first time in which case it can be upgraded immediately or wait
* for script download or `upgradeCallback`.
* @private {!UpgradeState}
*/
this.upgradeState_ = UpgradeState.NOT_UPGRADED;
/**
* Action queue is initially created and kept around until the element
* is ready to send actions directly to the implementation.
* - undefined initially
* - array if used
* - null after unspun
* @private {?Array<!./service/action-impl.ActionInvocation>|undefined}
*/
this.actionQueue_ = undefined;
/**
* Whether the element is in the template.
* @private {boolean|undefined}
*/
this.isInTemplate_ = undefined;
/** @private @const */
this.signals_ = new Signals();
const perf = performanceForOrNull(win);
/** @private {boolean} */
this.perfOn_ = perf && perf.isPerformanceTrackingOn();
/** @private {?./layout-delay-meter.LayoutDelayMeter} */
this.layoutDelayMeter_ = null;
if (this[dom.UPGRADE_TO_CUSTOMELEMENT_RESOLVER]) {
this[dom.UPGRADE_TO_CUSTOMELEMENT_RESOLVER](this);
delete this[dom.UPGRADE_TO_CUSTOMELEMENT_RESOLVER];
delete this[dom.UPGRADE_TO_CUSTOMELEMENT_PROMISE];
}
}
/**
* The name of the custom element.
* @abstract
* @return {string}
*/
elementName() {
}
/** @return {!Signals} */
signals() {
return this.signals_;
}
/**
* Returns the associated ampdoc. Only available after attachment. It throws
* exception before the element is attached.
* @return {!./service/ampdoc-impl.AmpDoc}
* @final @this {!Element}
* @package
*/
getAmpDoc() {
return /** @type {!./service/ampdoc-impl.AmpDoc} */ (
dev().assert(this.ampdoc_,
'no ampdoc yet, since element is not attached'));
}
/**
* Returns Resources manager. Only available after attachment. It throws
* exception before the element is attached.
* @return {!./service/resources-impl.Resources}
* @final @this {!Element}
* @package
*/
getResources() {
return /** @type {!./service/resources-impl.Resources} */ (
dev().assert(this.resources_,
'no resources yet, since element is not attached'));
}
/**
* Whether the element has been upgraded yet. Always returns false when
* the element has not yet been added to DOM. After the element has been
* added to DOM, the value depends on the `BaseElement` implementation and
* its `upgradeElement` callback.
* @return {boolean}
* @final @this {!Element}
*/
isUpgraded() {
return this.upgradeState_ == UpgradeState.UPGRADED;
}
/**
* Upgrades the element to the provided new implementation. If element
* has already been attached, it's layout validation and attachment flows
* are repeated for the new implementation.
* @param {function(new:./base-element.BaseElement, !Element)} newImplClass
* @final @package @this {!Element}
*/
upgrade(newImplClass) {
if (this.isInTemplate_) {
return;
}
if (this.upgradeState_ != UpgradeState.NOT_UPGRADED) {
// Already upgraded or in progress or failed.
return;
}
this.implementation_ = new newImplClass(this);
if (this.everAttached) {
// Usually, we do an implementation upgrade when the element is
// attached to the DOM. But, if it hadn't yet upgraded from
// ElementStub, we couldn't. Now that it's upgraded from a stub, go
// ahead and do the full upgrade.
this.tryUpgrade_();
}
}
/**
* Completes the upgrade of the element with the provided implementation.
* @param {!./base-element.BaseElement} newImpl
* @final @private @this {!Element}
*/
completeUpgrade_(newImpl) {
this.upgradeState_ = UpgradeState.UPGRADED;
this.implementation_ = newImpl;
this.classList.remove('amp-unresolved');
this.classList.remove('i-amphtml-unresolved');
this.implementation_.createdCallback();
this.assertLayout_();
this.implementation_.layout_ = this.layout_;
this.implementation_.layoutWidth_ = this.layoutWidth_;
this.implementation_.firstAttachedCallback();
this.dispatchCustomEventForTesting(AmpEvents.ATTACHED);
this.getResources().upgraded(this);
}
/* @private */
assertLayout_() {
if (this.layout_ != Layout.NODISPLAY &&
!this.implementation_.isLayoutSupported(this.layout_)) {
let error = 'Layout not supported: ' + this.layout_;
if (!this.getAttribute('layout')) {
error += '. The element did not specify a layout attribute. ' +
'Check https://www.ampproject.org/docs/guides/' +
'responsive/control_layout and the respective element ' +
'documentation for details.';
}
throw user().createError(error);
}
}
/**
* Whether the element has been built. A built element had its
* {@link buildCallback} method successfully invoked.
* @return {boolean}
* @final @this {!Element}
*/
isBuilt() {
return this.built_;
}
/**
* Returns the promise that's resolved when the element has been built. If
* the build fails, the resulting promise is rejected.
* @return {!Promise}
*/
whenBuilt() {
return this.signals_.whenSignal(CommonSignals.BUILT);
}
/**
* Get the priority to load the element.
* @return {number} @this {!Element}
*/
getPriority() {
dev().assert(
this.isUpgraded(), 'Cannot get priority of unupgraded element');
return this.implementation_.getPriority();
}
/**
* Requests or requires the element to be built. The build is done by
* invoking {@link BaseElement.buildCallback} method.
*
* This method can only be called on a upgraded element.
*
* @final @this {!Element}
*/
build() {
assertNotTemplate(this);
if (this.isBuilt()) {
return;
}
dev().assert(this.isUpgraded(), 'Cannot build unupgraded element');
try {
this.implementation_.buildCallback();
this.preconnect(/* onLayout */false);
this.built_ = true;
this.classList.remove('i-amphtml-notbuilt');
this.classList.remove('amp-notbuilt');
this.signals_.signal(CommonSignals.BUILT);
} catch (e) {
this.signals_.rejectSignal(CommonSignals.BUILT, e);
reportError(e, this);
throw e;
}
if (this.built_ && this.isInViewport_) {
this.updateInViewport_(true);
}
if (this.actionQueue_) {
// Only schedule when the queue is not empty, which should be
// the case 99% of the time.
timerFor(this.ownerDocument.defaultView)
.delay(this.dequeueActions_.bind(this), 1);
}
if (!this.getPlaceholder()) {
const placeholder = this.createPlaceholder();
if (placeholder) {
this.appendChild(placeholder);
}
}
}
/**
* Called to instruct the element to preconnect to hosts it uses during
* layout.
* @param {boolean} onLayout Whether this was called after a layout.
* @this {!Element}
*/
preconnect(onLayout) {
if (onLayout) {
this.implementation_.preconnectCallback(onLayout);
} else {
// If we do early preconnects we delay them a bit. This is kind of
// an unfortunate trade off, but it seems faster, because the DOM
// operations themselves are not free and might delay
timerFor(this.ownerDocument.defaultView).delay(() => {
this.implementation_.preconnectCallback(onLayout);
}, 1);
}
}
/**
* Whether the custom element declares that it has to be fixed.
* @return {boolean}
* @this {!Element}
*/
isAlwaysFixed() {
return this.implementation_.isAlwaysFixed();
}
/**
* Updates the layout box of the element.
* See {@link BaseElement.getLayoutWidth} for details.
* @param {!./layout-rect.LayoutRectDef} layoutBox
* @this {!Element}
*/
updateLayoutBox(layoutBox) {
this.layoutWidth_ = layoutBox.width;
if (this.isUpgraded()) {
this.implementation_.layoutWidth_ = this.layoutWidth_;
}
if (this.isBuilt()) {
try {
this.implementation_.onLayoutMeasure();
} catch (e) {
reportError(e, this);
}
}
if (this.isLoadingEnabled_()) {
if (this.isInViewport_) {
// Already in viewport - start showing loading.
this.toggleLoading_(true);
} else if (layoutBox.top < PREPARE_LOADING_THRESHOLD_ &&
layoutBox.top >= 0) {
// Few top elements will also be pre-initialized with a loading
// element.
getVsync(this).mutate(() => {
// Repeat "loading enabled" check because it could have changed while
// waiting for vsync.
if (this.isLoadingEnabled_()) {
this.prepareLoading_();
}
});
}
}
}
/**
* @return {?Element}
* @private
*/
getSizer_() {
if (this.sizerElement_ === undefined &&
this.layout_ === Layout.RESPONSIVE) {
// Expect sizer to exist, just not yet discovered.
this.sizerElement_ = this.querySelector('i-amphtml-sizer');
}
return this.sizerElement_ || null;
}
/**
* If the element has a media attribute, evaluates the value as a media
* query and based on the result adds or removes the class
* `i-amphtml-hidden-by-media-query`. The class adds display:none to the element
* which in turn prevents any of the resource loading to happen for the
* element.
*
* This method is called by Resources and shouldn't be called by anyone else.
*
* @final
* @package @this {!Element}
*/
applySizesAndMediaQuery() {
assertNotTemplate(this);
// Media query.
if (this.mediaQuery_ === undefined) {
this.mediaQuery_ = this.getAttribute('media') || null;
}
if (this.mediaQuery_) {
const defaultView = this.ownerDocument.defaultView;
this.classList.toggle('i-amphtml-hidden-by-media-query',
!defaultView.matchMedia(this.mediaQuery_).matches);
}
// Sizes.
if (this.sizeList_ === undefined) {
const sizesAttr = this.getAttribute('sizes');
this.sizeList_ = sizesAttr ? parseSizeList(sizesAttr) : null;
}
if (this.sizeList_) {
setStyle(this, 'width', this.sizeList_.select(
this.ownerDocument.defaultView));
}
// Heights.
if (this.heightsList_ === undefined &&
this.layout_ === Layout.RESPONSIVE) {
const heightsAttr = this.getAttribute('heights');
this.heightsList_ = heightsAttr ?
parseSizeList(heightsAttr, /* allowPercent */ true) : null;
}
if (this.heightsList_) {
const sizer = this.getSizer_();
if (sizer) {
setStyle(sizer, 'paddingTop',
this.heightsList_.select(this.ownerDocument.defaultView));
}
}
}
/**
* Changes the size of the element.
*
* This method is called by Resources and shouldn't be called by anyone else.
* This method must always be called in the mutation context.
*
* @param {number|undefined} newHeight
* @param {number|undefined} newWidth
* @param {!./layout-rect.LayoutMarginsDef=} opt_newMargins
* @final
* @package @this {!Element}
*/
changeSize(newHeight, newWidth, opt_newMargins) {
const sizer = this.getSizer_();
if (sizer) {
// From the moment height is changed the element becomes fully
// responsible for managing its height. Aspect ratio is no longer
// preserved.
this.sizerElement_ = null;
setStyle(sizer, 'paddingTop', '0');
if (this.resources_) {
this.resources_.deferMutate(this, () => {
dom.removeElement(sizer);
});
}
}
if (newHeight !== undefined) {
setStyle(this, 'height', newHeight, 'px');
}
if (newWidth !== undefined) {
setStyle(this, 'width', newWidth, 'px');
}
if (opt_newMargins) {
if (opt_newMargins.top != null) {
setStyle(this, 'marginTop', opt_newMargins.top, 'px');
}
if (opt_newMargins.right != null) {
setStyle(this, 'marginRight', opt_newMargins.right, 'px');
}
if (opt_newMargins.bottom != null) {
setStyle(this, 'marginBottom', opt_newMargins.bottom, 'px');
}
if (opt_newMargins.left != null) {
setStyle(this, 'marginLeft', opt_newMargins.left, 'px');
}
}
if (this.isAwaitingSize_()) {
this.sizeProvided_();
}
}
/**
* Called when the element is first connected to the DOM. Calls
* {@link firstAttachedCallback} if this is the first attachment.
* @final @this {!Element}
*/
connectedCallback() {
if (!this.everAttached) {
this.classList.add('i-amphtml-element');
this.classList.add('i-amphtml-notbuilt');
this.classList.add('amp-notbuilt');
}
if (!isTemplateTagSupported() && this.isInTemplate_ === undefined) {
this.isInTemplate_ = !!dom.closestByTag(this, 'template');
}
if (this.isInTemplate_) {
return;
}
if (!this.ampdoc_) {
// Ampdoc can now be initialized.
const ampdocService = ampdocServiceFor(this.ownerDocument.defaultView);
this.ampdoc_ = ampdocService.getAmpDoc(this);
}
if (!this.resources_) {
// Resources can now be initialized since the ampdoc is now available.
this.resources_ = resourcesForDoc(this.ampdoc_);
}
this.getResources().add(this);
if (this.everAttached) {