-
Notifications
You must be signed in to change notification settings - Fork 41
update: added the BuildContext information to the documentation. #311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update: added the BuildContext information to the documentation. #311
Conversation
WalkthroughThe pull request updates the Kinde Flutter SDK documentation by modifying the method signatures for Changes
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
login
andregister
methods now require acontext
parameter, 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);
register
Constructs 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 -->
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description (required)
Updated the documentation to reflect the required build context additions to login and register.
Related issues & labels (optional)
Summary by CodeRabbit
context
parameter for authentication methods