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

Overhaul Component Library #343

Merged
merged 29 commits into from
Jul 18, 2024
Merged

Overhaul Component Library #343

merged 29 commits into from
Jul 18, 2024

Conversation

treo
Copy link
Contributor

@treo treo commented Jul 17, 2024

Description

When looking for a component in the library, it can be very helpful to see its documentation (if any) and a preview of the component node.

Without Docstring With Docstring Nested Workflow
image image image

This PR enables a documentation preview on hovering over a component. It also includes a change to the search functionality, such that the doc string is now also considered when searching for something.

While polishing the PR, I realized that it isn't all that hard now to show the nodes in the component library directly.

The last commit of this PR adds the functionality to toggle between the old style and the new style:
image

As we moved the refresh icon to a sub-menu, we also ensure that we don't need to click that button as often. Changes to python files in the xai_components directory, and compilation of xircuits files in that directory will both trigger an automatic refresh.

And as the old headers started to look somewhat out of place, they have a new minimalist look to them:
image

We had quite a bit of functionality on component libraries hidden behind a context menu previously. To make it more discoverable we have moved it to a button on the component library header, when the library is open, to not introduce .
image

Similarly, it wasn't quite obvious how to install additional libraries that are listed. Now that too is on a button.
image

Pull Request Type

  • Xircuits Core (Jupyterlab Related changes)
  • Xircuits Canvas (Custom RD Related changes)
  • Xircuits Component Library
  • Xircuits Project Template
  • Testing Automation
  • Documentation
  • Others (Please Specify)

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

Tested on?

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

Copy link

Binder 👈 Launch a binder notebook on branch XpressAI/xircuits/paul/component-library-docs

@treo treo changed the title Show documentation on Hover in Component Library Overhaul Component Library Jul 17, 2024
@treo treo merged commit efaea63 into master Jul 18, 2024
8 checks passed
@MFA-X-AI MFA-X-AI deleted the paul/component-library-docs branch July 22, 2024 17:33
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