Skip to content

Addons: Remove @storybook/addon-storysource #31007

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

Merged
merged 8 commits into from
Apr 2, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
- [A11y addon: Removed deprecated manual parameter](#a11y-addon-removed-deprecated-manual-parameter)
- [Button Component API Changes](#button-component-api-changes)
- [Documentation Generation Changes](#documentation-generation-changes)
- [Migration from @storybook/addon-storysource to Code Panel](#migration-from-storybookaddon-storysource-to-code-panel)
- [Migration Steps](#migration-steps)
- [`parameters.docs.source.format` removal](#parametersdocssourceformat-removal)
- [Global State Management](#global-state-management)
- [Icon System Updates](#icon-system-updates)
Expand Down Expand Up @@ -520,6 +522,48 @@ export default {
+ };
```

### Migration from @storybook/addon-storysource to Code Panel

The `@storybook/addon-storysource` addon is being removed in Storybook 9.0. Instead, Storybook now provides a Code Panel via `@storybook/addon-docs` that offers similar functionality with improved integration and performance.

#### Migration Steps

1. Remove the old addon

Remove `@storybook/addon-storysource` from your project:

```bash
npx storybook remove @storybook/addon-storysource
```

2. Enable the Code Panel

The Code Panel can be enabled by adding the following parameter to your stories or globally in `.storybook/preview.js`:

```js
export const parameters = {
docs: {
source: {
codePanel: true,
},
},
};
```

Or for individual stories:

```js
export const MyStory = {
parameters: {
docs: {
source: {
codePanel: true,
},
},
},
};
```

### `parameters.docs.source.format` removal

The `parameters.docs.source.format` parameter has been removed in favor of using `parameters.docs.source.transform`. If you were using `format` to prettify your code via prettier, you can now use the `transform` parameter with Prettier directly:
Expand Down
1 change: 0 additions & 1 deletion code/.storybook/preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { global } from '@storybook/global';

import type { Decorator, Loader, ReactRenderer } from '@storybook/react-vite';
// TODO add empty preview
// import * as storysource from '@storybook/addon-storysource';
// import * as designs from '@storybook/addon-designs/preview';
import { definePreview } from '@storybook/react-vite';

Expand Down
101 changes: 0 additions & 101 deletions code/addons/storysource/README.md

This file was deleted.

Binary file removed code/addons/storysource/docs/demo.gif
Binary file not shown.
Binary file removed code/addons/storysource/docs/theming-light-dark.png
Binary file not shown.
1 change: 0 additions & 1 deletion code/addons/storysource/manager.js

This file was deleted.

86 changes: 0 additions & 86 deletions code/addons/storysource/package.json

This file was deleted.

1 change: 0 additions & 1 deletion code/addons/storysource/preset.js

This file was deleted.

8 changes: 0 additions & 8 deletions code/addons/storysource/project.json

This file was deleted.

Loading
Loading