Skip to content
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

Release: Prerelease 8.5.0-alpha.10 #29691

Merged
merged 20 commits into from
Nov 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
22164c1
Update docs to cover changes discussed in #22674
Oct 18, 2024
5667488
Starter documentation and snippet fixes
jonniebigodes Nov 17, 2024
c454698
More snippet fixes
jonniebigodes Nov 17, 2024
99c5d14
Additional fixes to docs and snippets
jonniebigodes Nov 21, 2024
8125c77
Revert misc change in the readmes
jonniebigodes Nov 21, 2024
e97dfc1
Address feedback
jonniebigodes Nov 21, 2024
72d7c82
Minor snippet fixes
jonniebigodes Nov 21, 2024
cbdfcb5
Merge branch 'next' into docs_fix_snippets_v3
jonniebigodes Nov 22, 2024
8c28786
Build: Add workaround resolution for Angular sandboxes
yannbf Nov 22, 2024
fa32c7b
Merge pull request #29690 from storybookjs/yann/fix-angular-sandboxes-ci
yannbf Nov 22, 2024
5b2efc2
Merge branch 'next' into docs_fix_snippets_v3
jonniebigodes Nov 22, 2024
726dd05
Additional cleanup
jonniebigodes Nov 22, 2024
7bd26fe
Update initializer function recommendations
rdebeasi Nov 22, 2024
146cd0e
Merge branch 'next' into docs-for-22674
rdebeasi Nov 22, 2024
896be2b
Merge pull request #29683 from storybookjs/docs_fix_snippets_v3
jonniebigodes Nov 22, 2024
b0e056c
Merge branch 'next' into docs-for-22674
jonniebigodes Nov 22, 2024
786e328
Merge pull request #29397 from rdebeasi/docs-for-22674
jonniebigodes Nov 22, 2024
f70e832
Docs: Set init/upgrade snippets to next on next
shilman Nov 23, 2024
8b454ee
Merge pull request #29696 from storybookjs/shilman/docs-init-upgrade-…
shilman Nov 23, 2024
7704692
Write changelog for 8.5.0-alpha.10 [skip ci]
storybook-bot Nov 23, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions CHANGELOG.prerelease.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 8.5.0-alpha.10

