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

Dialog on_cancel #101

Merged
merged 1 commit into from
Dec 7, 2024
Merged

Dialog on_cancel #101

merged 1 commit into from
Dec 7, 2024

Conversation

DamascenoV
Copy link
Contributor

@DamascenoV DamascenoV commented Dec 6, 2024

Dialog with the same behavior that the modal core component of phoenix. In the case the user pass the on_cancel attribute it will execute the JS and then the phx-remove.
If the user don't pass we will keep the same behavior.

Before:

Gravacao.2024-12-06.183902.mp4

After:

Gravacao.2024-12-06.184308.mp4

Summary by Sourcery

New Features:

  • Introduce an 'on_cancel' attribute for the Dialog component to execute custom JavaScript before the default 'phx-remove' action.

Dialog with the same behavior that the modal core component of phoenix.
In the case the user pass the on_cancel attribute it will execute the JS
and then the phx-remove.
If the user don't pass we will keep the same behavior
Copy link

sourcery-ai bot commented Dec 6, 2024

Reviewer's Guide by Sourcery

This PR modifies the Dialog component to support an optional on_cancel callback that executes before the dialog is removed. The implementation changes how escape key and click-away events are handled to support this new behavior while maintaining backward compatibility.

Sequence diagram for Dialog on_cancel behavior

sequenceDiagram
    actor User
    participant Dialog
    participant JS

    User->>Dialog: Trigger escape key or click-away
    alt on_cancel is provided
        Dialog->>JS: Execute on_cancel
        JS-->>Dialog: on_cancel executed
    end
    Dialog->>JS: Execute phx-remove
    JS-->>Dialog: phx-remove executed
    Dialog-->>User: Dialog removed
Loading

File-Level Changes

Change Details Files
Added support for custom cancel callback in dialog component
  • Added data-cancel attribute that chains the custom callback with phx-remove
  • Updated escape key handler to trigger data-cancel instead of direct phx-hide-modal
  • Modified click-away behavior to execute data-cancel instead of direct phx-hide-modal
lib/salad_ui/dialog.ex

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

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

Overall Comments:

  • Please add tests to verify the new on_cancel callback behavior, including cases with and without the callback provided
  • Consider adding documentation for the new on_cancel attribute to help other developers understand its usage
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.

@bluzky
Copy link
Owner

bluzky commented Dec 7, 2024

LGTM

@bluzky bluzky merged commit 1835874 into bluzky:main Dec 7, 2024
3 checks passed
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