You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@cordova.apache.org by "BBosman (via GitHub)" <gi...@apache.org> on 2023/03/22 14:14:33 UTC
[GitHub] [cordova-docs] BBosman opened a new pull request, #1291: docs(ios): document new InspectableWebview setting
BBosman opened a new pull request, #1291:
URL: https://github.com/apache/cordova-docs/pull/1291
### Platforms affected
iOS
### Motivation and Context
Adds documentation for the changes introduced in https://github.com/apache/cordova-ios/pull/1300 and https://github.com/apache/cordova-plugin-inappbrowser/pull/995.
### Description
Adds documentation for the `InspectableWebview` preference setting.
### Testing
English isn't my native language, so please feel free to suggest better wording.
### Checklist
- [ ] I've run the tests to see all new and existing tests pass
- [ ] I added automated test coverage as appropriate for this change
- [x] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
- [ ] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
- [x] I've updated the documentation if necessary
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] breautek commented on a diff in pull request #1291: docs(ios): document new InspectableWebview setting
Posted by "breautek (via GitHub)" <gi...@apache.org>.
breautek commented on code in PR #1291:
URL: https://github.com/apache/cordova-docs/pull/1291#discussion_r1161291140
##########
www/docs/en/dev/config_ref/index.md:
##########
@@ -311,6 +311,7 @@ GradlePluginKotlinEnabled (boolean) <br/> ==Android== | *Default: false* <br/>
GradlePluginKotlinCodeStyle (string) <br/> ==Android== | *Default: official* <br/> Allowed values: official, obsolete<br/> Sets how the Kotlin code is formatting for readability.
GradlePluginKotlinVersion (semver) <br/> ==Android== | *Default: 1.3.50* <br/> Set the version of the Kotlin Gradle plugin to be used.
InAppBrowserStorageEnabled (boolean) <br/> ==Android== | *Default: true* <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+InspectableWebview(boolean) <br/> ==iOS== | *Default: depends on Debug/Release build* <br/> As of iOS 16.4 the webview is no longer inspectable by default. Cordova now allows inspection on Debug builds, but not on Release builds by default. Set this to true to force inspectability regardless of build settings.
Review Comment:
Additionally, I just created a sister PR for the android (https://github.com/apache/cordova-android/pull/1589), so I think we can add the `==Android==` tag, if you don't mind
##########
www/docs/en/dev/config_ref/index.md:
##########
@@ -311,6 +311,7 @@ GradlePluginKotlinEnabled (boolean) <br/> ==Android== | *Default: false* <br/>
GradlePluginKotlinCodeStyle (string) <br/> ==Android== | *Default: official* <br/> Allowed values: official, obsolete<br/> Sets how the Kotlin code is formatting for readability.
GradlePluginKotlinVersion (semver) <br/> ==Android== | *Default: 1.3.50* <br/> Set the version of the Kotlin Gradle plugin to be used.
InAppBrowserStorageEnabled (boolean) <br/> ==Android== | *Default: true* <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+InspectableWebview(boolean) <br/> ==iOS== | *Default: depends on Debug/Release build* <br/> As of iOS 16.4 the webview is no longer inspectable by default. Cordova now allows inspection on Debug builds, but not on Release builds by default. Set this to true to force inspectability regardless of build settings.
Review Comment:
I feel like it's not clear enough that the setting only is honoured on 16.4 or later.
If I recall correctly, iOS 16.3 and earlier, regardless of iOS SDK used to build will always have the old behaviour (always inspectable when in debug mode, always disabled when n release mode).
Additionally, I feel like the current text is written more in a blog format. We don't need to explain the rationale here, we just need to document how to use the preference flag and potential nuances surrounding it.
```suggestion
InspectableWebview(boolean) <br/> ==Android== ==iOS== | *Default: depends on Debug/Release build* <br/> On iOS 16.4 or later, enables or disables the webview inspector. Defaults to `true` on debug builds and `false` on release builds. This preference is ignored on iOS 16.3 and earlier; the inspector is always enabled on debug builds and always disabled on release builds.
```
Don't feel like you need to accept this suggestion, I'm open to criticism or feedback.
Ref: https://webkit.org/blog/13936/enabling-the-inspection-of-web-content-in-apps/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] breautek merged pull request #1291: docs(ios): document new InspectableWebview setting
Posted by "breautek (via GitHub)" <gi...@apache.org>.
breautek merged PR #1291:
URL: https://github.com/apache/cordova-docs/pull/1291
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] breautek commented on a diff in pull request #1291: docs(ios): document new InspectableWebview setting
Posted by "breautek (via GitHub)" <gi...@apache.org>.
breautek commented on code in PR #1291:
URL: https://github.com/apache/cordova-docs/pull/1291#discussion_r1159866206
##########
www/docs/en/dev/config_ref/index.md:
##########
@@ -311,6 +311,7 @@ GradlePluginKotlinEnabled (boolean) <br/> ==Android== | *Default: false* <br/>
GradlePluginKotlinCodeStyle (string) <br/> ==Android== | *Default: official* <br/> Allowed values: official, obsolete<br/> Sets how the Kotlin code is formatting for readability.
GradlePluginKotlinVersion (semver) <br/> ==Android== | *Default: 1.3.50* <br/> Set the version of the Kotlin Gradle plugin to be used.
InAppBrowserStorageEnabled (boolean) <br/> ==Android== | *Default: true* <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+InspectableWebview(boolean) <br/> ==iOS== | *Default: depends on Debug/Release build* <br/> As of iOS 16.4 the webview is no longer inspectable by default. Cordova now allows inspection on Debug builds, but not on Release builds by default. Set this to true to force inspectability regardless of build settings.
Review Comment:
I feel like it's not clear enough that the setting only is honoured on 16.4 or later.
If I recall correctly, iOS 16.3 and earlier, regardless of iOS SDK used to build will always have the old behaviour (always inspectable when in debug mode, always disabled when n release mode).
Additionally, I feel like the current text is written more in a blog format. We don't need to explain the rationale here, we just need to document how to use the preference flag and potential nuances surrounding it.
```suggestion
InspectableWebview(boolean) <br/> ==iOS== | *Default: depends on Debug/Release build* <br/> On iOS 16.4 or later, enables or disables the webview inspector. Defaults to `true` on debug builds and `false` on release builds. This preference is ignored on iOS 16.3 and earlier; the inspector is always enabled on debug builds and always disabled on release builds.
```
Don't feel like you need to accept this suggestion, I'm open to criticism or feedback.
Ref: https://webkit.org/blog/13936/enabling-the-inspection-of-web-content-in-apps/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org