Google Git
Sign in
chromium / devtools / devtools-frontend / c712a3e629da4ac2ec3e1bb1fa4e2fbcb36293c2 / . / node_modules / @webref / idl / navigation-api.idl
blob: 5d2f2a8279ce8e5fb95254c1376101704a3f0967 [file] [log] [blame]
Victor Porof6e096922022-06-10 13:01:05[diff] [blame]1// GENERATED CONTENT - DO NOT EDIT
2// Content was automatically extracted by Reffy into webref
3// (https://github.com/w3c/webref)
4// Source: Navigation API (https://wicg.github.io/navigation-api/)
5
6partial interface Window {
7 [Replaceable] readonly attribute Navigation navigation;
8};
9
10[Exposed=Window]
11interface Navigation : EventTarget {
12 sequence<NavigationHistoryEntry> entries();
13 readonly attribute NavigationHistoryEntry? currentEntry;
14 undefined updateCurrentEntry(NavigationUpdateCurrentEntryOptions options);
15 readonly attribute NavigationTransition? transition;
16
17 readonly attribute boolean canGoBack;
18 readonly attribute boolean canGoForward;
19
20 NavigationResult navigate(USVString url, optional NavigationNavigateOptions options = {});
21 NavigationResult reload(optional NavigationReloadOptions options = {});
22
23 NavigationResult traverseTo(DOMString key, optional NavigationOptions options = {});
24 NavigationResult back(optional NavigationOptions options = {});
25 NavigationResult forward(optional NavigationOptions options = {});
26
27 attribute EventHandler onnavigate;
28 attribute EventHandler onnavigatesuccess;
29 attribute EventHandler onnavigateerror;
30 attribute EventHandler oncurrententrychange;
31};
32
33dictionary NavigationUpdateCurrentEntryOptions {
34 required any state;
35};
36
37dictionary NavigationOptions {
38 any info;
39};
40
41dictionary NavigationNavigateOptions : NavigationOptions {
42 any state;
43 NavigationHistoryBehavior history = "auto";
44};
45
46dictionary NavigationReloadOptions : NavigationOptions {
47 any state;
48};
49
50dictionary NavigationResult {
51 Promise<NavigationHistoryEntry> committed;
52 Promise<NavigationHistoryEntry> finished;
53};
54
55enum NavigationHistoryBehavior {
56 "auto",
57 "push",
58 "replace"
59};
60
61[Exposed=Window]
62interface NavigationCurrentEntryChangeEvent : Event {
63 constructor(DOMString type, NavigationCurrentEntryChangeEventInit eventInit);
64
65 readonly attribute NavigationType? navigationType;
66 readonly attribute NavigationHistoryEntry from;
67};
68
69dictionary NavigationCurrentEntryChangeEventInit : EventInit {
70 NavigationType? navigationType = null;
71 required NavigationHistoryEntry destination;
72};
73
74[Exposed=Window]
75interface NavigationTransition {
76 readonly attribute NavigationType navigationType;
77 readonly attribute NavigationHistoryEntry from;
78 readonly attribute Promise<undefined> finished;
79};
80
81[Exposed=Window]
82interface NavigateEvent : Event {
83 constructor(DOMString type, NavigateEventInit eventInit);
84
85 readonly attribute NavigationType navigationType;
86 readonly attribute NavigationDestination destination;
87 readonly attribute boolean canTransition;
88 readonly attribute boolean userInitiated;
89 readonly attribute boolean hashChange;
90 readonly attribute AbortSignal signal;
91 readonly attribute FormData? formData;
92 readonly attribute DOMString? downloadRequest;
93 readonly attribute any info;
94
95 undefined transitionWhile(Promise<undefined> newNavigationAction,
96 optional NavigationTransitionWhileOptions options = {});
97 undefined restoreScroll();
98};
99
100dictionary NavigateEventInit : EventInit {
101 NavigationType navigationType = "push";
102 required NavigationDestination destination;
103 boolean canTransition = false;
104 boolean userInitiated = false;
105 boolean hashChange = false;
106 required AbortSignal signal;
107 FormData? formData = null;
108 DOMString? downloadRequest = null;
109 any info;
110};
111
112dictionary NavigationTransitionWhileOptions {
113 NavigationFocusReset focusReset;
114 NavigationScrollRestoration scrollRestoration;
115};
116
117enum NavigationFocusReset {
118 "after-transition",
119 "manual"
120};
121
122enum NavigationScrollRestoration {
123 "after-transition",
124 "manual"
125};
126
127enum NavigationType {
128 "reload",
129 "push",
130 "replace",
131 "traverse"
132};
133
134[Exposed=Window]
135interface NavigationDestination {
136 readonly attribute USVString url;
137 readonly attribute DOMString? key;
138 readonly attribute DOMString? id;
139 readonly attribute long long index;
140 readonly attribute boolean sameDocument;
141
142 any getState();
143};
144
145[Exposed=Window]
146interface NavigationHistoryEntry : EventTarget {
147 readonly attribute USVString? url;
148 readonly attribute DOMString key;
149 readonly attribute DOMString id;
150 readonly attribute long long index;
151 readonly attribute boolean sameDocument;
152
153 any getState();
154
155 attribute EventHandler ondispose;
156};