- Addon Test: Use pathe for better windows support - [#29676](https://github.com/storybookjs/storybook/pull/29676), thanks @yannbf!
- Angular: Default to standalone components in Angular v19 - [#29677](https://github.com/storybookjs/storybook/pull/29677), thanks @ingowagner!

## 8.5.0-alpha.9

- Angular: Support v19 - [#29659](https://github.com/storybookjs/storybook/pull/29659), thanks @leosvelperez!
Expand Down
38 changes: 24 additions & 14 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,17 +105,17 @@
- [Tab addons cannot manually route, Tool addons can filter their visibility via tabId](#tab-addons-cannot-manually-route-tool-addons-can-filter-their-visibility-via-tabid)
- [Removed `config` preset](#removed-config-preset-1)
- [From version 7.5.0 to 7.6.0](#from-version-750-to-760)
- [CommonJS with Vite is deprecated](#commonjs-with-vite-is-deprecated)
- [Using implicit actions during rendering is deprecated](#using-implicit-actions-during-rendering-is-deprecated)
- [typescript.skipBabel deprecated](#typescriptskipbabel-deprecated)
- [Primary doc block accepts of prop](#primary-doc-block-accepts-of-prop)
- [Addons no longer need a peer dependency on React](#addons-no-longer-need-a-peer-dependency-on-react)
- [CommonJS with Vite is deprecated](#commonjs-with-vite-is-deprecated)
- [Using implicit actions during rendering is deprecated](#using-implicit-actions-during-rendering-is-deprecated)
- [typescript.skipBabel deprecated](#typescriptskipbabel-deprecated)
- [Primary doc block accepts of prop](#primary-doc-block-accepts-of-prop)
- [Addons no longer need a peer dependency on React](#addons-no-longer-need-a-peer-dependency-on-react)
- [From version 7.4.0 to 7.5.0](#from-version-740-to-750)
- [`storyStoreV6` and `storiesOf` is deprecated](#storystorev6-and-storiesof-is-deprecated)
- [`storyIndexers` is replaced with `experimental_indexers`](#storyindexers-is-replaced-with-experimental_indexers)
- [`storyStoreV6` and `storiesOf` is deprecated](#storystorev6-and-storiesof-is-deprecated)
- [`storyIndexers` is replaced with `experimental_indexers`](#storyindexers-is-replaced-with-experimental_indexers)
- [From version 7.0.0 to 7.2.0](#from-version-700-to-720)
- [Addon API is more type-strict](#addon-api-is-more-type-strict)
- [Addon-controls hideNoControlsWarning parameter is deprecated](#addon-controls-hidenocontrolswarning-parameter-is-deprecated)
- [Addon API is more type-strict](#addon-api-is-more-type-strict)
- [Addon-controls hideNoControlsWarning parameter is deprecated](#addon-controls-hidenocontrolswarning-parameter-is-deprecated)
- [From version 6.5.x to 7.0.0](#from-version-65x-to-700)
- [7.0 breaking changes](#70-breaking-changes)
- [Dropped support for Node 15 and below](#dropped-support-for-node-15-and-below)
Expand All @@ -141,7 +141,7 @@
- [Deploying build artifacts](#deploying-build-artifacts)
- [Dropped support for file URLs](#dropped-support-for-file-urls)
- [Serving with nginx](#serving-with-nginx)
- [Ignore story files from node\_modules](#ignore-story-files-from-node_modules)
- [Ignore story files from node_modules](#ignore-story-files-from-node_modules)
- [7.0 Core changes](#70-core-changes)
- [7.0 feature flags removed](#70-feature-flags-removed)
- [Story context is prepared before for supporting fine grained updates](#story-context-is-prepared-before-for-supporting-fine-grained-updates)
Expand All @@ -155,7 +155,7 @@
- [Addon-interactions: Interactions debugger is now default](#addon-interactions-interactions-debugger-is-now-default)
- [7.0 Vite changes](#70-vite-changes)
- [Vite builder uses Vite config automatically](#vite-builder-uses-vite-config-automatically)
- [Vite cache moved to node\_modules/.cache/.vite-storybook](#vite-cache-moved-to-node_modulescachevite-storybook)
- [Vite cache moved to node_modules/.cache/.vite-storybook](#vite-cache-moved-to-node_modulescachevite-storybook)
- [7.0 Webpack changes](#70-webpack-changes)
- [Webpack4 support discontinued](#webpack4-support-discontinued)
- [Babel mode v7 exclusively](#babel-mode-v7-exclusively)
Expand All @@ -167,6 +167,7 @@
- [Angular: Drop support for calling Storybook directly](#angular-drop-support-for-calling-storybook-directly)
- [Angular: Application providers and ModuleWithProviders](#angular-application-providers-and-modulewithproviders)
- [Angular: Removed legacy renderer](#angular-removed-legacy-renderer)
- [Angular: initializer functions](#angular-initializer-functions)
- [Next.js: use the `@storybook/nextjs` framework](#nextjs-use-the-storybooknextjs-framework)
- [SvelteKit: needs the `@storybook/sveltekit` framework](#sveltekit-needs-the-storybooksveltekit-framework)
- [Vue3: replaced app export with setup](#vue3-replaced-app-export-with-setup)
Expand Down Expand Up @@ -205,7 +206,7 @@
- [Dropped addon-docs manual babel configuration](#dropped-addon-docs-manual-babel-configuration)
- [Dropped addon-docs manual configuration](#dropped-addon-docs-manual-configuration)
- [Autoplay in docs](#autoplay-in-docs)
- [Removed STORYBOOK\_REACT\_CLASSES global](#removed-storybook_react_classes-global)
- [Removed STORYBOOK_REACT_CLASSES global](#removed-storybook_react_classes-global)
- [7.0 Deprecations and default changes](#70-deprecations-and-default-changes)
- [storyStoreV7 enabled by default](#storystorev7-enabled-by-default)
- [`Story` type deprecated](#story-type-deprecated)
Expand Down Expand Up @@ -430,7 +431,7 @@ These APIs allowed addons to render arbitrary content in the Storybook sidebar.

> [!NOTE]
> You need to set the feature flag `backgroundsStoryGlobals` to `true` in your `.storybook/main.ts` to use the new format and set the value with `globals`.
>
>
> See here how to set feature flags: https://storybook.js.org/docs/api/main-config/main-config-features

The `addon-backgrounds` addon now uses a new format for configuring its list of selectable backgrounds.
Expand Down Expand Up @@ -476,7 +477,7 @@ This locks that story to the `twitter` background, it cannot be changed by the a

> [!NOTE]
> You need to set the feature flag `viewportStoryGlobals` to `true` in your `.storybook/main.ts` to use the new format and set the value with `globals`.
>
>
> See here how to set feature flags: https://storybook.js.org/docs/api/main-config/main-config-features

The `addon-viewport` addon now uses a new format for configuring its list of selectable viewports.
Expand Down Expand Up @@ -2579,6 +2580,15 @@ Please visit https://angular.io/guide/standalone-components#configuring-dependen

The `parameters.angularLegacyRendering` option is removed. You cannot use the old legacy renderer anymore.

#### Angular: Initializer functions

Initializer functions using the `APP_INITIALIZER` dependency injection token only run when the component renders. To ensure an initializer function is always executed, you can adjust your `.storybook/preview.ts` and invoke it directly.

```js
myCustomInitializer();
export default preview;
```

#### Next.js: use the `@storybook/nextjs` framework

In Storybook 7.0 we introduced a convenient package that provides an out of the box experience for Next.js projects: `@storybook/nextjs`. Please see the [following resource](./code/frameworks/nextjs/README.md#getting-started) to get started with it.
Expand Down
3 changes: 2 additions & 1 deletion code/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -293,5 +293,6 @@
"Dependency Upgrades"
]
]
}
},
"deferredNextVersion": "8.5.0-alpha.10"
}
Binary file not shown.
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/_snippets/add-localize-package-to-polyfills.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/_snippets/addon-actions-action-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,3 @@ const meta: Meta {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-backgrounds-grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-consume-and-update-globaltype.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ const ExampleToolbar = () => {
);
};
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-consume-globaltype.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ const ThemePanel = (props) => {
);
};
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-highlight-reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,4 +240,3 @@ export const ResetHighlight: Story = {
],
};
```

2 changes: 1 addition & 1 deletion docs/_snippets/addon-test-install.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
```shell renderer="common" language="js" packageManager="npx"
```shell renderer="common" language="js" packageManager="npm"
npx storybook add @storybook/experimental-addon-test
```

Expand Down
1 change: 0 additions & 1 deletion docs/_snippets/angular-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ pnpm add --save-dev @storybook/angular
```shell renderer="angular" language="js" packageManager="yarn"
yarn add --dev @storybook/angular
```

1 change: 0 additions & 1 deletion docs/_snippets/angular-project-compodoc-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@
}
}
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-argtypes-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,3 @@ const meta: Meta<typeof Button> = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-canvas-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ export const Basic: Story = {
},
};
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-controls-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,3 @@ const meta: Meta = {

export default meta;
```

25 changes: 14 additions & 11 deletions docs/_snippets/api-doc-block-description-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { Meta, StoryObj } from '@storybook/angular';
import { Button } from './button.component';

/**
* # Button stories
* Button stories
* These stories showcase the button
*/
const meta: Meta<Button> = {
Expand All @@ -22,7 +22,7 @@ export default meta;
type Story = StoryObj<Button>;

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary: Story = {
Expand All @@ -40,7 +40,7 @@ export const Primary: Story = {
import { Button } from './Button';

/**
* # Button stories
* Button stories
* These stories showcase the button
*/
export default {
Expand All @@ -55,7 +55,7 @@ export default {
}

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary = {
Expand All @@ -76,7 +76,7 @@ import type { Meta, StoryObj } from '@storybook/your-framework';
import { Button } from './Button';

/**
* # Button stories
* Button stories
* These stories showcase the button
*/
const meta = {
Expand All @@ -94,7 +94,7 @@ export default meta;
type Story = StoryObj<typeof meta>

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary: Story = {
Expand All @@ -115,7 +115,7 @@ import type { Meta, StoryObj } from '@storybook/your-framework';
import { Button } from './Button';

/**
* # Button stories
* Button stories
* These stories showcase the button
*/
const meta: Meta<typeof Button> = {
Expand All @@ -133,7 +133,7 @@ export default meta;
type Story = StoryObj<typeof Button>;

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary: Story = {
Expand All @@ -148,6 +148,10 @@ export const Primary: Story = {
```

```js filename="Button.stories.js" renderer="web-components" language="js"
/**
* Button stories
* These stories showcase the button
*/
export default {
title: 'Button',
component: 'demo-button',
Expand Down Expand Up @@ -179,7 +183,7 @@ export const Primary = {
import type { Meta, StoryObj } from '@storybook/web-components';

/**
* # Button stories
* Button stories
* These stories showcase the button
*/
const meta: Meta = {
Expand All @@ -198,7 +202,7 @@ export default meta;
type Story = StoryObj;

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary: Story = {
Expand All @@ -211,4 +215,3 @@ export const Primary: Story = {
},
};
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-source-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ export const Basic: Story = {
},
};
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-story-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ export const Basic: Story = {
},
};
```

38 changes: 0 additions & 38 deletions docs/_snippets/apollo-module.md

This file was deleted.

Loading
Loading