{"id":13801697,"url":"https://github.com/apache/cordova-plugin-wkwebview-engine","last_synced_at":"2025-10-08T00:32:04.937Z","repository":{"id":1960764,"uuid":"42161741","full_name":"apache/cordova-plugin-wkwebview-engine","owner":"apache","description":"[DEPRECATED] Apache Cordova wkwebview engine plugin","archived":true,"fork":false,"pushed_at":"2023-01-08T23:24:17.000Z","size":226,"stargazers_count":611,"open_issues_count":0,"forks_count":358,"subscribers_count":58,"default_branch":"master","last_synced_at":"2025-01-16T00:33:51.633Z","etag":null,"topics":["cordova","cplusplus","csharp","java","javascript","library","mobile","nodejs","objective-c"],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-09T07:00:05.000Z","updated_at":"2024-12-11T19:59:11.000Z","dependencies_parsed_at":"2023-01-13T11:32:11.555Z","dependency_job_id":null,"html_url":"https://github.com/apache/cordova-plugin-wkwebview-engine","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-wkwebview-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-wkwebview-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-wkwebview-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-wkwebview-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/cordova-plugin-wkwebview-engine/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235669382,"owners_count":19026815,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cordova","cplusplus","csharp","java","javascript","library","mobile","nodejs","objective-c"],"created_at":"2024-08-04T00:01:26.029Z","updated_at":"2025-10-08T00:31:59.652Z","avatar_url":"https://github.com/apache.png","language":"Objective-C","readme":"\u003c!--\n# license: Licensed to the Apache Software Foundation (ASF) under one\n#         or more contributor license agreements.  See the NOTICE file\n#         distributed with this work for additional information\n#         regarding copyright ownership.  The ASF licenses this file\n#         to you under the Apache License, Version 2.0 (the\n#         \"License\"); you may not use this file except in compliance\n#         with the License.  You may obtain a copy of the License at\n#\n#           http://www.apache.org/licenses/LICENSE-2.0\n#\n#         Unless required by applicable law or agreed to in writing,\n#         software distributed under the License is distributed on an\n#         \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n#         KIND, either express or implied.  See the License for the\n#         specific language governing permissions and limitations\n#         under the License.\n--\u003e\n\n|AppVeyor|Travis CI|\n|:-:|:-:|\n|[![Build status](https://ci.appveyor.com/api/projects/status/github/apache/cordova-plugin-wkwebview-engine?branch=master)](https://ci.appveyor.com/project/ApacheSoftwareFoundation/cordova-plugin-wkwebview-engine)|[![Build Status](https://travis-ci.org/apache/cordova-plugin-wkwebview-engine.svg?branch=master)](https://travis-ci.org/apache/cordova-plugin-wkwebview-engine)|\n\nCordova WKWebView Engine\n======\n\nThis plugin makes `Cordova` use the `WKWebView` component instead of the default `UIWebView` component, and is installable only on a system with the iOS 9.0 SDK.\n\nIn iOS 9, Apple has fixed the [issue](http://www.openradar.me/18039024) present through iOS 8 where you cannot load locale files using file://, and must resort to using a local webserver. **However, you are still not able to use XHR from the file:// protocol without [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) enabled on your server.**\n\n### Deprecation Notice\n\nThis plugin is now deprecated as it's implementation has been moved to `cordova-ios` platform making this plugin redundent. When migrating to `cordova-ios@6`, you should remove this plugin.\n\nThis plugin should still work as is on `cordova-ios@5.1.1` for the foreseeable future, however it is recommended to remove this plugin and upgrade to `cordova-ios@6` or later.\n\nInstallation\n-----------\n\nThis plugin needs cordova-ios 4.0.0 - 5.x. This plugin is not supported on cordova-ios \u003e6.0.0.\n\nTo install the current release:\n\n    cordova create wkwvtest my.project.id wkwvtest\n    cd wkwvtest\n    cordova platform add ios@4\n    cordova plugin add cordova-plugin-wkwebview-engine\n\nTo test the development version:\n\n    cordova create wkwvtest my.project.id wkwvtest\n    cd wkwvtest\n    cordova platform add https://github.com/apache/cordova-ios.git#master\n    cordova plugin add https://github.com/apache/cordova-plugin-wkwebview-engine.git#master\n\nYou also must have at least Xcode 7 (iOS 9 SDK) installed. Check your Xcode version by running:\n\n    xcode-select --print-path\n\nRequired Permissions\n-----------\nWKWebView may not fully launch (the deviceready event may not fire) unless if the following is included in config.xml. This should already be installed by Cordova in your platform config.xml when the plugin is installed.\n\n#### config.xml\n\n```xml\n\u003cfeature name=\"CDVWKWebViewEngine\"\u003e\n  \u003cparam name=\"ios-package\" value=\"CDVWKWebViewEngine\" /\u003e\n\u003c/feature\u003e\n\n\u003cpreference name=\"CordovaWebViewEngine\" value=\"CDVWKWebViewEngine\" /\u003e\n```\n\nIf using `cordova-ios \u003e= 5.1.0`, it is recommended to include the following `preference` tag to only use the `WKWebView` which is a requirement for new App submissions to the AppStore:\n\n```xml\n\u003cpreference name=\"WKWebViewOnly\" value=\"true\" /\u003e\n```\n\nNotes\n------\nThis plugin creates a shared `WKProcessPool` which ensures the cookie sharing happens correctly across `WKWebView` instances. `CDVWKProcessPoolFactory` class can be used to obtain the shared `WKProcessPool` instance if app creates `WKWebView` outside of this plugin.\n\nOn an iOS 8 system, Apache Cordova during runtime will switch to using the UIWebView engine instead of using this plugin. If you want to use WKWebView on both iOS 8 and iOS 9 platforms, you will have to resort to using a local webserver.\n\nWe have an [experimental plugin](https://github.com/apache/cordova-plugins/tree/wkwebview-engine-localhost) that does this. You would use that plugin instead of this one.\n\nApplication Transport Security (ATS) in iOS 9\n-----------\n\nStarting with [cordova-cli 5.4.0](https://www.npmjs.com/package/cordova), it will support automatic conversion of the [\u0026lt;access\u0026gt;](http://cordova.apache.org/docs/en/edge/guide/appdev/whitelist/index.html) tags in config.xml to Application Transport Security [ATS](https://developer.apple.com/library/prerelease/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW33) directives.\n\nUpgrade to at least version 5.4.0 of the cordova-cli to use this new functionality.\n\nEnabling Navigation Gestures (\"Swipe Navigation\")\n-----------\n\nIn order to allow swiping backwards and forwards in browser history like Safari does, you can set the following preference in your `config.xml`:\n\n```xml\n\u003cpreference name=\"AllowBackForwardNavigationGestures\" value=\"true\" /\u003e\n```\n\nYou can also set this preference dynamically from JavaScript:\n\n```js\nwindow.WkWebView.allowsBackForwardNavigationGestures(true)\nwindow.WkWebView.allowsBackForwardNavigationGestures(false)\n```\n\nDisabling 3D Touch Link Previews\n-----------\n\nIn order to disable preview popups when hard pressing links in iOS, you can set the following preference in your `config.xml`:\n\n```xml\n\u003cpreference name=\"Allow3DTouchLinkPreview\" value=\"false\" /\u003e\n```\n\nLimitations\n--------\n\nIf you are upgrading from UIWebView, please note the limitations of using WKWebView as outlined in our [issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20labels%20%3D%20wkwebview-known-issues).\n\nApple Issues\n-------\n\nThe `AllowInlineMediaPlayback` preference will not work because of this [Apple bug](http://openradar.appspot.com/radar?id=6673091526656000). This bug [has been fixed](https://issues.apache.org/jira/browse/CB-11452) in [iOS 10](https://twitter.com/shazron/status/745546355796389889).\n\n\n\nSupported Platforms\n-------------------\n\n- iOS\n","funding_links":[],"categories":["Cordova plugins","Index"],"sub_categories":["Incompatible"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fcordova-plugin-wkwebview-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fcordova-plugin-wkwebview-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fcordova-plugin-wkwebview-engine/lists"}