-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
UI: Update sidebar status indicators and tooltips #28739
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
8 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit c6ebc2c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good to me, would be nice if there were tests for this. Could you write any sort of test? The stories are likely failing because of this line:
storybook/code/core/src/components/components/tooltip/TooltipLinkList.stories.tsx
Line 22 in bc6bd59
const child = Children.only(children) as ReactElement; |
@ghengeveld can you take a look in these two regressions: 1 - Does this make sense, given that this story doesn't have a status? I'd assume the element wouldn't be rendered and therefore not take space 2 - I don't think we discussed about how stories would look like in search, but the change caused effects in the search: |
Closes #28679
What I did
This updates the sidebar with new status indicators (⭕️ and⚠️ ) and tooltips.
Groups and components have an aggregate status and a tooltip summarizing the number of errors, warnings and pending statuses. Clicking one of these opens the first descendant story with that status.
Stories have their own aggregate status and a tooltip showing individual addons' statuses for this story. Clicking one of these selects the story and invokes the addon's
onClick
handler for this status, which would typically open its addon panel.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>
Greptile Summary
This update enhances the Storybook sidebar with new status indicators and tooltips for better user experience and interactivity.
code/core/src/manager/components/sidebar/StatusContext.tsx
: Introduced a new context and hook for managing and summarizing story statuses.code/core/src/manager/components/sidebar/Tree.tsx
: Added new status icons and tooltips, including logic for status aggregation and click handling.code/core/src/manager/components/sidebar/IconSymbols.tsx
: Updated to include new status indicators for errors, warnings, and a generic dot.code/core/src/components/components/tooltip/ListItem.tsx
: EnhancedItem
component withhref
andonClick
properties, and refactored for better readability.code/core/src/types/modules/api-stories.ts
: Added an optionalonClick
property toAPI_StatusObject
interface for interactive elements.