-
Notifications
You must be signed in to change notification settings - Fork 10
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We don't have an `i` icon anymore so there is no need to style it.
… in component directory
treo
changed the title
Show documentation on Hover in Component Library
Overhaul Component Library
Jul 17, 2024
… is inside the menu
MFA-X-AI
approved these changes
Jul 18, 2024
16 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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:
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:
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 .
Similarly, it wasn't quite obvious how to install additional libraries that are listed. Now that too is on a button.
Pull Request Type
Type of Change
Tested on?