UI: Sidebar context menu addon API #29557
Conversation
…cting anything into context menu
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 7e43ecd. 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. |
code/core/src/components/components/tooltip/TooltipLinkList.tsx
Outdated
Show resolved
Hide resolved
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
14 file(s) reviewed, 16 comment(s)
Edit PR Review Bot Settings | Greptile
code/core/src/components/components/tooltip/TooltipLinkList.tsx
Outdated
Show resolved
Hide resolved
| @@ -133,7 +133,7 @@ const WithTooltipPure = ({ | |||
| {/* @ts-expect-error (non strict) */} | |||
| {typeof tooltip === 'function' ? tooltip({ onHide: () => onVisibleChange(false) }) : tooltip} | |||
| </Tooltip> | |||
| ); | |||
| ) : null; | |||
There was a problem hiding this comment.
This is an optimization that makes a lot of sense to me...
Why call a function which we will not use the returned JSX of?
| api.on(TESTING_MODULE_CRASH_REPORT, onCrashReport); | ||
| api.on(TESTING_MODULE_RUN_ALL_REQUEST, clearState); | ||
| api.on(TESTING_MODULE_PROGRESS_REPORT, onProgressReport); | ||
|
|
||
| return () => { | ||
| api.getChannel()?.off(TESTING_MODULE_CRASH_REPORT, onCrashReport); | ||
| api.getChannel()?.off(TESTING_MODULE_PROGRESS_REPORT, onProgressReport); | ||
| api.getChannel()?.off(TESTING_MODULE_RUN_ALL_REQUEST, clearState); | ||
| api.off(TESTING_MODULE_CRASH_REPORT, onCrashReport); | ||
| api.off(TESTING_MODULE_PROGRESS_REPORT, onProgressReport); | ||
| api.off(TESTING_MODULE_RUN_ALL_REQUEST, clearState); | ||
| }; |
There was a problem hiding this comment.
I'm considering moving this code into the state module as well.
Right now, every time testProviders changes (which happens a LOT due to that's where the state is), we unsubscribe and resubscribe.
It's technically possible to miss events during this short period.
| contextMenu?: ( | ||
| options: { | ||
| context: API_HashEntry; | ||
| state: Addon_TestProviderState<Details>; | ||
| }, | ||
| components: { ListItem: typeof ListItem } | ||
| ) => ReactNode; |
There was a problem hiding this comment.
This is the added API to Addon_TestProviderType.
I'm personally a bit on the fence about the components bit, as the user is likely to need more components anyway. Adding more is an option, but @JReinhold has stronger opinions on this than I do.
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 46 | 46 | 0 |
| Self size | 19.08 MB | 19.24 MB | 🚨 +169 KB 🚨 |
| Dependency size | 14.29 MB | 14.29 MB | 0 B |
| Bundle Size Analyzer | Link | Link |
storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 47 | 47 | 0 |
| Self size | 22 KB | 22 KB | 0 B |
| Dependency size | 33.37 MB | 33.53 MB | 🚨 +169 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
sb
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 48 | 48 | 0 |
| Self size | 1 KB | 1 KB | 0 B |
| Dependency size | 33.39 MB | 33.56 MB | 🚨 +169 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 390 | 390 | 0 |
| Self size | 482 KB | 482 KB | 0 B |
| Dependency size | 74.43 MB | 74.60 MB | 🚨 +169 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 270 | 270 | 0 |
| Self size | 612 KB | 612 KB | 0 B |
| Dependency size | 64.42 MB | 64.59 MB | 🚨 +169 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
create-storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 105 | 105 | 0 |
| Self size | 1.11 MB | 1.11 MB | 0 B |
| Dependency size | 42.37 MB | 42.54 MB | 🚨 +169 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
| if (options?.selection) { | ||
| const listOfFiles: string[] = []; | ||
|
|
||
| // TODO: get actual list and emit, this notification is for development purposes | ||
| fullAPI.addNotification({ | ||
| id: 'testing-module', | ||
|
|
||
| content: { | ||
| headline: 'Running tests', | ||
| subHeadline: `Running tests for ${listOfFiles} stories`, | ||
| }, | ||
| }); |
There was a problem hiding this comment.
We need to implement the subset-testProvider running here @JReinhold
…torybookjs/storybook into norbert/addon-api-context-menu
…js/storybook into norbert/addon-api-context-menu
What I did
Treecomponent to render a context menu, including statuses & contextMenu renderings from testProvidersmanager-apiChecklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I'll be adding this section as soon as we have alignment on this feature's implementation
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-storybook/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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam 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
Added context menu functionality to Storybook's sidebar, allowing addons to inject custom links and actions through a new experimental test provider API.
contextMenuproperty toAddon_TestProviderTypeincode/core/src/types/modules/addons.tsfor custom menu itemsuseContextMenuhook incode/core/src/manager/components/sidebar/Tree.tsxto manage hover/click statescode/core/src/manager-api/modules/experimental_testmodule.tsTooltipLinkListincode/core/src/components/components/tooltip/TooltipLinkList.tsxto support custom content renderingcode/addons/test/src/manager.tsx) for running tests via context menu