Skip to content

Conversation

HalilFocic
Copy link

@HalilFocic HalilFocic commented Nov 13, 2024

Added logic to remove mxPopupMenu,mxWidow and mxTooltip classes before each render. This should not impact the functionality since graph initialization inside story will add them afterwards.

PR Checklist

  • Addresses an existing open issue: Partially fixes MenuStyle Story: the context menu (MaxPopupMenu) is always displayed #400
  • You have discussed this issue with the maintainers of maxGraph, and you are assigned to the issue.
  • The scope of the PR is sufficiently narrow to be examined in a single session. A PR covering several issues must be split into separate PRs. Do not create a large PR, otherwise it cannot be reviewed and you will be asked to split it later or the PR will be closed.
  • I have added tests to prove my fix is effective or my feature works. This can be done in the form of automatic tests in packages/core/_tests_ or a new or altered Storybook story in packages/html/stories (an existing story may also demonstrate the change).
  • I have provided screenshot/videos to demonstrate the change. If no releavant, explain why.
  • I have added or edited necessary documentation
  • The PR title follows the "Conventional Commits" guidelines.

Overview

Reason for this PR is issue #400. Basically Popups and Windows would stick when navigating from one story to another. Reason for this is lack of cleaning up the graph and properly destroying its resources while story is unmounting.

I found no ways in storybook to call something on story unmount but since we instatiate graph when running each story, we can remove the classes before running any story by selecting all elements that have specific mx class and removing them from DOM.

This is how issue looked before:

before.mov

After this change:

popup-after.mov

Also works properly with mxWindow inside Window story.

This probably fixes #400

Summary by CodeRabbit

  • Bug Fixes
    • Improved configuration reset process by removing specific UI elements during MaxGraph configuration reset.

Added logic to remove mxPopupMenu,mxWidow and mxTooltip classes before each render.
This should not impact the functionality since graph initialization inside story will add them afterwards.
@HalilFocic HalilFocic force-pushed the fix/menu-style-always-displayed-400 branch from 19cf4d6 to 73de056 Compare November 13, 2024 08:50
@tbouffard tbouffard added the bug Something isn't working label Nov 14, 2024
# Conflicts:
#	packages/html/.storybook/preview.ts
Copy link

coderabbitai bot commented Jan 2, 2025

Walkthrough

The changes introduce a new function, destroyUnreleasedElements, in the packages/html/.storybook/preview.ts file. This function is responsible for removing specific mxGraph elements, namely .mxPopupMenu and .mxWindow, from the document when transitioning between stories. The function is integrated into the decorators array of the preview object, ensuring that these elements are cleaned up as part of the story rendering process.

Changes

File Change Summary
packages/html/.storybook/preview.ts Added destroyUnreleasedElements function to remove .mxPopupMenu and .mxWindow elements during story rendering

Assessment against linked issues

Objective Addressed Explanation
Resolve context menu display issue [#400]

The changes effectively address the issue of persistent UI elements by removing the specified elements during the story rendering process, which should prevent context menus from remaining visible when switching between Storybook stories or demo pages.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14de710 and c96776f.

📒 Files selected for processing (1)
  • packages/html/.storybook/preview.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/html/.storybook/preview.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member

@tbouffard tbouffard left a comment

Choose a reason for hiding this comment

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

LGTM
Tested with the following stories

For the popup menu feature:

  • Events
  • MenuStyle

For the MaxWindow feature:

  • JsonData
  • UserObject

@tbouffard tbouffard merged commit d01a614 into maxGraph:main Jan 2, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MenuStyle Story: the context menu (MaxPopupMenu) is always displayed

2 participants