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

Fahreza/context menu update #281

Merged
merged 17 commits into from
Jan 18, 2024
Merged

Fahreza/context menu update #281

merged 17 commits into from
Jan 18, 2024

Conversation

MFA-X-AI
Copy link
Member

Description

This PR introduces significant updates to the Xircuits context, enhancing both the workflow canvas and the tray widget.

Workflow Canvas Context Menu Improvements:

The right-click context menu for the workflow canvas has been refined. The available options now dynamically adjust based on the selected entity or entities. The table below summarizes the available options:

Canvas (No Entities) Node Nodes Parameter Node Link Links
Cut x x x x x x
Copy x x x x x x
Paste x x x x x x
Reload Node x x
Edit x
Open Script x
Delete x x x x x
Undo x
Redo x
Add Comment x

Tray Widget Context Window:

The tray widget now features a new context menu, which interacts with a new jupyter server endpoint handling library-related requests. The menu provides the following options:

  1. Install - Install the Xircuits component library from the library's requirement.txt.
  2. Show in File Explorer - Reveal component library in the Jupyter file explorer.
  3. See Readme - Search for a readme.md file in the component library directory.
  4. Show Example - Open a .xircuits canvas based on a set search logic.

Tray Context Menu

Refactoring and Organizational Changes:

This PR also addresses file organization and naming consistency. Files have been renamed and sorted into appropriate folders to maintain a consistent naming scheme across the project. This includes updating the locations and names of example files and readmes for all internal component libraries.

References

Issue #264

Pull Request Type

  • Xircuits Core (Jupyterlab Related changes)
  • Xircuits Canvas (Custom RD Related changes)
  • Xircuits Component Library
  • Xircuits Project Template
  • Testing Automation
  • Documentation
  • Others (Improvements in workflow and context menu)

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Tests

1. Test Updated Canvas Context Window
- Ensure that the spawned options are correct based on the appearance table.

2. Test Tray Widget Component Library
- Verify that the component library gets installed correctly.
- Test the 'Show in File Explorer' option to ensure it reveals the component library in the Jupyter file explorer.
- Test the 'See Readme' option to confirm that Xircuits correctly searches and displays a readme.md file from the component library directory.
- Test the 'Show Example' feature and confirms that it opens a .xircuits canvas, if it exists.

Tested on?

  • Windows
  • Linux Ubuntu
  • Centos
  • Mac
  • Others (State here -> xxx )

@MFA-X-AI MFA-X-AI merged commit 3609e6d into master Jan 18, 2024
8 checks passed
@MFA-X-AI MFA-X-AI deleted the fahreza/context-menu-update branch January 18, 2024 17:32
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