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

Eagle 1382 #815

Merged
merged 2 commits into from
Jan 20, 2025
Merged

Eagle 1382 #815

merged 2 commits into from
Jan 20, 2025

Conversation

M-Wicenec
Copy link
Collaborator

@M-Wicenec M-Wicenec commented Jan 20, 2025

clearing the table field editor selector when switching nodes

Summary by Sourcery

Clear the table field editor selector when switching nodes.

New Features:

  • Introduce a mechanism to clear table field selections in the parameter table.

Enhancements:

  • Reset table field selections when switching between nodes in the bottom window mode.

Copy link
Contributor

sourcery-ai bot commented Jan 20, 2025

Reviewer's Guide by Sourcery

The pull request modifies the ParameterTable component to reset the table field editor selector when switching nodes. This ensures that the field selection is cleared when a new node is selected, preventing potential confusion or errors.

Sequence diagram for table field selection reset when switching nodes

sequenceDiagram
    participant User
    participant ParameterTable
    participant Eagle

    User->>ParameterTable: Switch node selection
    ParameterTable->>Eagle: getInstance()
    Eagle-->>ParameterTable: eagle instance
    ParameterTable->>ParameterTable: getTableFields()
    ParameterTable->>ParameterTable: resetSelection()
    Note right of ParameterTable: Clear table field editor selector
    ParameterTable->>Eagle: Get selected node fields
    Eagle-->>ParameterTable: Updated fields
Loading

State diagram for table field editor selection

stateDiagram-v2
    [*] --> HasSelection: Select field
    HasSelection --> NoSelection: Switch node
    NoSelection --> HasSelection: Select new field
    NoSelection --> [*]
    HasSelection --> [*]
Loading

File-Level Changes

Change Details Files
Reset table field selections when the selected node changes.
  • Added a call to ParameterTable.resetSelection() within the getTableFields computed observable.
  • This ensures that the table field selections are reset whenever the selected node changes.
src/ParameterTable.ts

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

@M-Wicenec M-Wicenec merged commit 24ff5ba into master Jan 20, 2025
1 check passed
@M-Wicenec M-Wicenec deleted the eagle-1382 branch January 20, 2025 06:49
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 @M-Wicenec - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 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.

Comment on lines +160 to +161
//resets the table field selections used for the little editor at the top of the table
ParameterTable.resetSelection()
Copy link
Contributor

Choose a reason for hiding this comment

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

issue: Avoid side effects in computed functions - resetSelection() call should be moved elsewhere

Pure computed functions should only calculate and return values, not modify state. This could cause unexpected behavior as the function may be re-evaluated multiple times by the Knockout framework. Consider moving the resetSelection() call to a more appropriate location where state modifications are expected.

@@ -544,7 +547,7 @@

static openTable = (mode: Eagle.BottomWindowMode, selectType: ParameterTable.SelectType) : void => {
const eagle: Eagle = Eagle.getInstance();

//if a modal is open, closed it
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick (typo): Typo in comment: 'closed' should be 'close'

Suggested change
//if a modal is open, closed it
//if a modal is open, close it

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.

1 participant