From c3ccdaa3f0ef5a55066312b49c1f3dedb0262e36 Mon Sep 17 00:00:00 2001 From: Asaf Korem Date: Fri, 29 Mar 2024 16:30:04 +0300 Subject: [PATCH] docs(API): add `detoxDisableWebKitSecurity` launch-arg API. --- docs/api/device.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/api/device.md b/docs/api/device.md index e71b4d0838..0574f25eba 100644 --- a/docs/api/device.md +++ b/docs/api/device.md @@ -257,6 +257,25 @@ await device.launchApp({ }); ``` +#### 12. `detoxDisableWebKitSecurity`—Disable WebKit Security (iOS Only) + +Disables WebKit security on iOS. Default is `false`. + +This is useful for testing web views with iframes that loads CORS-protected content. + +:::caution Important + +Some pages may not load correctly when WebKit security is disabled (for example, PCI DSS-compliant pages). +Disabling WebKit security may cause errors when loading pages that have strict security policies. + +::: + +```js +await device.launchApp({ + launchArgs: { detoxDisableWebKitSecurity: true } +}); +``` + ### `device.terminateApp()` By default, `terminateApp()` with no params will terminate the app file defined in the current [`configuration`](../config/overview.mdx).