[webview_flutter] Document NavigationDelegate callbacks#11921
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation template for the NavigationDelegate constructor in packages/webview_flutter/webview_flutter/lib/src/navigation_delegate.dart to include descriptions for several callback parameters, including onNavigationRequest, onPageStarted, onPageFinished, onProgress, onWebResourceError, and onHttpError, while also making minor formatting adjustments to existing callback descriptions. There are no review comments, and I have no feedback to provide.
I'm not seeing this step in the PR. |
@stuartmorgan-g Thanks for pointing that out. I've updated the PR description to explain why I didn't include version or CHANGELOG updates, since this change only adds documentation for existing callbacks and does not modify package behavior. If public API documentation changes are expected to include versioning or CHANGELOG updates under the packages repository policy, I'm happy to add them. |
Could you let me know where you see that as a documented exception to the versioning policy? |
Thanks for the clarification. You're right that I couldn't find a documented exception covering public API dartdoc changes. I've updated the package version and added a CHANGELOG entry accordingly. |
|
Hi @stuartmorgan-g, just following up on this PR. I addressed the previous review feedback by updating the package version and adding a CHANGELOG entry. When you have a chance, I'd appreciate another look. Thanks! |
|
autosubmit label was removed for flutter/packages/11921, because - The status or check suite Mac_x64 ios_build_all_packages stable has failed. Please fix the issues identified (or deflake) before re-applying this label. |
|
autosubmit label was removed for flutter/packages/11921, because - The status or check suite Mac_x64 ios_build_all_packages stable has failed. Please fix the issues identified (or deflake) before re-applying this label. |
…r#189134) flutter/packages@92525f5...52d84d6 2026-07-08 engine-flutter-autoroll@skia.org Manual roll Flutter from 6995038 to 91939cc (48 revisions) (flutter/packages#12137) 2026-07-08 engine-flutter-autoroll@skia.org Manual roll Flutter from ca9f874 to 6995038 (44 revisions) (flutter/packages#12135) 2026-07-07 engine-flutter-autoroll@skia.org Manual roll Flutter from 0c80830 to ca9f874 (119 revisions) (flutter/packages#12081) 2026-07-07 43054281+camsim99@users.noreply.github.com Add code coverage presubmit test (flutter/packages#11942) 2026-07-07 brunovsiq@gmail.com [google_sign_in_android] Fix IllegalStateException on duplicate authorization result (flutter/packages#11984) 2026-07-07 saurabhmirajkar000@gmail.com [webview_flutter] Document NavigationDelegate callbacks (flutter/packages#11921) 2026-07-07 engine-flutter-autoroll@skia.org Roll Flutter (stable) from ad70ec4 to f94f4fc (8 revisions) (flutter/packages#12125) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
## Description Adds documentation for callback parameters accepted by `NavigationDelegate`. Previously, the constructor documentation only described `onUrlChange`, `onHttpAuthRequest`, and `onSslAuthError`, while other commonly used callbacks such as `onNavigationRequest`, `onPageStarted`, `onPageFinished`, `onProgress`, `onWebResourceError`, and `onHttpError` were undocumented. This change updates the NavigationDelegate constructor documentation to cover all supported callbacks and improves consistency in the existing descriptions. Fixes flutter/flutter#187780 ## Tests Tests are not needed because this is a documentation-only change. ## Version and CHANGELOG Updated the package version to `4.14.1` and added a CHANGELOG entry for the `NavigationDelegate` documentation improvements. ## Pre-Review Checklist **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
Description
Adds documentation for callback parameters accepted by
NavigationDelegate.Previously, the constructor documentation only described
onUrlChange,onHttpAuthRequest, andonSslAuthError, while other commonly used callbacks such asonNavigationRequest,onPageStarted,onPageFinished,onProgress,onWebResourceError, andonHttpErrorwere undocumented.This change updates the NavigationDelegate constructor documentation to cover all supported callbacks and improves consistency in the existing descriptions.
Fixes flutter/flutter#187780
Tests
Tests are not needed because this is a documentation-only change.
Version and CHANGELOG
Updated the package version to
4.14.1and added a CHANGELOG entry for theNavigationDelegatedocumentation improvements.Pre-Review Checklist
[shared_preferences]///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2