-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathindex.bs
4679 lines (3221 loc) · 166 KB
/
index.bs
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
<pre class="metadata">
Title: Controlled Frame API
Abstract: This document defines an API for embedding arbitrary web content only
within the context of an Isolated Web Application (IWA). The embedded
content is a new top-level browsing context within and controlled by the
embedder.
Repository: WICG/controlled-frame
URL: https://wicg.github.io/controlled-frame/
Status: w3c/CG-DRAFT
Shortname: controlled-frame
Level: 1
Editor: Chase Phillips 115880, Google LLC https://google.com, [email protected]
Editor: Robbie McElrath 139758, Google LLC https://google.com, [email protected]
Editor: Zelin Liu 164998, Google LLC https://google.com, [email protected]
Group: WICG
Markup Shorthands: markdown yes
</pre>
<style>
.domintro::before {
content: 'For web developers (non-normative)';
text-transform: initial;
}
.domintro dt {
font-family: Menlo, Consolas, "DejaVu Sans Mono", Monaco, monospace;
padding-top: 0.5em;
padding-bottom: 1em;
}
.domintro dt a {
color: inherit; border-bottom-style: none;
}
.domintro dt code {
font-size: inherit;
}
/* Put nice boxes around each algorithm. */
[data-algorithm]:not(.heading) {
padding: .5em;
border: thin solid #ddd; border-radius: .5em;
margin: .5em calc(-0.5em - 1px);
}
[data-algorithm]:not(.heading) > :first-child {
margin-top: 0;
}
[data-algorithm]:not(.heading) > :last-child {
margin-bottom: 0;
}
[data-algorithm] [data-algorithm] {
margin: 1em 0;
}
table {
border-collapse: collapse;
width: 100%;
}
th, td {
border: 1px solid black;
padding: 2px 8px;
text-align: center;
vertical-align: middle;
}
/* .XXX from https://resources.whatwg.org/standard.css */
.XXX {
color: #D50606;
background: white;
border: solid #D50606;
}
</style>
<pre class="biblio">
{
"HTTP-CACHING": {
"aliasOf": "RFC9111"
},
"isolated-web-apps": {
"authors": [
"Reilly Grant"
],
"href": "https://github.com/WICG/isolated-web-apps/blob/main/README.md",
"title": "Isolated Web Apps Explainer"
},
"high-watermark-permissions": {
"authors": [
"Robbie McElrath"
],
"href": "https://github.com/WICG/isolated-web-apps/blob/main/Permissions.md",
"title": "Isolated Web Apps High Watermark Permissions Explainer"
}
}
</pre>
<pre class="anchors">
spec: console; urlPrefix: https://console.spec.whatwg.org/
type: dfn
urlPrefix: /
text: logger; for: /; url: logger
text: formatter; for: /; url: formatter
spec: html; urlPrefix: https://html.spec.whatwg.org/multipage/
type: dfn
urlPrefix: /
text: simple-dialogs; for: /; url: simple-dialogs
text: window open steps; for: /; url: window-open-steps
urlPrefix: browsing-the-web.html
text: apply the traverse history step; url: apply-the-traverse-history-step
text: document state; url: she-document-state
text: get all used history steps; url: getting-all-used-history-steps
text: reload; url: reload
text: navigable; for:navigation params; url: navigation-params-navigable
for: session history entry
text: step; url: she-step
text: URL; url: she-url
urlPrefix: document-lifecycle.html
text: completely loaded; url: completely-loaded
text: stop loading; url: nav-stop
text: completely finish loading; url: completely-finish-loading
urlPrefix: document-sequences.html
text: browsing context group; url: browsing-context-group
text: create a new browsing context and document; url: creating-a-new-browsing-context
text: creating a new auxiliary browsing context; url: creating-a-new-auxiliary-browsing-context
text: current session history entry; url: nav-current-history-entry
text: navigable; for: /; url: navigable
text: active WindowProxy; for: navigable; url: nav-wp
text: initialize the navigable; url: initialize-the-navigable
for: navigable
text: active session history entry; url: nav-active-history-entry
for: traversable navigable
text: session history entries; url: tn-session-history-entries
urlPrefix: dom.html
text: contexts in which this element can be used; url: concept-element-contexts
text: content model; url: concept-element-content-model
text: event; url: events
text: nothing; url: concept-content-nothing
text: content attributes; url: concept-element-attributes
text: global attributes; url: global-attributes
text: dom interface; url: concept-element-dom
text: represents; url: represents
text: accessibility considerations; url: concept-element-accessibility-considerations
text: update the current document readiness; url: update-the-current-document-readiness
urlPrefix: embedded-content.html
text: src; url: attr-source-src
urlPrefix: embedded-content-other.html
text: width; url: attr-dim-width
text: height; url: attr-dim-height
urlPrefix: indices.html
text: load; url: event-load
urlPrefix: links.html
text: href; url: attr-hyperlink-href
urlPrefix: nav-history-apis.html
text: navigable; for: window; url: window-navigable
urlPrefix: system-state.html
text: associated Navigator; url: associated-navigator
urlPrefix: timers-and-user-prompts.html
text: alert; url:dom-alert
text: confirm; url:dom-confirm
text: prompt; url:dom-prompt
urlPrefix: webappapis.html
text: create a classic script; url: creating-a-classic-script
text: default script fetch options; url: default-script-fetch-options
text: environment; url: environment
spec: fetch; urlPrefix: https://fetch.spec.whatwg.org/
type: dfn
urlPrefix: /
text: HTTP-network fetch; url: concept-http-network-fetch
text: HTTP-network-or-cache fetch; url: concept-http-network-or-cache-fetch
text: fetch response handover; url: fetch-finale
text: main fetch; url: main-fetch
text: request; for: fetch params; url: fetch-params-request
spec: infra; urlPrefix: https://infra.spec.whatwg.org
type: dfn
text: empty; for: map; url: map-is-empty
spec: storage; urlPrefix: https://storage.spec.whatwg.org
type: dfn
text: map; for: storage bottle; url: storage-bottle-map
text: proxy map reference set; for: storage bottle; url: storage-bottle-proxy-map-reference-set
text: storage bottle; url: storage-bottle
text: storage bucket; url: storage-bucket
text: storage identifier; url: storage-identifier
text: storage shed; url: storage-shed
text: storage shelf; url: storage-shelf
spec: webidl; urlPrefix: https://webidl.spec.whatwg.org
type: dfn
text: Web IDL Standard; url: introduction
text: async iterator; url: idl-async-iterable
text: promise; url: idl-promise
text: promise rejected; url: a-promise-rejected-with
text: promise resolved; url: a-promise-resolved-with
spec: uievents; urlPrefix: https://www.w3.org/TR/uievents/
type: dfn
text: contextmenu; url: event-type-contextmenu
text: click; url: event-type-click
spec: geolocation; urlPrefix: https://www.w3.org/TR/geolocation/
type: dfn
text: request a position; url: dfn-request-a-position
text: match pattern; type: dfn; url: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns;
</pre>
<pre class=link-defaults>
spec:fetch; type:dfn; for:/; text:header list
spec:fetch; type:dfn; for:/; text:request
spec:fetch; type:dfn; for:/; text:response
spec:html; type:dfn; for:/; text:browsing context
spec:html; type:dfn; for:/; text:global object
spec:html; type:dfn; for:/; text:top-level traversable
spec:html; type:dfn; for:/; text:traversable navigable
spec:html; type:event; text:readystatechange
spec:infra; type:dfn; for:/; text:set
spec:infra; type:dfn; text:list
spec:infra; type:dfn; text:byte sequence
spec:infra; type:dfn; text:user agent
spec:webidl; type:dfn; text:attribute
spec:webidl; type:interface; text:long
</pre>
<!-- ====================================================================== -->
# Introduction # {#introduction}
<!-- ====================================================================== -->
This specification describes a content embedding API that satisfies some
critical use cases for IWAs that <{iframe}> does not support. This embedding
environment should allow embedding all content without express permission from
the embedded site, including content which <{iframe}> cannot embed, and provide
embedding sites more control over that embedded content.
Since this is a particularly powerful API, its use and availability makes an app
a target of various types of hacking. As a result, this API is limited to use in
[[Isolated-Web-Apps|Isolated Web Applications]] (IWAs) which have addtional
safeguards in place to protect users and developers. IWAs are not a normal web
application and can exist only at a special 'isolated-app:' scheme. This means
by design that this API will not be available to normal web pages.
Note: This API is not intended to be a replacement or substitute for <{iframe}>.
All <{iframe}> use cases are still valid and should continue to use <{iframe}>,
including IWAs where possible.
<!-- ====================================================================== -->
<h2 id=based-on-fencedframe-spec>The Fenced Frame specification</h2>
<!-- ====================================================================== -->
For convenience, the Controlled Frame specification assumes that the Fenced
Frame specification is in place. There are concepts introduced in the Fenced
Frame specification, such as nested top-level traversables, that are broadly
useful to refer to in the context of Controlled Frame.
The Fenced Frame specification achieves defining these concepts via monkey
patching some specifications, such as HTML. We will also require monkey
patching specifications for some parts of this Controlled Frame specification.
<!-- ====================================================================== -->
<h2 id=the-controlledframe-element>The <dfn element export>controlledframe</dfn> element</h2>
<!-- ====================================================================== -->
<dl class="element">
<dt>[=Categories=]:</dt>
<dd>[=Flow content=].</dd>
<dd>[=Phrasing content=].</dd>
<dd>[=Embedded content=].</dd>
<dd>[=Interactive content=].</dd>
<dd>[=Palpable content=].</dd>
<dt>[=Contexts in which this element can be used=]:</dt>
<dd>Where [=embedded content=] is expected.</dd>
<dt>[=Content model=]:</dt>
<dd>[=Nothing=].</dd>
<dt>[=Content attributes=]:</dt>
<dd>[=Global attributes=]</dd>
<dd><code>{{src}}</code> — Content source URL to embed</dd>
<dd><code>{{partition}}</code> — Partition name to hold data related to this content</dd>
<dt>[=Accessibility considerations=]:</dt>
<dd><p class=XXX>Screen readers should be able to traverse into
the embedded content similar to how a reader can traverse into iframes and
other related embedded content.</p></dd>
<dt>[=DOM interface=]:</dt>
<dd>
<xmp class=idl>
[Exposed=Window, IsolatedContext]
interface HTMLControlledFrameElement : HTMLElement {
[HTMLConstructor] constructor();
[CEReactions] attribute USVString src;
attribute DOMString partition;
readonly attribute WindowProxy? contentWindow;
readonly attribute ContextMenus contextMenus;
readonly attribute WebRequest request;
// Navigation methods.
Promise<undefined> back();
boolean canGoBack();
boolean canGoForward();
Promise<undefined> forward();
Promise<undefined> go(long relativeIndex);
undefined reload();
undefined stop();
// Scripting methods.
Promise<undefined> addContentScripts(sequence<ContentScriptDetails> contentScriptList);
Promise<any> executeScript(optional InjectDetails details = {});
Promise<undefined> insertCSS(optional InjectDetails details = {});
Promise<undefined> removeContentScripts(sequence<DOMString>? scriptNameList);
// Configuration methods.
Promise<undefined> clearData(
optional ClearDataOptions options = {},
optional ClearDataTypeSet types = {});
Promise<boolean> getAudioState();
Promise<long> getZoom();
Promise<DOMString> getZoomMode();
Promise<boolean> isAudioMuted();
undefined setAudioMuted(boolean mute);
Promise<undefined> setZoom(long zoomFactor);
Promise<undefined> setZoomMode(DOMString zoomMode);
// Capture methods.
Promise<undefined> captureVisibleRegion(optional ImageDetails options = {});
undefined print();
// Events:
attribute EventHandler onconsolemessage;
attribute EventHandler oncontentload;
attribute EventHandler ondialog;
attribute EventHandler onloadabort;
attribute EventHandler onloadcommit;
attribute EventHandler onloadstart;
attribute EventHandler onloadstop;
attribute EventHandler onnewwindow;
attribute EventHandler onpermissionrequest;
attribute EventHandler onsizechanged;
attribute EventHandler onzoomchange;
};
</xmp>
</dd>
</dl>
The <{controlledframe}> element [=represents=] its [=embedded navigable=].
Descendents of <{controlledframe}> elements represent nothing.
The Controlled Frame element is exposed to any {{Document}} with the
"`controlled-frame`" [=policy-controlled feature=] whose
[=environment settings object=] is an [=isolated context=].
The IDL attributes {{HTMLControlledFrameElement/src}} and
{{HTMLControlledFrameElement/partition}} must [=reflect=] the respective content
attributes of the same name.
Each <{controlledframe}> has an <dfn for=controlledframe>embedded navigable</dfn>,
which is either a [=traversable navigable=] with a non-null [=embedderParent=],
or null. It is initially null.
Note: The [=embedded navigable=] appears as a top-level traversable with a
null [=navigable/parent=]. Content within the [=embedded navigable=] cannot
detect that it is embedded.
Each <{controlledframe}> has a <dfn for=controlledframe>content script map</dfn>,
which is a [=/map=] whose [=map/keys=] are [=strings=] and whose [=map/values=]
are [=content script config=]s.
<div algorithm=insertion>
When a <{controlledframe}> element |element| is [=inserted into a document=]
whose [=browsing context=] is non-null, run the following steps:
1. If |element|'s {{HTMLControlledFrameElement/src}} is not empty, then:
1. [=Initialize a controlledframe=] given |element|.
</div>
<div algorithm=destroy>
When a <{controlledframe}> element |element| is [=removed from a document=],
run the following steps:
1. TODO: destroy |element|'s [=embedded navigable=].
</div>
<div algorithm>
To <dfn>initialize a <{controlledframe}></dfn> element |element|, run the
following steps:
1. [=Assert=] that |element|'s [=embedded navigable=] is null.
1. Let |group| be a new [=browsing context group=].
1. Let |document| be the second return value of [=creating a new browsing
context and document=] given |element|'s [=node document=], |element|,
and |group|.
1. Let |documentState| be a new [=document state=], whose [=/document=]
is |document|.
1. Let |traversable| be a new [=traversable navigable=].
1. [=Initialize the navigable=] |traversable| given |documentState|.
1. Set |traversable|'s [=embedderParent=] to |element|.
1. Set |element|'s [=embedded navigable=] to |traversable|.
1. Let |initialHistoryEntry| be |traversable|'s [=navigable/active
session history entry=].
1. Set |initialHistoryEntry|'s [=session history entry/step=] to 0.
1. [=list/Append=] |initialHistoryEntry| to |traversable|'s [=traversable
navigable/session history entries=].
Issue: These steps are needed to initialize {{History}}.{{History/length}}
in the new navigable. This is an existing
<a href="https://github.com/whatwg/html/issues/9030">issue</a>
in the HTML Standard.
1. Set |element|'s {{HTMLControlledFrameElement/contentWindow}} to
|document|'s {{WindowProxy}}.
1. [=Navigate a controlledframe=] given |element| and |element|'s
{{HTMLControlledFrameElement/src}}.
</div>
<div algorithm>
To <dfn>navigate a <{controlledframe}></dfn> element |element| given a
{{USVString}} |urlString|, run the following steps:
1. If |urlString| is not an [=absolute-URL string=], return.
1. Let |url| be the result of running the [=URL parser=] given |urlString|.
1. Let |historyHandling| be "{{NavigationHistoryBehavior/auto}}".
1. If |element|'s [=embedded navigable=]'s [=active document=] is not
[=completely loaded=], then set |historyHandling| to
"{{NavigationHistoryBehavior/replace}}".
1. [=Navigate=] |element|'s [=embedded navigable=] to |url| using |element|'s
[=node document=], with a {{NavigationHistoryBehavior}} of |historyHandling|.
</div>
<div algorithm>
The <dfn constructor for=HTMLControlledFrameElement>HTMLControlledFrameElement()</dfn>
constructor steps are:
1. Let |webRequest| be [=this=]'s {{HTMLControlledFrameElement/request}}.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onBeforeRequest}}] to
`"beforeRequest"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onBeforeSendHeaders}}] to
`"beforeSendHeaders"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onSendHeaders}}] to
`"sendHeaders"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onHeadersReceived}}] to
`"headersReceived"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onAuthRequired}}] to
`"authRequired"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onBeforeRedirect}}] to
`"beforeRedirect"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onResponseStarted}}] to
`"responseStarted"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onCompleted}}] to
`"completed"` and |webRequest| respectively.
1. Set the [=WebRequestEvent/eventName=] and [=WebRequestEvent/webRequest=]
fields of |webRequest|[{{WebRequest/onErrorOccurred}}] to
`"errorOccurred"` and |webRequest| respectively.
</div>
<!-- ====================================================================== -->
## Attributes ## {#attributes}
<!-- ====================================================================== -->
The {{HTMLControlledFrameElement/partition}} attribute takes an identifier
specifying where data related to the Controlled Frame's instance should be
stored. The identifier is composed of a string of alphanumeric characters.
All data for the [=embedded navigable=] will be stored in a [=storage shelf=]
keyed by this partition string along with the origin that created the data.
By default, all data stored will be held in an in-memory storage partition so
that when the last Controlled Frame element with a given
{{HTMLControlledFrameElement/partition}} value is destroyed, the data is also
destroyed. While the data is held in this partition, no data from the
Controlled Frame's [=embedded navigable=] will persist.
If the partition attribute identifier contains the prefix "persist:", the user
agent will use a disk-based storage environment rather than an in-memory
storage partition. Embedded content should not be able to detect whether its
storage is in-memory or persistent.
If multiple Controlled Frames share the same partition identifier, all of their
[=embedded navigable=] instances will share the same storage partition.
Note: The [[STORAGE]] specification is monkey patched below to partition
storage based on the value of the {{HTMLControlledFrameElement/partition}}
attribute.
<div algorithm=partition-setter>
The {{HTMLControlledFrameElement/partition}} IDL attribute setter steps are:
1. If [=this=]'s [=embedded navigable=] is not null, then:
1. [=Throw=] a "{{NotSupportedError}}" {{DOMException}}.
1. Do not change the value of {{HTMLControlledFrameElement/partition}}.
</div>
The {{HTMLControlledFrameElement/src}} attribute reflects the Controlled
Frame's [=embedded navigable=]'s [=current session history entry=]'s
[=session history entry/URL=].
<div algorithm=src-setter>
The {{HTMLControlledFrameElement/src}} IDL attribute setter steps are:
1. If [=this=] is not [=in a document tree=], then return.
1. If [=this=]'s [=embedded navigable=] is null, then:
1. [=Initialize a controlledframe=] given [=this=].
1. Otherwise:
1. [=Navigate a controlledframe=] given [=this=] and [=this=]'s
{{HTMLControlledFrameElement/src}}.
</div>
<!-- ====================================================================== -->
## Navigation methods ## {#api-nav}
<!-- ====================================================================== -->
<div class="domintro note">
: {{HTMLControlledFrameElement/back()|back}}()
:: Goes back one step in the overall
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#tn-session-history-entries">
session history entries </a> list for the
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#traversable-navigable">
traversable navigable</a> in the Controlled Frame.
If there is no previous page, does nothing.
: {{HTMLControlledFrameElement/canGoBack()|canGoBack}}()
:: Returns true if the current
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#nav-current-history-entry">
current session history entry</a> is not the first one in the navigation
history entry list. This means that there is a previous
<a href="https://html.spec.whatwg.org/multipage/browsing-the-web.html#session-history-entry">
session history entry</a> for this
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#navigable">
navigable</a>.
: {{HTMLControlledFrameElement/forward()|forward}}()
:: Goes forward one step in the overall
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#tn-session-history-entries">
session history entries </a> list for the
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#traversable-navigable">
traversable navigable</a> in the Controlled Frame.
If there is no next page, does nothing.
: {{HTMLControlledFrameElement/go()|go}}()
:: Reloads the current page.
: {{HTMLControlledFrameElement/go()|go}}(<var>relativeIndex</var>)
:: Goes back or forward <var>relativeIndex</var> number of steps in the overall
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#tn-session-history-entries">
session history entries </a> list for the current
<a href="https://html.spec.whatwg.org/multipage/document-sequences.html#traversable-navigable">
traversable navigable</a>.
A zero relative index will reload the current page.
If the relative index is out of range, does nothing.
: {{HTMLControlledFrameElement/reload()|reload}}()
:: Reloads the current page.
: {{HTMLControlledFrameElement/stop()|stop}}()
:: Cancels the document load.
</div>
<div algorithm>
To <dfn>traverse an embedded navigable's history</dfn>, given a
<{controlledframe}> |controlledframe| and an integer |stepDelta|, run the
following steps:
1. Let |resultPromise| be a new [=promise=].
1. Return |resultPromise| and run the remaining steps [=in parallel=].
1. If |controlledframe|'s [=embedded navigable=] is null, then [=resolve=]
|resultPromise| with false.
1. Let |currentStep| be |controlledframe|'s [=embedded navigable=]'s
[=current session history step=].
1. Let |step| be the sum of |currentStep| and |stepDelta|.
1. If |step| is negative, then [=resolve=] |resultPromise| with false.
1. If |step| is greater than or equal to the [=list/size=] of the
|controlledframe|'s [=embedded navigable=]'s [=session history entries=],
then [=resolve=] |resultPromise| with false.
1. Let |result| be the result of [=applying the traverse history step=]
given |step|, |controlledframe|'s [=embedded navigable=], and a
[=user navigation involvement=] of "[=browser UI=]".
1. If |result| is not equal to "`applied`", [=resolve=] |resultPromise|
with false.
1. Otherwise, [=resolve=] |resultPromise| with true.
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>canGoBack()</dfn>
method steps are:
ISSUE: We can't actually synchronously access the embedded navigable's
history state. In the future we should update this method to return a
Promise.
1. If [=this=]'s [=embedded navigable=] is null, then return false.
1. If [=this=]'s [=embedded navigable=]'s [=current session history step=]
is greater than 0, return true.
1. Return false.
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>canGoForward()</dfn>
method steps are:
1. If [=this=]'s [=embedded navigable=] is null, then return false.
1. Let |step| be [=this=]'s [=embedded navigable=]'s [=current session
history step=].
1. Let |steps| be the result of [=getting all used history steps=]
given [=this=]'s [=embedded navigable=].
1. If |step|+1 is less than the [=list/size=] of |steps|, then return true.
1. Return false.
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>back()</dfn> method steps are:
1. Return the result of [=traversing an embedded navigable's history=] given
[=this=] and -1.
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>forward()</dfn> method steps
are:
1. Return the result of [=traversing an embedded navigable's history=] given
[=this=] and 1.
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>go(|relativeIndex|)</dfn>
method steps are:
1. Return the result of [=traversing an embedded navigable's history=] given
[=this=] and |relativeIndex|.
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>reload()</dfn> steps are:
1. If [=this=]'s [=embedded navigable=] is null, return.
1. [=Reload=] [=this=]'s [=embedded navigable=] given a [=user navigation
involvement=] of "[=browser UI=]".
</div>
<div algorithm>
The <dfn method for=HTMLControlledFrameElement>stop()</dfn> steps are:
1. If [=this=]'s [=embedded navigable=] is null, return.
1. [=Stop loading=] [=this=]'s [=embedded navigable=].
</div>
<!-- ====================================================================== -->
## Scripting methods ## {#api-scripting}
<!-- ====================================================================== -->
<xmp class="idl">
// One of |code| or |file| must be specified but not both.
dictionary InjectDetails {
DOMString code;
DOMString file;
};
dictionary InjectionItems {
DOMString code;
sequence<DOMString> files;
};
enum RunAt {
"document-start",
"document-end",
"document-idle",
};
dictionary ContentScriptDetails {
required DOMString name;
InjectionItems js;
InjectionItems css;
required sequence<DOMString> matches;
sequence<DOMString> excludeMatches;
boolean allFrames;
boolean matchAboutBlank;
RunAt runAt;
};
</xmp>
A <dfn>content script config</dfn> is a [=struct=] with the following
[=struct/items=]:
<dl export dfn-for="content script config">
: <dfn>pendingFetchCount</dfn>
:: a {{long}} representing the number of pending script/style fetches.
: <dfn>js</dfn>
:: a [=list=] of [=string=]s containing JavaScript that will be injected into
a document.
: <dfn>css</dfn>
:: a [=list=] of [=string=]s containing CSS that will be injected into a
document.
: <dfn>matches</dfn>
:: a [=list=] of [=string=]s containing patterns. Content will be injected
into pages whose [=Document/URL=] matches one of these patterns.
: <dfn>excludeMatches</dfn>
:: a [=list=] of [=string=]s containing patterns. Content will *not* be
injected into pages whose [=Document/URL=] matches one of these patterns.
: <dfn>allFrames</dfn>
:: a [=boolean=] indicating whether content should be injected into all
frames in a page, or just the top-level frame.
: <dfn>matchAboutBlank</dfn>
:: a [=boolean=] indicating whether content should be injected into
about:blank pages.
: <dfn>runAt</dfn>
:: a {{RunAt}} indicating when JavaScript content should be executed in a
document's lifecycle.
</dl>
<div algorithm>
To <dfn>fetch an injection item</dfn> given a <{controlledframe}>
|controlledframe|, a {{DOMString}} |urlString|, a [=boolean=] |isCss|, a
{{long}} |index|, and an algorithm |completionSteps|, run the following steps:
1. If |urlString| is not an [=valid URL string=], then:
1. Run |completionSteps| given 0 and false.
1. Return.
1. Let |request| be a new [=request=] with the following fields:
: [=request/URL=]
:: The result of running the [=URL parser=] given |urlString| and
|controlledframe|'s [=node document=]'s [=document base URL=]
: [=request/method=]
:: "`GET`"
: [=request/destination=]
:: "`style`" if |isCss| is true, "`script`" otherwise
: [=request/client=]
:: |controlledframe|'s [=node document=]'s [=relevant settings object=]
: [=request/mode=]
:: "`cors`"
1. [=Fetch=] |request|, with [=processResponseConsumeBody=] set to the
following steps given a [=/response=] |response| and a null, failure, or
[=byte sequence=] |contents|:
1. If |response|'s [=response/status=] is not 200, or |contents| is null
or failure, then run |completionSteps| given 0 and false.
1. Otherwise, run |completionSteps| given |index| and |contents|.
</div>
<div algorithm>
To <dfn>validate and resolve {{ContentScriptDetails}}</dfn> given a
<{controlledframe}> |controlledframe| and a {{ContentScriptDetails}}
|details|, run the following steps:
1. Let |result| be a new [=promise=].
1. If |details|["{{ContentScriptDetails/js}}"] and
|details|["{{ContentScriptDetails/css}}"] are both defined, or both
undefined, then [=reject=] |result| with a {{TypeError}} and abort
these steps.
1. If |details|["{{ContentScriptDetails/matches}}"] is [=list/empty=], then
[=reject=] |result| with a {{TypeError}} and abort these steps.
1. Return |result| and run the remaining steps [=in parallel=].
1. Let |config| be a new [=content script config=] with the following values:
: [=content script config/pendingFetchCount=]
:: 0
: [=content script config/matches=]
:: |details|["{{ContentScriptDetails/matches}}"]
: [=content script config/excludeMatches=]
:: |details|["{{ContentScriptDetails/excludeMatches}}"] if defined,
otherwise an empty [=list=]
: [=content script config/allFrames=]
:: |details|["{{ContentScriptDetails/allFrames}}"] if defined, otherwise
false
: [=content script config/matchAboutBlank=]
:: |details|["{{ContentScriptDetails/matchAboutBlank}}"] if defined,
otherwise false
: [=content script config/runAt=]
:: |details|["{{ContentScriptDetails/runAt}}"] if defined, otherwise
{{RunAt/document-idle}}
1. Let |isCss| be a [=boolean=] equal to true if
|details|["{{ContentScriptDetails/css}}"] is defined, false otherwise.
1. Let |completionSteps| be the following algorithm, which takes a {{long}}
|index| and a [=string=] or [=boolean=] |source|:
1. If |source| is not a [=string=], then [=reject=] |result| with a
{{TypeError}} and abort these steps.
1. If |isCss|, then:
1. Set |config|'s [=content script config/css=][|index|] to |source|.
1. Otherwise:
1. Set |config|'s [=content script config/js=][|index|] to |source|.
1. Decrement |config|'s [=content script config/pendingFetchCount=].
1. If |config|'s [=content script config/pendingFetchCount=] is greater
than 0, then return.
1. Set |controlledframe|'s [=controlledframe/content script map
=][|details|[{{ContentScriptDetails/name}}]] to |config|.
1. [=Resolve=] |result|.
1. Let |injectionItems| be |details|["{{ContentScriptDetails/css}}"] if
|isCss| is true, |details|["{{ContentScriptDetails/js}}"] otherwise.
1. If |injectionItems|["{{InjectionItems/code}}"] and
|injectionItems|["{{InjectionItems/files}}"] are both defined, or both
undefined, [=reject=] |result| with a {{TypeError}} and abort these steps.
1. If |injectionItems|["{{InjectionItems/code}}"] is defined, then:
1. Run |completionSteps| given 0 and |injectionItems|
["{{InjectionItems/code}}"].
1. Otherwise:
1. If |injectionItems|["{{InjectionItems/files}}"] is [=list/empty=], then
[=reject=] |result| with a {{TypeError}} and abort these steps.
1. [=list/For each=] |urlString| of |injectionItems|
["{{InjectionItems/files}}"]:
1. Run [=fetch an injection item=] given |controlledframe|,
|urlString|, |isCss|, |config|'s
[=content script config/pendingFetchCount=], and
|completionSteps|.
1. Increment |config|'s [=content script config/pendingFetchCount=].
</div>
<div algorithm>
To determine if a <dfn>[=content script config=] applies to a document</dfn>
given a [=content script config=] |config|, a [=/URL=] |url|, and a
[=boolean=] |isTopLevel|, run the following steps:
1. If |isTopLevel| is false, and |config|'s
[=content script config/allFrames=] is false, then return false.
1. If the result of <a lt="urlencoded serializer">serializing</a> |url| with
[=URL serializer/exclude fragment=] equal to true is equal to
"about:blank", and |config|'s [=content script config/matchAboutBlank=]
is false, then return false.
1. Let |urlString| be the result of <a lt="urlencoded serializer">
serializing</a> |url|.
1. Let |match| be false.
1. [=list/For each=] |pattern| of |config|'s
[=content script config/matches=]:
1. If |urlString| [=matches a URL pattern=] |pattern|, then set
|match| to true.
1. [=list/For each=] |pattern| of |config|'s
[=content script config/excludeMatches=]:
1. If |urlString| [=matches a URL pattern=] |pattern|, then set
|match| to false.
1. Return |match|.
</div>
<div algorithm>
To <dfn>inject content scripts into a document</dfn> given a {{Document}}
|document|, and a {{RunAt}} |currentPhase|, run the following steps:
1. Let |embeddedNavigable| be |document|'s [=node navigable=]'s
[=traversable navigable=].
1. If |embeddedNavigable| is null or its [=embedderParent=] is null, then
return.
1. Let |controlledframe| be |embeddedNavigable|'s [=embedderParent=].
1. Let |url| be |document|'s [=Document/URL=].
1. Let |isTopLevel| be true if |document|'s [=node navigable=]'s
[=navigable/parent=] is null, false otherwise.
1. [=list/For each=] |config| of |controlledframe|'s [=content script map=]:
1. If the result of determining whether a [=content script config applies
to a document=] given |config|, |url|, and |isTopLevel| equals false,
then [=continue=].
1. If |currentPhase| is equal to {{RunAt/document-start}} and |config|'s
[=content script config/css=] is not [=list/empty=], then:
1. [=list/For each=] |styleSource| of |config|'s
[=content script config/css=]:
1. Run [=inject a stylesheet into a document=] given |document|
and |styleSource|.
1. Otherwise, if |currentPhase| equals |config|'s
[=content script config/runAt=], then:
1. [=list/For each=] |scriptSource| of |config|'s
[=content script config/js=]: