Skip to content
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

refactor: use global scaffoldMessengerKey to display SnackBar #1137

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

ZauberNerd
Copy link
Contributor

@ZauberNerd ZauberNerd commented Jan 3, 2025

Based on: https://medium.com/@rodrigorivasdev/using-scaffoldmessenger-with-key-d626b465a483

Summary by Sourcery

Use a global key to access the ScaffoldMessenger for displaying SnackBars.

New Features:

  • Introduced a new global key to access the ScaffoldMessenger.

Enhancements:

  • Removed the GlobalContextProvider and instead use a global key to access the ScaffoldMessenger.

Copy link
Contributor

sourcery-ai bot commented Jan 3, 2025

Reviewer's Guide by Sourcery

This PR refactors the way SnackBar messages are displayed by using a global scaffoldMessengerKey.

Sequence diagram for displaying SnackBar messages after refactor

sequenceDiagram
    participant App as MaterialApp
    participant Toast as ToastUtils
    participant Global as globals.scaffoldMessengerKey
    participant SM as ScaffoldMessenger

    App->>Global: Initialize scaffoldMessengerKey
    Toast->>Global: Access currentState
    Global->>SM: Get ScaffoldMessenger state
    Toast->>SM: showSnackBar(message)
    SM-->>Toast: Display SnackBar
Loading

Class diagram showing the refactored SnackBar display mechanism

classDiagram
    class ToastUtils {
        -showToast(String message)
    }

    class globals {
        +GlobalKey~ScaffoldMessengerState~ scaffoldMessengerKey
    }

    class MaterialApp {
        +GlobalKey~ScaffoldMessengerState~ scaffoldMessengerKey
    }

    ToastUtils ..> globals : uses
    MaterialApp --> globals : uses scaffoldMessengerKey

    note for ToastUtils "Now uses global scaffoldMessengerKey
instead of GlobalContextProvider"
    note for globals "New global utility for
ScaffoldMessenger state"
Loading

File-Level Changes

Change Details Files
Replaced the use of a global context with a global scaffoldMessengerKey for displaying SnackBar messages.
  • Removed the dependency on GlobalContextProvider for accessing the context.
  • Used globals.scaffoldMessengerKey to display SnackBar messages.
  • Removed the calls to GlobalContextProvider.instance.setContext(context).
  • Added a global key scaffoldMessengerKey of type GlobalKey<ScaffoldMessengerState>.
  • Set the scaffoldMessengerKey in the MaterialApp widget.
lib/bademagic_module/utils/toast_utils.dart
lib/view/draw_badge_screen.dart
lib/view/homescreen.dart
lib/view/save_badge_screen.dart
lib/view/saved_clipart.dart
lib/main.dart
Created new file to hold global variables.
  • Created the file lib/globals/globals.dart.
  • Declared the scaffoldMessengerKey variable in the new file.
lib/globals/globals.dart

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ZauberNerd - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ZauberNerd ZauberNerd force-pushed the scaffoldmessengerkey branch from 6dfee96 to b70ad92 Compare January 3, 2025 20:13
@adityastic adityastic enabled auto-merge (squash) January 3, 2025 21:18
@adityastic adityastic merged commit 6c9c0df into fossasia:flutter_app Jan 3, 2025
5 checks passed
@ZauberNerd ZauberNerd deleted the scaffoldmessengerkey branch January 3, 2025 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants