@capawesome/capacitor-in-app-browser 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CapawesomeCapacitorInAppBrowser.podspec +17 -0
- package/LICENSE +21 -0
- package/Package.swift +28 -0
- package/README.md +690 -0
- package/android/build.gradle +60 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/InAppBrowser.java +242 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/InAppBrowserPlugin.java +289 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/CustomException.java +20 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/CustomExceptions.java +20 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/WebViewDialog.java +343 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/events/BrowserPageNavigationCompletedEvent.java +23 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/events/MessageReceivedEvent.java +23 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/ExecuteScriptOptions.java +29 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/GetCookiesOptions.java +29 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/OpenInExternalBrowserOptions.java +30 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/OpenInSystemBrowserOptions.java +74 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/OpenInWebViewOptions.java +112 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/PostMessageOptions.java +30 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/options/WebViewToolbarOptions.java +87 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/results/ExecuteScriptResult.java +25 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/results/GetCookiesResult.java +28 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/interfaces/Callback.java +5 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/interfaces/EmptyCallback.java +5 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/interfaces/NonEmptyResultCallback.java +7 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/interfaces/Result.java +7 -0
- package/android/src/main/res/.gitkeep +0 -0
- package/dist/docs.json +1173 -0
- package/dist/esm/definitions.d.ts +540 -0
- package/dist/esm/definitions.js +19 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/web.d.ts +14 -0
- package/dist/esm/web.js +35 -0
- package/dist/esm/web.js.map +1 -0
- package/dist/plugin.cjs.js +68 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +71 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Plugin/Classes/Events/BrowserPageNavigationCompletedEvent.swift +16 -0
- package/ios/Plugin/Classes/Events/MessageReceivedEvent.swift +24 -0
- package/ios/Plugin/Classes/Options/ExecuteScriptOptions.swift +17 -0
- package/ios/Plugin/Classes/Options/GetCookiesOptions.swift +20 -0
- package/ios/Plugin/Classes/Options/OpenInExternalBrowserOptions.swift +20 -0
- package/ios/Plugin/Classes/Options/OpenInSystemBrowserOptions.swift +52 -0
- package/ios/Plugin/Classes/Options/OpenInWebViewOptions.swift +48 -0
- package/ios/Plugin/Classes/Options/PostMessageOptions.swift +17 -0
- package/ios/Plugin/Classes/Options/WebViewToolbarOptions.swift +37 -0
- package/ios/Plugin/Classes/Results/ExecuteScriptResult.swift +25 -0
- package/ios/Plugin/Classes/Results/GetCookiesResult.swift +20 -0
- package/ios/Plugin/Classes/WebViewController.swift +224 -0
- package/ios/Plugin/Enums/CustomError.swift +49 -0
- package/ios/Plugin/InAppBrowser.swift +194 -0
- package/ios/Plugin/InAppBrowserHelper.swift +49 -0
- package/ios/Plugin/InAppBrowserPlugin.swift +191 -0
- package/ios/Plugin/Info.plist +24 -0
- package/ios/Plugin/Protocols/Result.swift +5 -0
- package/package.json +91 -0
package/dist/docs.json
ADDED
|
@@ -0,0 +1,1173 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "InAppBrowserPlugin",
|
|
4
|
+
"slug": "inappbrowserplugin",
|
|
5
|
+
"docs": "",
|
|
6
|
+
"tags": [],
|
|
7
|
+
"methods": [
|
|
8
|
+
{
|
|
9
|
+
"name": "clearCache",
|
|
10
|
+
"signature": "() => Promise<void>",
|
|
11
|
+
"parameters": [],
|
|
12
|
+
"returns": "Promise<void>",
|
|
13
|
+
"tags": [
|
|
14
|
+
{
|
|
15
|
+
"name": "since",
|
|
16
|
+
"text": "0.1.0"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"docs": "Clear the cache of the web view.\n\nOnly available on Android and iOS.",
|
|
20
|
+
"complexTypes": [],
|
|
21
|
+
"slug": "clearcache"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "clearSessionData",
|
|
25
|
+
"signature": "() => Promise<void>",
|
|
26
|
+
"parameters": [],
|
|
27
|
+
"returns": "Promise<void>",
|
|
28
|
+
"tags": [
|
|
29
|
+
{
|
|
30
|
+
"name": "since",
|
|
31
|
+
"text": "0.1.0"
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"docs": "Clear the session data (cookies and web storage) of the web view.\n\nOnly available on Android and iOS.",
|
|
35
|
+
"complexTypes": [],
|
|
36
|
+
"slug": "clearsessiondata"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "close",
|
|
40
|
+
"signature": "() => Promise<void>",
|
|
41
|
+
"parameters": [],
|
|
42
|
+
"returns": "Promise<void>",
|
|
43
|
+
"tags": [
|
|
44
|
+
{
|
|
45
|
+
"name": "since",
|
|
46
|
+
"text": "0.1.0"
|
|
47
|
+
}
|
|
48
|
+
],
|
|
49
|
+
"docs": "Close the currently open browser.\n\nThis closes browsers opened with `openInWebView(...)` or\n`openInSystemBrowser(...)`.\n\nOnly available on Android and iOS.",
|
|
50
|
+
"complexTypes": [],
|
|
51
|
+
"slug": "close"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "executeScript",
|
|
55
|
+
"signature": "(options: ExecuteScriptOptions) => Promise<ExecuteScriptResult>",
|
|
56
|
+
"parameters": [
|
|
57
|
+
{
|
|
58
|
+
"name": "options",
|
|
59
|
+
"docs": "",
|
|
60
|
+
"type": "ExecuteScriptOptions"
|
|
61
|
+
}
|
|
62
|
+
],
|
|
63
|
+
"returns": "Promise<ExecuteScriptResult>",
|
|
64
|
+
"tags": [
|
|
65
|
+
{
|
|
66
|
+
"name": "since",
|
|
67
|
+
"text": "0.1.0"
|
|
68
|
+
}
|
|
69
|
+
],
|
|
70
|
+
"docs": "Execute a JavaScript script in the currently open web view.\n\nThis method is only available for browsers opened with\n`openInWebView(...)`.\n\nOnly available on Android and iOS.",
|
|
71
|
+
"complexTypes": [
|
|
72
|
+
"ExecuteScriptResult",
|
|
73
|
+
"ExecuteScriptOptions"
|
|
74
|
+
],
|
|
75
|
+
"slug": "executescript"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "getCookies",
|
|
79
|
+
"signature": "(options: GetCookiesOptions) => Promise<GetCookiesResult>",
|
|
80
|
+
"parameters": [
|
|
81
|
+
{
|
|
82
|
+
"name": "options",
|
|
83
|
+
"docs": "",
|
|
84
|
+
"type": "GetCookiesOptions"
|
|
85
|
+
}
|
|
86
|
+
],
|
|
87
|
+
"returns": "Promise<GetCookiesResult>",
|
|
88
|
+
"tags": [
|
|
89
|
+
{
|
|
90
|
+
"name": "since",
|
|
91
|
+
"text": "0.1.0"
|
|
92
|
+
}
|
|
93
|
+
],
|
|
94
|
+
"docs": "Get the cookies for a specific URL.\n\nOn iOS, only cookies from the shared data store are returned. Cookies from\na web view opened with `dataStore: 'isolated'` are not included.\n\nOnly available on Android and iOS.",
|
|
95
|
+
"complexTypes": [
|
|
96
|
+
"GetCookiesResult",
|
|
97
|
+
"GetCookiesOptions"
|
|
98
|
+
],
|
|
99
|
+
"slug": "getcookies"
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "openInExternalBrowser",
|
|
103
|
+
"signature": "(options: OpenInExternalBrowserOptions) => Promise<void>",
|
|
104
|
+
"parameters": [
|
|
105
|
+
{
|
|
106
|
+
"name": "options",
|
|
107
|
+
"docs": "",
|
|
108
|
+
"type": "OpenInExternalBrowserOptions"
|
|
109
|
+
}
|
|
110
|
+
],
|
|
111
|
+
"returns": "Promise<void>",
|
|
112
|
+
"tags": [
|
|
113
|
+
{
|
|
114
|
+
"name": "since",
|
|
115
|
+
"text": "0.1.0"
|
|
116
|
+
}
|
|
117
|
+
],
|
|
118
|
+
"docs": "Open a URL in the default browser app of the device.",
|
|
119
|
+
"complexTypes": [
|
|
120
|
+
"OpenInExternalBrowserOptions"
|
|
121
|
+
],
|
|
122
|
+
"slug": "openinexternalbrowser"
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"name": "openInSystemBrowser",
|
|
126
|
+
"signature": "(options: OpenInSystemBrowserOptions) => Promise<void>",
|
|
127
|
+
"parameters": [
|
|
128
|
+
{
|
|
129
|
+
"name": "options",
|
|
130
|
+
"docs": "",
|
|
131
|
+
"type": "OpenInSystemBrowserOptions"
|
|
132
|
+
}
|
|
133
|
+
],
|
|
134
|
+
"returns": "Promise<void>",
|
|
135
|
+
"tags": [
|
|
136
|
+
{
|
|
137
|
+
"name": "since",
|
|
138
|
+
"text": "0.1.0"
|
|
139
|
+
}
|
|
140
|
+
],
|
|
141
|
+
"docs": "Open a URL in the system browser (Custom Tabs on Android,\n`SFSafariViewController` on iOS).\n\nOnly available on Android and iOS.",
|
|
142
|
+
"complexTypes": [
|
|
143
|
+
"OpenInSystemBrowserOptions"
|
|
144
|
+
],
|
|
145
|
+
"slug": "openinsystembrowser"
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"name": "openInWebView",
|
|
149
|
+
"signature": "(options: OpenInWebViewOptions) => Promise<void>",
|
|
150
|
+
"parameters": [
|
|
151
|
+
{
|
|
152
|
+
"name": "options",
|
|
153
|
+
"docs": "",
|
|
154
|
+
"type": "OpenInWebViewOptions"
|
|
155
|
+
}
|
|
156
|
+
],
|
|
157
|
+
"returns": "Promise<void>",
|
|
158
|
+
"tags": [
|
|
159
|
+
{
|
|
160
|
+
"name": "since",
|
|
161
|
+
"text": "0.1.0"
|
|
162
|
+
}
|
|
163
|
+
],
|
|
164
|
+
"docs": "Open a URL in an embedded web view with a native toolbar.\n\nOnly available on Android and iOS.",
|
|
165
|
+
"complexTypes": [
|
|
166
|
+
"OpenInWebViewOptions"
|
|
167
|
+
],
|
|
168
|
+
"slug": "openinwebview"
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"name": "postMessage",
|
|
172
|
+
"signature": "(options: PostMessageOptions) => Promise<void>",
|
|
173
|
+
"parameters": [
|
|
174
|
+
{
|
|
175
|
+
"name": "options",
|
|
176
|
+
"docs": "",
|
|
177
|
+
"type": "PostMessageOptions"
|
|
178
|
+
}
|
|
179
|
+
],
|
|
180
|
+
"returns": "Promise<void>",
|
|
181
|
+
"tags": [
|
|
182
|
+
{
|
|
183
|
+
"name": "since",
|
|
184
|
+
"text": "0.1.0"
|
|
185
|
+
}
|
|
186
|
+
],
|
|
187
|
+
"docs": "Post a message to the currently open web view.\n\nThe web page receives the message by listening for the\n`capacitorInAppBrowserMessage` window event. The message data is\navailable in the `detail` property of the event.\n\nThis method is only available for browsers opened with\n`openInWebView(...)`.\n\nOnly available on Android and iOS.",
|
|
188
|
+
"complexTypes": [
|
|
189
|
+
"PostMessageOptions"
|
|
190
|
+
],
|
|
191
|
+
"slug": "postmessage"
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"name": "addListener",
|
|
195
|
+
"signature": "(eventName: 'browserClosed', listenerFunc: () => void) => Promise<PluginListenerHandle>",
|
|
196
|
+
"parameters": [
|
|
197
|
+
{
|
|
198
|
+
"name": "eventName",
|
|
199
|
+
"docs": "",
|
|
200
|
+
"type": "'browserClosed'"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "listenerFunc",
|
|
204
|
+
"docs": "",
|
|
205
|
+
"type": "() => void"
|
|
206
|
+
}
|
|
207
|
+
],
|
|
208
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
209
|
+
"tags": [
|
|
210
|
+
{
|
|
211
|
+
"name": "since",
|
|
212
|
+
"text": "0.1.0"
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"docs": "Called when the browser is closed.\n\nOnly available on Android and iOS.",
|
|
216
|
+
"complexTypes": [
|
|
217
|
+
"PluginListenerHandle"
|
|
218
|
+
],
|
|
219
|
+
"slug": "addlistenerbrowserclosed-"
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"name": "addListener",
|
|
223
|
+
"signature": "(eventName: 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle>",
|
|
224
|
+
"parameters": [
|
|
225
|
+
{
|
|
226
|
+
"name": "eventName",
|
|
227
|
+
"docs": "",
|
|
228
|
+
"type": "'browserPageLoaded'"
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "listenerFunc",
|
|
232
|
+
"docs": "",
|
|
233
|
+
"type": "() => void"
|
|
234
|
+
}
|
|
235
|
+
],
|
|
236
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
237
|
+
"tags": [
|
|
238
|
+
{
|
|
239
|
+
"name": "since",
|
|
240
|
+
"text": "0.1.0"
|
|
241
|
+
}
|
|
242
|
+
],
|
|
243
|
+
"docs": "Called when the initial page of the browser has finished loading.\n\nOn Android, this event is only emitted for browsers opened with\n`openInWebView(...)`.\n\nOnly available on Android and iOS.",
|
|
244
|
+
"complexTypes": [
|
|
245
|
+
"PluginListenerHandle"
|
|
246
|
+
],
|
|
247
|
+
"slug": "addlistenerbrowserpageloaded-"
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"name": "addListener",
|
|
251
|
+
"signature": "(eventName: 'browserPageNavigationCompleted', listenerFunc: (event: BrowserPageNavigationCompletedEvent) => void) => Promise<PluginListenerHandle>",
|
|
252
|
+
"parameters": [
|
|
253
|
+
{
|
|
254
|
+
"name": "eventName",
|
|
255
|
+
"docs": "",
|
|
256
|
+
"type": "'browserPageNavigationCompleted'"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "listenerFunc",
|
|
260
|
+
"docs": "",
|
|
261
|
+
"type": "(event: BrowserPageNavigationCompletedEvent) => void"
|
|
262
|
+
}
|
|
263
|
+
],
|
|
264
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
265
|
+
"tags": [
|
|
266
|
+
{
|
|
267
|
+
"name": "since",
|
|
268
|
+
"text": "0.1.0"
|
|
269
|
+
}
|
|
270
|
+
],
|
|
271
|
+
"docs": "Called when a page navigation has been completed in the web view.\n\nThis event is only emitted for browsers opened with `openInWebView(...)`.\n\nOnly available on Android and iOS.",
|
|
272
|
+
"complexTypes": [
|
|
273
|
+
"PluginListenerHandle",
|
|
274
|
+
"BrowserPageNavigationCompletedEvent"
|
|
275
|
+
],
|
|
276
|
+
"slug": "addlistenerbrowserpagenavigationcompleted-"
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "addListener",
|
|
280
|
+
"signature": "(eventName: 'messageReceived', listenerFunc: (event: MessageReceivedEvent) => void) => Promise<PluginListenerHandle>",
|
|
281
|
+
"parameters": [
|
|
282
|
+
{
|
|
283
|
+
"name": "eventName",
|
|
284
|
+
"docs": "",
|
|
285
|
+
"type": "'messageReceived'"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"name": "listenerFunc",
|
|
289
|
+
"docs": "",
|
|
290
|
+
"type": "(event: MessageReceivedEvent) => void"
|
|
291
|
+
}
|
|
292
|
+
],
|
|
293
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
294
|
+
"tags": [
|
|
295
|
+
{
|
|
296
|
+
"name": "since",
|
|
297
|
+
"text": "0.1.0"
|
|
298
|
+
}
|
|
299
|
+
],
|
|
300
|
+
"docs": "Called when the web page posts a message to the app using the injected\n`window.CapacitorInAppBrowser.postMessage(...)` function.\n\nThis event is only emitted for browsers opened with `openInWebView(...)`.\n\nOnly available on Android and iOS.",
|
|
301
|
+
"complexTypes": [
|
|
302
|
+
"PluginListenerHandle",
|
|
303
|
+
"MessageReceivedEvent"
|
|
304
|
+
],
|
|
305
|
+
"slug": "addlistenermessagereceived-"
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"name": "removeAllListeners",
|
|
309
|
+
"signature": "() => Promise<void>",
|
|
310
|
+
"parameters": [],
|
|
311
|
+
"returns": "Promise<void>",
|
|
312
|
+
"tags": [
|
|
313
|
+
{
|
|
314
|
+
"name": "since",
|
|
315
|
+
"text": "0.1.0"
|
|
316
|
+
}
|
|
317
|
+
],
|
|
318
|
+
"docs": "Remove all listeners for this plugin.",
|
|
319
|
+
"complexTypes": [],
|
|
320
|
+
"slug": "removealllisteners"
|
|
321
|
+
}
|
|
322
|
+
],
|
|
323
|
+
"properties": []
|
|
324
|
+
},
|
|
325
|
+
"interfaces": [
|
|
326
|
+
{
|
|
327
|
+
"name": "ExecuteScriptResult",
|
|
328
|
+
"slug": "executescriptresult",
|
|
329
|
+
"docs": "",
|
|
330
|
+
"tags": [
|
|
331
|
+
{
|
|
332
|
+
"text": "0.1.0",
|
|
333
|
+
"name": "since"
|
|
334
|
+
}
|
|
335
|
+
],
|
|
336
|
+
"methods": [],
|
|
337
|
+
"properties": [
|
|
338
|
+
{
|
|
339
|
+
"name": "result",
|
|
340
|
+
"tags": [
|
|
341
|
+
{
|
|
342
|
+
"text": "'\"Capawesome\"'",
|
|
343
|
+
"name": "example"
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"text": "0.1.0",
|
|
347
|
+
"name": "since"
|
|
348
|
+
}
|
|
349
|
+
],
|
|
350
|
+
"docs": "The result of the script execution serialized as a JSON string.\n\nIf the script does not return a JSON-serializable value, `null` is\nreturned.",
|
|
351
|
+
"complexTypes": [],
|
|
352
|
+
"type": "string | null"
|
|
353
|
+
}
|
|
354
|
+
]
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "ExecuteScriptOptions",
|
|
358
|
+
"slug": "executescriptoptions",
|
|
359
|
+
"docs": "",
|
|
360
|
+
"tags": [
|
|
361
|
+
{
|
|
362
|
+
"text": "0.1.0",
|
|
363
|
+
"name": "since"
|
|
364
|
+
}
|
|
365
|
+
],
|
|
366
|
+
"methods": [],
|
|
367
|
+
"properties": [
|
|
368
|
+
{
|
|
369
|
+
"name": "script",
|
|
370
|
+
"tags": [
|
|
371
|
+
{
|
|
372
|
+
"text": "'document.title'",
|
|
373
|
+
"name": "example"
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"text": "0.1.0",
|
|
377
|
+
"name": "since"
|
|
378
|
+
}
|
|
379
|
+
],
|
|
380
|
+
"docs": "The JavaScript code to execute in the web view.",
|
|
381
|
+
"complexTypes": [],
|
|
382
|
+
"type": "string"
|
|
383
|
+
}
|
|
384
|
+
]
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "GetCookiesResult",
|
|
388
|
+
"slug": "getcookiesresult",
|
|
389
|
+
"docs": "",
|
|
390
|
+
"tags": [
|
|
391
|
+
{
|
|
392
|
+
"text": "0.1.0",
|
|
393
|
+
"name": "since"
|
|
394
|
+
}
|
|
395
|
+
],
|
|
396
|
+
"methods": [],
|
|
397
|
+
"properties": [
|
|
398
|
+
{
|
|
399
|
+
"name": "cookies",
|
|
400
|
+
"tags": [
|
|
401
|
+
{
|
|
402
|
+
"text": "0.1.0",
|
|
403
|
+
"name": "since"
|
|
404
|
+
}
|
|
405
|
+
],
|
|
406
|
+
"docs": "The cookies for the URL as a map of cookie names to values.",
|
|
407
|
+
"complexTypes": [],
|
|
408
|
+
"type": "{ [key: string]: string; }"
|
|
409
|
+
}
|
|
410
|
+
]
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "GetCookiesOptions",
|
|
414
|
+
"slug": "getcookiesoptions",
|
|
415
|
+
"docs": "",
|
|
416
|
+
"tags": [
|
|
417
|
+
{
|
|
418
|
+
"text": "0.1.0",
|
|
419
|
+
"name": "since"
|
|
420
|
+
}
|
|
421
|
+
],
|
|
422
|
+
"methods": [],
|
|
423
|
+
"properties": [
|
|
424
|
+
{
|
|
425
|
+
"name": "url",
|
|
426
|
+
"tags": [
|
|
427
|
+
{
|
|
428
|
+
"text": "'https://capawesome.io'",
|
|
429
|
+
"name": "example"
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
"text": "0.1.0",
|
|
433
|
+
"name": "since"
|
|
434
|
+
}
|
|
435
|
+
],
|
|
436
|
+
"docs": "The URL to get the cookies for.",
|
|
437
|
+
"complexTypes": [],
|
|
438
|
+
"type": "string"
|
|
439
|
+
}
|
|
440
|
+
]
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"name": "OpenInExternalBrowserOptions",
|
|
444
|
+
"slug": "openinexternalbrowseroptions",
|
|
445
|
+
"docs": "",
|
|
446
|
+
"tags": [
|
|
447
|
+
{
|
|
448
|
+
"text": "0.1.0",
|
|
449
|
+
"name": "since"
|
|
450
|
+
}
|
|
451
|
+
],
|
|
452
|
+
"methods": [],
|
|
453
|
+
"properties": [
|
|
454
|
+
{
|
|
455
|
+
"name": "url",
|
|
456
|
+
"tags": [
|
|
457
|
+
{
|
|
458
|
+
"text": "'https://capawesome.io'",
|
|
459
|
+
"name": "example"
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"text": "0.1.0",
|
|
463
|
+
"name": "since"
|
|
464
|
+
}
|
|
465
|
+
],
|
|
466
|
+
"docs": "The URL to open in the external browser.",
|
|
467
|
+
"complexTypes": [],
|
|
468
|
+
"type": "string"
|
|
469
|
+
}
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "OpenInSystemBrowserOptions",
|
|
474
|
+
"slug": "openinsystembrowseroptions",
|
|
475
|
+
"docs": "",
|
|
476
|
+
"tags": [
|
|
477
|
+
{
|
|
478
|
+
"text": "0.1.0",
|
|
479
|
+
"name": "since"
|
|
480
|
+
}
|
|
481
|
+
],
|
|
482
|
+
"methods": [],
|
|
483
|
+
"properties": [
|
|
484
|
+
{
|
|
485
|
+
"name": "android",
|
|
486
|
+
"tags": [
|
|
487
|
+
{
|
|
488
|
+
"text": "0.1.0",
|
|
489
|
+
"name": "since"
|
|
490
|
+
}
|
|
491
|
+
],
|
|
492
|
+
"docs": "Options that are only applied on Android.\n\nOnly available on Android.",
|
|
493
|
+
"complexTypes": [
|
|
494
|
+
"OpenInSystemBrowserAndroidOptions"
|
|
495
|
+
],
|
|
496
|
+
"type": "OpenInSystemBrowserAndroidOptions"
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
"name": "ios",
|
|
500
|
+
"tags": [
|
|
501
|
+
{
|
|
502
|
+
"text": "0.1.0",
|
|
503
|
+
"name": "since"
|
|
504
|
+
}
|
|
505
|
+
],
|
|
506
|
+
"docs": "Options that are only applied on iOS.\n\nOnly available on iOS.",
|
|
507
|
+
"complexTypes": [
|
|
508
|
+
"OpenInSystemBrowserIosOptions"
|
|
509
|
+
],
|
|
510
|
+
"type": "OpenInSystemBrowserIosOptions"
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "url",
|
|
514
|
+
"tags": [
|
|
515
|
+
{
|
|
516
|
+
"text": "'https://capawesome.io'",
|
|
517
|
+
"name": "example"
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"text": "0.1.0",
|
|
521
|
+
"name": "since"
|
|
522
|
+
}
|
|
523
|
+
],
|
|
524
|
+
"docs": "The URL to open in the system browser.",
|
|
525
|
+
"complexTypes": [],
|
|
526
|
+
"type": "string"
|
|
527
|
+
}
|
|
528
|
+
]
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "OpenInSystemBrowserAndroidOptions",
|
|
532
|
+
"slug": "openinsystembrowserandroidoptions",
|
|
533
|
+
"docs": "",
|
|
534
|
+
"tags": [
|
|
535
|
+
{
|
|
536
|
+
"text": "0.1.0",
|
|
537
|
+
"name": "since"
|
|
538
|
+
}
|
|
539
|
+
],
|
|
540
|
+
"methods": [],
|
|
541
|
+
"properties": [
|
|
542
|
+
{
|
|
543
|
+
"name": "hideToolbarOnScroll",
|
|
544
|
+
"tags": [
|
|
545
|
+
{
|
|
546
|
+
"text": "false",
|
|
547
|
+
"name": "default"
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"text": "0.1.0",
|
|
551
|
+
"name": "since"
|
|
552
|
+
}
|
|
553
|
+
],
|
|
554
|
+
"docs": "Whether or not the toolbar should be hidden when the user scrolls down\nand shown when the user scrolls up.",
|
|
555
|
+
"complexTypes": [],
|
|
556
|
+
"type": "boolean | undefined"
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "showTitle",
|
|
560
|
+
"tags": [
|
|
561
|
+
{
|
|
562
|
+
"text": "false",
|
|
563
|
+
"name": "default"
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"text": "0.1.0",
|
|
567
|
+
"name": "since"
|
|
568
|
+
}
|
|
569
|
+
],
|
|
570
|
+
"docs": "Whether or not the title of the web page should be shown in the toolbar.",
|
|
571
|
+
"complexTypes": [],
|
|
572
|
+
"type": "boolean | undefined"
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "toolbarColor",
|
|
576
|
+
"tags": [
|
|
577
|
+
{
|
|
578
|
+
"text": "'#008080'",
|
|
579
|
+
"name": "example"
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"text": "0.1.0",
|
|
583
|
+
"name": "since"
|
|
584
|
+
}
|
|
585
|
+
],
|
|
586
|
+
"docs": "The background color of the toolbar as a hex color code.",
|
|
587
|
+
"complexTypes": [],
|
|
588
|
+
"type": "string | undefined"
|
|
589
|
+
}
|
|
590
|
+
]
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"name": "OpenInSystemBrowserIosOptions",
|
|
594
|
+
"slug": "openinsystembrowseriosoptions",
|
|
595
|
+
"docs": "",
|
|
596
|
+
"tags": [
|
|
597
|
+
{
|
|
598
|
+
"text": "0.1.0",
|
|
599
|
+
"name": "since"
|
|
600
|
+
}
|
|
601
|
+
],
|
|
602
|
+
"methods": [],
|
|
603
|
+
"properties": [
|
|
604
|
+
{
|
|
605
|
+
"name": "barCollapsing",
|
|
606
|
+
"tags": [
|
|
607
|
+
{
|
|
608
|
+
"text": "true",
|
|
609
|
+
"name": "default"
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"text": "0.1.0",
|
|
613
|
+
"name": "since"
|
|
614
|
+
}
|
|
615
|
+
],
|
|
616
|
+
"docs": "Whether or not the toolbar should collapse when the user scrolls down.",
|
|
617
|
+
"complexTypes": [],
|
|
618
|
+
"type": "boolean | undefined"
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"name": "dismissButtonStyle",
|
|
622
|
+
"tags": [
|
|
623
|
+
{
|
|
624
|
+
"text": "'done'",
|
|
625
|
+
"name": "default"
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"text": "0.1.0",
|
|
629
|
+
"name": "since"
|
|
630
|
+
}
|
|
631
|
+
],
|
|
632
|
+
"docs": "The style of the dismiss button in the toolbar.",
|
|
633
|
+
"complexTypes": [
|
|
634
|
+
"DismissButtonStyle"
|
|
635
|
+
],
|
|
636
|
+
"type": "DismissButtonStyle"
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "readerMode",
|
|
640
|
+
"tags": [
|
|
641
|
+
{
|
|
642
|
+
"text": "false",
|
|
643
|
+
"name": "default"
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"text": "0.1.0",
|
|
647
|
+
"name": "since"
|
|
648
|
+
}
|
|
649
|
+
],
|
|
650
|
+
"docs": "Whether or not the reader mode should be entered if it is available for\nthe web page.",
|
|
651
|
+
"complexTypes": [],
|
|
652
|
+
"type": "boolean | undefined"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "toolbarColor",
|
|
656
|
+
"tags": [
|
|
657
|
+
{
|
|
658
|
+
"text": "'#008080'",
|
|
659
|
+
"name": "example"
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"text": "0.1.0",
|
|
663
|
+
"name": "since"
|
|
664
|
+
}
|
|
665
|
+
],
|
|
666
|
+
"docs": "The background color of the toolbar as a hex color code.",
|
|
667
|
+
"complexTypes": [],
|
|
668
|
+
"type": "string | undefined"
|
|
669
|
+
}
|
|
670
|
+
]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "OpenInWebViewOptions",
|
|
674
|
+
"slug": "openinwebviewoptions",
|
|
675
|
+
"docs": "",
|
|
676
|
+
"tags": [
|
|
677
|
+
{
|
|
678
|
+
"text": "0.1.0",
|
|
679
|
+
"name": "since"
|
|
680
|
+
}
|
|
681
|
+
],
|
|
682
|
+
"methods": [],
|
|
683
|
+
"properties": [
|
|
684
|
+
{
|
|
685
|
+
"name": "android",
|
|
686
|
+
"tags": [
|
|
687
|
+
{
|
|
688
|
+
"text": "0.1.0",
|
|
689
|
+
"name": "since"
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"docs": "Options that are only applied on Android.\n\nOnly available on Android.",
|
|
693
|
+
"complexTypes": [
|
|
694
|
+
"OpenInWebViewAndroidOptions"
|
|
695
|
+
],
|
|
696
|
+
"type": "OpenInWebViewAndroidOptions"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "dataStore",
|
|
700
|
+
"tags": [
|
|
701
|
+
{
|
|
702
|
+
"text": "'shared'",
|
|
703
|
+
"name": "default"
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
"text": "0.1.0",
|
|
707
|
+
"name": "since"
|
|
708
|
+
}
|
|
709
|
+
],
|
|
710
|
+
"docs": "The data store to use for the web view.\n\nOn Android, this option is ignored. The web view always uses the\napp-global (`shared`) data store.\n\nOnly available on iOS.",
|
|
711
|
+
"complexTypes": [
|
|
712
|
+
"WebViewDataStore"
|
|
713
|
+
],
|
|
714
|
+
"type": "WebViewDataStore"
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
"name": "headers",
|
|
718
|
+
"tags": [
|
|
719
|
+
{
|
|
720
|
+
"text": "0.1.0",
|
|
721
|
+
"name": "since"
|
|
722
|
+
}
|
|
723
|
+
],
|
|
724
|
+
"docs": "Additional HTTP headers to send with the initial request.",
|
|
725
|
+
"complexTypes": [],
|
|
726
|
+
"type": "{ [key: string]: string; } | undefined"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"name": "ios",
|
|
730
|
+
"tags": [
|
|
731
|
+
{
|
|
732
|
+
"text": "0.1.0",
|
|
733
|
+
"name": "since"
|
|
734
|
+
}
|
|
735
|
+
],
|
|
736
|
+
"docs": "Options that are only applied on iOS.\n\nOnly available on iOS.",
|
|
737
|
+
"complexTypes": [
|
|
738
|
+
"OpenInWebViewIosOptions"
|
|
739
|
+
],
|
|
740
|
+
"type": "OpenInWebViewIosOptions"
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
"name": "mediaPlaybackRequiresUserAction",
|
|
744
|
+
"tags": [
|
|
745
|
+
{
|
|
746
|
+
"text": "false",
|
|
747
|
+
"name": "default"
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
"text": "0.1.0",
|
|
751
|
+
"name": "since"
|
|
752
|
+
}
|
|
753
|
+
],
|
|
754
|
+
"docs": "Whether or not media playback requires user action.",
|
|
755
|
+
"complexTypes": [],
|
|
756
|
+
"type": "boolean | undefined"
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"name": "toolbar",
|
|
760
|
+
"tags": [
|
|
761
|
+
{
|
|
762
|
+
"text": "0.1.0",
|
|
763
|
+
"name": "since"
|
|
764
|
+
}
|
|
765
|
+
],
|
|
766
|
+
"docs": "Options for the toolbar of the web view.",
|
|
767
|
+
"complexTypes": [
|
|
768
|
+
"WebViewToolbarOptions"
|
|
769
|
+
],
|
|
770
|
+
"type": "WebViewToolbarOptions"
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
"name": "url",
|
|
774
|
+
"tags": [
|
|
775
|
+
{
|
|
776
|
+
"text": "'https://capawesome.io'",
|
|
777
|
+
"name": "example"
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"text": "0.1.0",
|
|
781
|
+
"name": "since"
|
|
782
|
+
}
|
|
783
|
+
],
|
|
784
|
+
"docs": "The URL to open in the web view.",
|
|
785
|
+
"complexTypes": [],
|
|
786
|
+
"type": "string"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "userAgent",
|
|
790
|
+
"tags": [
|
|
791
|
+
{
|
|
792
|
+
"text": "0.1.0",
|
|
793
|
+
"name": "since"
|
|
794
|
+
}
|
|
795
|
+
],
|
|
796
|
+
"docs": "The custom user agent to use for the web view.",
|
|
797
|
+
"complexTypes": [],
|
|
798
|
+
"type": "string | undefined"
|
|
799
|
+
}
|
|
800
|
+
]
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"name": "OpenInWebViewAndroidOptions",
|
|
804
|
+
"slug": "openinwebviewandroidoptions",
|
|
805
|
+
"docs": "",
|
|
806
|
+
"tags": [
|
|
807
|
+
{
|
|
808
|
+
"text": "0.1.0",
|
|
809
|
+
"name": "since"
|
|
810
|
+
}
|
|
811
|
+
],
|
|
812
|
+
"methods": [],
|
|
813
|
+
"properties": [
|
|
814
|
+
{
|
|
815
|
+
"name": "allowZoom",
|
|
816
|
+
"tags": [
|
|
817
|
+
{
|
|
818
|
+
"text": "false",
|
|
819
|
+
"name": "default"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"text": "0.1.0",
|
|
823
|
+
"name": "since"
|
|
824
|
+
}
|
|
825
|
+
],
|
|
826
|
+
"docs": "Whether or not the user can zoom the web page.",
|
|
827
|
+
"complexTypes": [],
|
|
828
|
+
"type": "boolean | undefined"
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "hardwareBackButton",
|
|
832
|
+
"tags": [
|
|
833
|
+
{
|
|
834
|
+
"text": "true",
|
|
835
|
+
"name": "default"
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"text": "0.1.0",
|
|
839
|
+
"name": "since"
|
|
840
|
+
}
|
|
841
|
+
],
|
|
842
|
+
"docs": "Whether or not the hardware back button navigates back in the web view's\nhistory before closing the web view.\n\nIf `false`, the hardware back button closes the web view immediately.",
|
|
843
|
+
"complexTypes": [],
|
|
844
|
+
"type": "boolean | undefined"
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "pauseMediaWhenHidden",
|
|
848
|
+
"tags": [
|
|
849
|
+
{
|
|
850
|
+
"text": "true",
|
|
851
|
+
"name": "default"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"text": "0.1.0",
|
|
855
|
+
"name": "since"
|
|
856
|
+
}
|
|
857
|
+
],
|
|
858
|
+
"docs": "Whether or not media playback is paused when the app is hidden.",
|
|
859
|
+
"complexTypes": [],
|
|
860
|
+
"type": "boolean | undefined"
|
|
861
|
+
}
|
|
862
|
+
]
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"name": "OpenInWebViewIosOptions",
|
|
866
|
+
"slug": "openinwebviewiosoptions",
|
|
867
|
+
"docs": "",
|
|
868
|
+
"tags": [
|
|
869
|
+
{
|
|
870
|
+
"text": "0.1.0",
|
|
871
|
+
"name": "since"
|
|
872
|
+
}
|
|
873
|
+
],
|
|
874
|
+
"methods": [],
|
|
875
|
+
"properties": [
|
|
876
|
+
{
|
|
877
|
+
"name": "allowsBackForwardNavigationGestures",
|
|
878
|
+
"tags": [
|
|
879
|
+
{
|
|
880
|
+
"text": "false",
|
|
881
|
+
"name": "default"
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"text": "0.1.0",
|
|
885
|
+
"name": "since"
|
|
886
|
+
}
|
|
887
|
+
],
|
|
888
|
+
"docs": "Whether or not horizontal swipe gestures navigate back and forward in\nthe web view's history.",
|
|
889
|
+
"complexTypes": [],
|
|
890
|
+
"type": "boolean | undefined"
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "overscroll",
|
|
894
|
+
"tags": [
|
|
895
|
+
{
|
|
896
|
+
"text": "true",
|
|
897
|
+
"name": "default"
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
"text": "0.1.0",
|
|
901
|
+
"name": "since"
|
|
902
|
+
}
|
|
903
|
+
],
|
|
904
|
+
"docs": "Whether or not the web view bounces when scrolled past the edge of the\ncontent.",
|
|
905
|
+
"complexTypes": [],
|
|
906
|
+
"type": "boolean | undefined"
|
|
907
|
+
}
|
|
908
|
+
]
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
"name": "WebViewToolbarOptions",
|
|
912
|
+
"slug": "webviewtoolbaroptions",
|
|
913
|
+
"docs": "",
|
|
914
|
+
"tags": [
|
|
915
|
+
{
|
|
916
|
+
"text": "0.1.0",
|
|
917
|
+
"name": "since"
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
"methods": [],
|
|
921
|
+
"properties": [
|
|
922
|
+
{
|
|
923
|
+
"name": "backgroundColor",
|
|
924
|
+
"tags": [
|
|
925
|
+
{
|
|
926
|
+
"text": "'#008080'",
|
|
927
|
+
"name": "example"
|
|
928
|
+
},
|
|
929
|
+
{
|
|
930
|
+
"text": "0.1.0",
|
|
931
|
+
"name": "since"
|
|
932
|
+
}
|
|
933
|
+
],
|
|
934
|
+
"docs": "The background color of the toolbar as a hex color code.",
|
|
935
|
+
"complexTypes": [],
|
|
936
|
+
"type": "string | undefined"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "closeButtonText",
|
|
940
|
+
"tags": [
|
|
941
|
+
{
|
|
942
|
+
"text": "'Close'",
|
|
943
|
+
"name": "default"
|
|
944
|
+
},
|
|
945
|
+
{
|
|
946
|
+
"text": "0.1.0",
|
|
947
|
+
"name": "since"
|
|
948
|
+
}
|
|
949
|
+
],
|
|
950
|
+
"docs": "The text of the close button in the toolbar.",
|
|
951
|
+
"complexTypes": [],
|
|
952
|
+
"type": "string | undefined"
|
|
953
|
+
},
|
|
954
|
+
{
|
|
955
|
+
"name": "color",
|
|
956
|
+
"tags": [
|
|
957
|
+
{
|
|
958
|
+
"text": "'#FFFFFF'",
|
|
959
|
+
"name": "example"
|
|
960
|
+
},
|
|
961
|
+
{
|
|
962
|
+
"text": "0.1.0",
|
|
963
|
+
"name": "since"
|
|
964
|
+
}
|
|
965
|
+
],
|
|
966
|
+
"docs": "The text color of the toolbar as a hex color code.",
|
|
967
|
+
"complexTypes": [],
|
|
968
|
+
"type": "string | undefined"
|
|
969
|
+
},
|
|
970
|
+
{
|
|
971
|
+
"name": "showNavigationButtons",
|
|
972
|
+
"tags": [
|
|
973
|
+
{
|
|
974
|
+
"text": "false",
|
|
975
|
+
"name": "default"
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"text": "0.1.0",
|
|
979
|
+
"name": "since"
|
|
980
|
+
}
|
|
981
|
+
],
|
|
982
|
+
"docs": "Whether or not the back and forward navigation buttons should be shown\nin the toolbar.",
|
|
983
|
+
"complexTypes": [],
|
|
984
|
+
"type": "boolean | undefined"
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "showUrl",
|
|
988
|
+
"tags": [
|
|
989
|
+
{
|
|
990
|
+
"text": "false",
|
|
991
|
+
"name": "default"
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"text": "0.1.0",
|
|
995
|
+
"name": "since"
|
|
996
|
+
}
|
|
997
|
+
],
|
|
998
|
+
"docs": "Whether or not the current URL should be displayed in the toolbar\ninstead of the title.",
|
|
999
|
+
"complexTypes": [],
|
|
1000
|
+
"type": "boolean | undefined"
|
|
1001
|
+
},
|
|
1002
|
+
{
|
|
1003
|
+
"name": "title",
|
|
1004
|
+
"tags": [
|
|
1005
|
+
{
|
|
1006
|
+
"text": "0.1.0",
|
|
1007
|
+
"name": "since"
|
|
1008
|
+
}
|
|
1009
|
+
],
|
|
1010
|
+
"docs": "The fixed title to display in the toolbar.\n\nIf not set, the title of the current web page is displayed.",
|
|
1011
|
+
"complexTypes": [],
|
|
1012
|
+
"type": "string | undefined"
|
|
1013
|
+
},
|
|
1014
|
+
{
|
|
1015
|
+
"name": "visible",
|
|
1016
|
+
"tags": [
|
|
1017
|
+
{
|
|
1018
|
+
"text": "true",
|
|
1019
|
+
"name": "default"
|
|
1020
|
+
},
|
|
1021
|
+
{
|
|
1022
|
+
"text": "0.1.0",
|
|
1023
|
+
"name": "since"
|
|
1024
|
+
}
|
|
1025
|
+
],
|
|
1026
|
+
"docs": "Whether or not the toolbar should be visible.",
|
|
1027
|
+
"complexTypes": [],
|
|
1028
|
+
"type": "boolean | undefined"
|
|
1029
|
+
}
|
|
1030
|
+
]
|
|
1031
|
+
},
|
|
1032
|
+
{
|
|
1033
|
+
"name": "PostMessageOptions",
|
|
1034
|
+
"slug": "postmessageoptions",
|
|
1035
|
+
"docs": "",
|
|
1036
|
+
"tags": [
|
|
1037
|
+
{
|
|
1038
|
+
"text": "0.1.0",
|
|
1039
|
+
"name": "since"
|
|
1040
|
+
}
|
|
1041
|
+
],
|
|
1042
|
+
"methods": [],
|
|
1043
|
+
"properties": [
|
|
1044
|
+
{
|
|
1045
|
+
"name": "data",
|
|
1046
|
+
"tags": [
|
|
1047
|
+
{
|
|
1048
|
+
"text": "{ name: 'Capawesome' }",
|
|
1049
|
+
"name": "example"
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
"text": "0.1.0",
|
|
1053
|
+
"name": "since"
|
|
1054
|
+
}
|
|
1055
|
+
],
|
|
1056
|
+
"docs": "The message data to post to the web view.\n\nMust be a JSON-serializable object.",
|
|
1057
|
+
"complexTypes": [],
|
|
1058
|
+
"type": "{ [key: string]: unknown; }"
|
|
1059
|
+
}
|
|
1060
|
+
]
|
|
1061
|
+
},
|
|
1062
|
+
{
|
|
1063
|
+
"name": "PluginListenerHandle",
|
|
1064
|
+
"slug": "pluginlistenerhandle",
|
|
1065
|
+
"docs": "",
|
|
1066
|
+
"tags": [],
|
|
1067
|
+
"methods": [],
|
|
1068
|
+
"properties": [
|
|
1069
|
+
{
|
|
1070
|
+
"name": "remove",
|
|
1071
|
+
"tags": [],
|
|
1072
|
+
"docs": "",
|
|
1073
|
+
"complexTypes": [],
|
|
1074
|
+
"type": "() => Promise<void>"
|
|
1075
|
+
}
|
|
1076
|
+
]
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"name": "BrowserPageNavigationCompletedEvent",
|
|
1080
|
+
"slug": "browserpagenavigationcompletedevent",
|
|
1081
|
+
"docs": "",
|
|
1082
|
+
"tags": [
|
|
1083
|
+
{
|
|
1084
|
+
"text": "0.1.0",
|
|
1085
|
+
"name": "since"
|
|
1086
|
+
}
|
|
1087
|
+
],
|
|
1088
|
+
"methods": [],
|
|
1089
|
+
"properties": [
|
|
1090
|
+
{
|
|
1091
|
+
"name": "url",
|
|
1092
|
+
"tags": [
|
|
1093
|
+
{
|
|
1094
|
+
"text": "'https://capawesome.io'",
|
|
1095
|
+
"name": "example"
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"text": "0.1.0",
|
|
1099
|
+
"name": "since"
|
|
1100
|
+
}
|
|
1101
|
+
],
|
|
1102
|
+
"docs": "The URL of the page that was navigated to.",
|
|
1103
|
+
"complexTypes": [],
|
|
1104
|
+
"type": "string"
|
|
1105
|
+
}
|
|
1106
|
+
]
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "MessageReceivedEvent",
|
|
1110
|
+
"slug": "messagereceivedevent",
|
|
1111
|
+
"docs": "",
|
|
1112
|
+
"tags": [
|
|
1113
|
+
{
|
|
1114
|
+
"text": "0.1.0",
|
|
1115
|
+
"name": "since"
|
|
1116
|
+
}
|
|
1117
|
+
],
|
|
1118
|
+
"methods": [],
|
|
1119
|
+
"properties": [
|
|
1120
|
+
{
|
|
1121
|
+
"name": "data",
|
|
1122
|
+
"tags": [
|
|
1123
|
+
{
|
|
1124
|
+
"text": "0.1.0",
|
|
1125
|
+
"name": "since"
|
|
1126
|
+
}
|
|
1127
|
+
],
|
|
1128
|
+
"docs": "The message data posted by the web page.",
|
|
1129
|
+
"complexTypes": [],
|
|
1130
|
+
"type": "unknown"
|
|
1131
|
+
}
|
|
1132
|
+
]
|
|
1133
|
+
}
|
|
1134
|
+
],
|
|
1135
|
+
"enums": [],
|
|
1136
|
+
"typeAliases": [
|
|
1137
|
+
{
|
|
1138
|
+
"name": "DismissButtonStyle",
|
|
1139
|
+
"slug": "dismissbuttonstyle",
|
|
1140
|
+
"docs": "The style of the dismiss button in the toolbar of the system browser.\n\n- `cancel`: A button with the text \"Cancel\".\n- `close`: A button with the text \"Close\".\n- `done`: A button with the text \"Done\".",
|
|
1141
|
+
"types": [
|
|
1142
|
+
{
|
|
1143
|
+
"text": "'cancel'",
|
|
1144
|
+
"complexTypes": []
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"text": "'close'",
|
|
1148
|
+
"complexTypes": []
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"text": "'done'",
|
|
1152
|
+
"complexTypes": []
|
|
1153
|
+
}
|
|
1154
|
+
]
|
|
1155
|
+
},
|
|
1156
|
+
{
|
|
1157
|
+
"name": "WebViewDataStore",
|
|
1158
|
+
"slug": "webviewdatastore",
|
|
1159
|
+
"docs": "The data store to use for the web view.\n\n- `isolated`: The web view uses a non-persistent data store. Cookies and\n web storage are discarded when the web view is closed.\n- `shared`: The web view uses the app-global data store which is shared\n with other web views.",
|
|
1160
|
+
"types": [
|
|
1161
|
+
{
|
|
1162
|
+
"text": "'isolated'",
|
|
1163
|
+
"complexTypes": []
|
|
1164
|
+
},
|
|
1165
|
+
{
|
|
1166
|
+
"text": "'shared'",
|
|
1167
|
+
"complexTypes": []
|
|
1168
|
+
}
|
|
1169
|
+
]
|
|
1170
|
+
}
|
|
1171
|
+
],
|
|
1172
|
+
"pluginConfigs": []
|
|
1173
|
+
}
|