update: added the BuildContext information to the documentation. #311
Conversation
WalkthroughThe pull request introduces updates to the Kinde Flutter SDK documentation, focusing on modifying the Changes
Suggested labels
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
src/content/docs/developer-tools/sdks/native/flutter-sdk.mdx (1)
Line range hint
677-678: Add documentation for the required context parameterThe
loginandregistermethods now require acontextparameter, but this is not documented in the API reference section. Please add the following to the method documentation:### `login` Constructs redirect url and sends user to Kinde to sign in. +**Arguments:** + +```dart +context: BuildContext // Required. The Flutter build context for navigation. +``` **Usage:** ```dart -sdk.login(); +sdk.login(context: context);
registerConstructs redirect url and sends user to Kinde to sign up.
+Arguments:
+
+dart +context: BuildContext // Required. The Flutter build context for navigation. +Usage:
-sdk.register(); +sdk.register(context: context);</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between cc8374aef8d269144fbe0f5c2381e492fd611634 and 56301fbe9a55e233e6c712572bbd11eb3c34e98c. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `src/content/docs/developer-tools/sdks/native/flutter-sdk.mdx` (1 hunks) </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| ```dart | ||
| ... | ||
| final String token = await sdk.login(); | ||
| // or sdk.login(type: AuthFlowType.pkce) for apply pkce flow | ||
| final String token = await sdk.login(context: content); | ||
| // or sdk.login(type: AuthFlowType.pkce, context: context) for apply pkce flow | ||
| ... | ||
| await sdk.register(); | ||
| // or sdk.register(type: AuthFlowType.pkce) for apply pkce flow | ||
| await sdk.register(context: context); | ||
| // or sdk.register(type: AuthFlowType.pkce, context: context) for apply pkce flow | ||
| ... |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add explanation for the BuildContext requirement
To help developers understand the change, please add an explanation of why BuildContext is required for the login and register methods. This aligns with the PR objective of documenting BuildContext additions.
Add the following explanation before the code examples:
+### Why BuildContext is required
+
+The `login` and `register` methods require a BuildContext parameter to handle navigation and display authentication UI properly within the Flutter widget tree. This ensures that the authentication flow integrates seamlessly with your app's navigation stack.
+
### R**edirect after authentication**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```dart | |
| ... | |
| final String token = await sdk.login(); | |
| // or sdk.login(type: AuthFlowType.pkce) for apply pkce flow | |
| final String token = await sdk.login(context: content); | |
| // or sdk.login(type: AuthFlowType.pkce, context: context) for apply pkce flow | |
| ... | |
| await sdk.register(); | |
| // or sdk.register(type: AuthFlowType.pkce) for apply pkce flow | |
| await sdk.register(context: context); | |
| // or sdk.register(type: AuthFlowType.pkce, context: context) for apply pkce flow | |
| ... | |
| ### Why BuildContext is required | |
| The `login` and `register` methods require a BuildContext parameter to handle navigation and display authentication UI properly within the Flutter widget tree. This ensures that the authentication flow integrates seamlessly with your app's navigation stack. | |
| ### R**edirect after authentication** | |
| final String token = await sdk.login(context: content); | ||
| // or sdk.login(type: AuthFlowType.pkce, context: context) for apply pkce flow |
There was a problem hiding this comment.
Fix typo in the login example
There's a typo in the parameter name. It should be context instead of content.
-final String token = await sdk.login(context: content);
+final String token = await sdk.login(context: context);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| final String token = await sdk.login(context: content); | |
| // or sdk.login(type: AuthFlowType.pkce, context: context) for apply pkce flow | |
| final String token = await sdk.login(context: context); | |
| // or sdk.login(type: AuthFlowType.pkce, context: context) for apply pkce flow |
Description (required)
Updated the documentation to reflect the required build context additions to login and register.
Related issues & labels (optional)
Summary by CodeRabbit
contextparameter for authentication methods