UI: Replace experimental_SIDEBAR_BOTTOM API with a status filter UI
#28693
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
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Replaced the experimental_SIDEBAR_BOTTOM API with a new status filter UI in the Storybook sidebar, enhancing the filtering capabilities for warnings and errors.
- New Event: Added
SET_FILTERevent incode/core/src/core-events/index.tsandcode/core/src/manager-api/modules/stories.tsfor filter synchronization. - New Components: Introduced
FilterToggle.tsxandSidebarBottom.tsxincode/core/src/manager/components/sidebar/for the new filtering UI. - Deprecated API: Removed
experimental_SIDEBAR_BOTTOMAPI and updated related files likeSidebar.tsxandSidebar.stories.tsx. - Story Definitions: Added stories for
FilterToggleandSidebarBottomcomponents tocode/core/src/manager/components/sidebar/. - Backward Compatibility: Deprecated
Addon_TypesEnumdefinition retained to prevent breaking older VTA versions.
10 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 257f53d. 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 1 targetSent with 💌 from NxCloud. |
yannbf
added
feature request
ui
ci:merged
yannbf
changed the title
experimental_SIDEBAR_BOTTOM API with a status filter UIexperimental_SIDEBAR_BOTTOM API with a status filter UI
yannbf
reviewed
Jul 23, 2024
yannbf
approved these changes
Jul 23, 2024
|
|
|
@ghengeveld can we make a canary and try this with different versions of VTA? |
This was referenced Jul 31, 2024
8 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.
Closes #28680
What I did
I copied over the SidebarBottom filtering UI from the Visual Tests Addon and made it a core Storybook Manager component. It now shows warnings and errors from any addon, so that both the VTA and Vitest addon can use it. Compared to the VTA filter UI, "Changes" are now labeled "Warnings" because that's a more generic name and matches the actual story status we're filtering on. Functionally there is no difference.
The
experimental_SIDEBAR_BOTTOMAPI is removed, though theAddon_TypesEnumdefinition is marked deprecated but kept to prevent older VTA versions from breaking. Similarly,experimental_SIDEBAR_TOPis marked deprecated. Defining aexperimental_SIDEBAR_BOTTOMcomponent simply doesn't do anything anymore. We can remove both enum types in Storybook 9.0.A new
SET_FILTERevent is emitted whenever a filter function is set (i.e. a filter is toggled). This can be used by the VTA's onboarding as it currently uses its own internal event. Unfortunately this means VTA onboarding will be broken when using an older VTA version with a newer Storybook version.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:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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 pull request has been released as version
0.0.0-pr-28693-sha-ed560db4. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-28693-sha-ed560db4 sandboxor in an existing project withnpx storybook@0.0.0-pr-28693-sha-ed560db4 upgrade.More information
0.0.0-pr-28693-sha-ed560db4sidebar-bottom-filtersed560db41721821184)To request a new release of this pull request, mention the
@storybookjs/coreteam.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=28693