-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
CSF: Improve docs parameter types #31736
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
Conversation
|
View your CI Pipeline Execution ↗ for commit 4e63ee4.
☁️ Nx Cloud last updated this comment at |
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
1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 6 | 6 | 0 |
| Self size | 553 KB | 630 KB | 🚨 +77 KB 🚨 |
| Dependency size | 1.49 MB | 1.49 MB | 0 B |
| Bundle Size Analyzer | Link | Link |
storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 49 | 49 | 0 |
| Self size | 31.88 MB | 31.22 MB | 🎉 -661 KB 🎉 |
| Dependency size | 17.41 MB | 17.41 MB | 0 B |
| Bundle Size Analyzer | Link | Link |
@storybook/angular
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 209 | 208 | 🎉 -1 🎉 |
| Self size | 607 KB | 606 KB | 🎉 -549 B 🎉 |
| Dependency size | 29.79 MB | 29.78 MB | 🎉 -11 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/ember
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 205 | 208 | 🚨 +3 🚨 |
| Self size | 28 KB | 28 KB | 🎉 -179 B 🎉 |
| Dependency size | 28.92 MB | 28.94 MB | 🚨 +21 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/nextjs
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 531 | 534 | 🚨 +3 🚨 |
| Self size | 217 KB | 217 KB | 🎉 -10 B 🎉 |
| Dependency size | 58.89 MB | 58.91 MB | 🚨 +21 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/nextjs-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 128 | 127 | 🎉 -1 🎉 |
| Self size | 2.39 MB | 2.39 MB | 0 B |
| Dependency size | 22.11 MB | 22.10 MB | 🎉 -11 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-native-web-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 162 | 161 | 🎉 -1 🎉 |
| Self size | 35 KB | 35 KB | 🎉 -129 B 🎉 |
| Dependency size | 23.28 MB | 23.27 MB | 🎉 -11 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 121 | 120 | 🎉 -1 🎉 |
| Self size | 32 KB | 32 KB | 🎉 -97 B 🎉 |
| Dependency size | 20.22 MB | 20.21 MB | 🎉 -11 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-webpack5
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 286 | 284 | 🎉 -2 🎉 |
| Self size | 25 KB | 25 KB | 0 B |
| Dependency size | 43.65 MB | 43.64 MB | 🎉 -15 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
sb
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 50 | 50 | 0 |
| Self size | 1 KB | 1 KB | 0 B |
| Dependency size | 49.29 MB | 48.63 MB | 🎉 -661 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 324 | 324 | 0 |
| Self size | 235 KB | 244 KB | 🚨 +9 KB 🚨 |
| Dependency size | 99.88 MB | 98.82 MB | 🎉 -1.06 MB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 267 | 267 | 0 |
| Self size | 31 KB | 31 KB | 🎉 -209 B 🎉 |
| Dependency size | 82.77 MB | 82.11 MB | 🎉 -661 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
create-storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 1 | 1 | 0 |
| Self size | 12.53 MB | 12.13 MB | 🎉 -404 KB 🎉 |
| Dependency size | 98 KB | 98 KB | 0 B |
| Bundle Size Analyzer | Link | Link |
@storybook/preset-react-webpack
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 177 | 175 | 🎉 -2 🎉 |
| Self size | 24 KB | 24 KB | 🎉 -171 B 🎉 |
| Dependency size | 30.49 MB | 30.47 MB | 🎉 -15 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
Closes #
What I did
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-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
Enhanced documentation parameter system by adding type definitions for custom container components and table of contents configuration in
code/addons/docs/src/types.ts.containerproperty toDocsParametersinterface for custom docs container componentstocproperty toDocsParametersfor table of contents configurationDocsContainerPropsandTocParameters