Skip to content

chore: adjust suggestion action button position#7632

Merged
richardshiue merged 1 commit intoAppFlowy-IO:mainfrom
richardshiue:chore/suggestion-action-buttons
Mar 27, 2025
Merged

chore: adjust suggestion action button position#7632
richardshiue merged 1 commit intoAppFlowy-IO:mainfrom
richardshiue:chore/suggestion-action-buttons

Conversation

@richardshiue
Copy link
Copy Markdown
Collaborator

@richardshiue richardshiue commented Mar 27, 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

Enhancements:

  • Modify the logic for displaying suggested actions based on markdown text content and AI writer command

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Mar 27, 2025

Reviewer's Guide by Sourcery

This pull request modifies the conditions under which suggestion action buttons are displayed in the AI Writer block. The changes ensure that the buttons appear when the markdown text is empty or when the command is not 'explain', and within the text only when the command is 'explain'.

Sequence diagram for displaying suggestion action buttons

sequenceDiagram
  participant User
  participant AIWriterBlockComponent
  participant OverlayContent

  User->>AIWriterBlockComponent: Types in the editor
  activate AIWriterBlockComponent
  AIWriterBlockComponent->>OverlayContent: Rebuilds with showSuggestedActions, markdownText, command
  activate OverlayContent
  alt showSuggestedActions && markdownText.isEmpty || (markdownText.isNotEmpty && command != AiWriterCommand.explain)
    OverlayContent->>OverlayContent: Display suggestion action buttons (Popup)
  else showSuggestedActions && markdownText.isNotEmpty && command == AiWriterCommand.explain
    OverlayContent->>OverlayContent: Display suggestion action buttons (Within Text)
  else
    OverlayContent->>OverlayContent: Hide suggestion action buttons
  end
  deactivate OverlayContent
  deactivate AIWriterBlockComponent
Loading

File-Level Changes

Change Details Files
Adjusted the logic for displaying suggestion action buttons in the AI Writer block.
  • Modified the condition for showing suggested actions to include cases where the markdown text is not empty, but the command is not 'explain'.
  • Added a condition to specifically show suggested actions within the text when the markdown text is not empty and the command is 'explain'.
frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/ai/ai_writer_block_component.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. 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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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
Copy Markdown
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 @richardshiue - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The logic for showSuggestedActionsPopup and showSuggestedActionsWithin seems complex; consider simplifying it for better readability.
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.

@richardshiue richardshiue merged commit 9147f64 into AppFlowy-IO:main Mar 27, 2025
18 checks passed
@richardshiue richardshiue deleted the chore/suggestion-action-buttons branch March 27, 2025 03:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant