Skip to content

Conversation

Aathish101
Copy link

@Aathish101 Aathish101 commented Oct 9, 2025

Feature Preview


PR Checklist

  • My code adheres to AppFlowy's Conventions
  • I've listed at least one issue that this PR fixes in the description above.
  • I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • All existing tests are passing.

Summary by Sourcery

Refactor settings_shortcuts_view.dart to enhance hover interactions, streamline layout, and improve keybinding editing behavior

Enhancements:

  • Refactor ResetButton to use FlowyHover builder with persistent hover state and custom hover style
  • Add hover‐dependent icon and text color changes for ResetButton
  • Adjust ShortcutSettingTile layout by adding mainAxisAlignment and mainAxisSize.min and removing unnecessary Expanded widgets
  • Introduce TapRegion onTapOutside to exit keybind edit mode
  • Simplify keybinding parsing and command conversion extensions
  • Remove redundant blank lines and perform general code cleanup

Copy link
Contributor

sourcery-ai bot commented Oct 9, 2025

Reviewer's Guide

This PR enhances hover interactions and refines the shortcuts settings UI by updating the ResetButton behavior, tightening layout in ShortcutSettingTile, and enforcing consistent const usage with formatting cleanup.

Class diagram for updated SettingsShortcutsView and related widgets

classDiagram
    class SettingsShortcutsView {
      +createState()
    }
    class _SettingsShortcutsViewState {
      -String _query
      -bool _isEditing
      +build(context)
    }
    SettingsShortcutsView --> _SettingsShortcutsViewState

    class _SearchBar {
      +onSearchChanged: void Function(String)?
      +build(context)
    }

    class _ResetButton {
      +onReset: void Function()?
      +build(context)
      +resetHoverOnRebuild: false
      +style: HoverStyle
    }

    class ShortcutSettingTile {
      +command: CommandShortcutEvent
      +onStartEditing: VoidCallback
      +onFinishEditing: VoidCallback
      +canStartEditing: bool Function()
      +createState()
    }
    class _ShortcutSettingTileState {
      -keybindController: TextEditingController
      -focusNode: FocusNode
      -isHovering: bool
      -isEditing: bool
      -canClickOutside: bool
      +initState()
      +dispose()
      +build(context)
      +_finishEditing()
      +_updateCommand()
      +_renderKeybindings(isHovering)
      +_renderKeybindEditor()
      +_toParts(binding: Keybinding): List<String>
    }
    ShortcutSettingTile --> _ShortcutSettingTileState

    class KeyBadge {
      +keyLabel: String
      +build(context)
      +iconData: FlowySvgData?
    }

    class FlowyHover {
      +resetHoverOnRebuild: bool
      +style: HoverStyle
      +builder: (context, isHovering)
    }

    class FlowyText {
      +regular(text, color)
    }

    class FlowySvg {
      +FlowySvg(svg, size, color)
    }

    class FlowyTextField {
      +controller: TextEditingController
      +focusNode: FocusNode
      +onSubmitted: Function
    }

    _ResetButton --> FlowyHover
    _ResetButton --> FlowySvg
    _ResetButton --> FlowyText
    _ShortcutSettingTileState --> FlowyTextField
    _ShortcutSettingTileState --> KeyBadge
    KeyBadge --> FlowySvg
Loading

File-Level Changes

Change Details Files
Enhanced ResetButton hover interaction and styling
  • Enabled FlowyHover resetHoverOnRebuild
  • Introduced HoverStyle with secondaryContainer hoverColor
  • Applied dynamic icon and text color based on hover state
frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_shortcuts_view.dart
Refined layout and hover actions in ShortcutSettingTile
  • Added MainAxisAlignment.spaceBetween for tile row
  • Removed redundant Expanded wrapper around keybindings
  • Set mainAxisSize to min for keybinding row
  • Grouped hover-only action icons under isHovering
frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_shortcuts_view.dart
Streamlined const usage and formatting
  • Prefixed Size.square instantiations with const
  • Removed extraneous blank lines and separators
  • Standardized widget spacing and padding
frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_shortcuts_view.dart

Possibly linked issues

  • docs: s/APGL/AGPL/ #123: PR fixes reset button hover effect and aligns shortcut key tiles using mainAxisAlignment: MainAxisAlignment.spaceBetween.

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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 there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_shortcuts_view.dart:396-400` </location>
<code_context>
           ],
-          const Spacer(),
-          if (isHovering)
+          if (isHovering) ...[
+            const HSpace(8),
             GestureDetector(
</code_context>

<issue_to_address>
**suggestion:** Conditional rendering of HSpace(8) only when hovering may cause layout shift.

To prevent layout jumps, keep the spacing consistent whether or not the component is hovered.

```suggestion
          const HSpace(8),
          if (isHovering)
            GestureDetector(
              onTap: () {
                if (widget.canStartEditing()) {
```
</issue_to_address>

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.

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