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.

Sign up for GitHub

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

Upgrade to Storybook 8 #228

Merged
merged 8 commits into from
Mar 11, 2024
Merged

Upgrade to Storybook 8 #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9643099
Update node version
Jan 16, 2024
64f115f
Update to React18; Update to SB8
Jan 16, 2024
7c0deff
Add missing typings
Jan 16, 2024
da5f745
Remove old mdx addon
Jan 16, 2024
cae3482
Update some stories to CSF3
Jan 16, 2024
bdf9c54
Temporarily remove broken addon
Jan 17, 2024
af66e45
Set version to 8 alpha
Jan 17, 2024
892e4ee
broaden version ranges
ndelangen Feb 20, 2024
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
2 changes: 1 addition & 1 deletion .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v16.15.1
v18.19.0
31,299 changes: 7,333 additions & 23,966 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
"release": "npm run release --workspace=@storybook/addon-designs"
},
"prettier": {},
"version": "7.0.0-beta.2"
"version": "8.0.0-alpha.1"
}
2 changes: 1 addition & 1 deletion packages/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@storybook/addon-designs-assets",
"version": "7.0.0-beta.2",
"version": "8.0.0-alpha.1",
"private": true
}
4 changes: 2 additions & 2 deletions packages/examples-tab/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "examples-tab",
"version": "7.0.0-beta.2",
"version": "8.0.0-alpha.1",
"private": true,
"dependencies": {
"examples": "7.0.0-beta.2"
"examples": "*"
},
"scripts": {
"storybook": "storybook dev -p 6007",
Expand Down
6 changes: 1 addition & 5 deletions packages/examples/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,8 @@ module.exports = {
"@storybook/addon-links",
"@storybook/addon-designs",
"@storybook/addon-docs",
"@storybook/addon-storysource",
"@storybook/addon-mdx-gfm",
"@storybook/addon-webpack5-compiler-swc",
],
features: {
babelModeV7: true,
},
core: {
disableTelemetry: true,
},
Expand Down
29 changes: 13 additions & 16 deletions packages/examples/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
{
"name": "examples",
"version": "7.0.0-beta.2",
"version": "8.0.0-alpha.1",
"private": true,
"dependencies": {
"react": "^17.0.0",
"react-dom": "^17.0.0"
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@babel/core": "^7.18.5",
"@babel/preset-env": "^7.18.2",
"@babel/preset-react": "^7.17.12",
"@babel/preset-typescript": "^7.17.12",
"@storybook/addon-actions": "^7.0.7",
"@storybook/addon-mdx-gfm": "^7.0.7",
"@storybook/addon-actions": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/addon-designs": "*",
"@storybook/addon-designs-assets": "*",
"@storybook/addon-docs": "^7.0.7",
"@storybook/addon-links": "^7.0.7",
"@storybook/addon-storysource": "^7.0.7",
"@storybook/addons": "^7.0.7",
"@storybook/blocks": "^7.0.7",
"@storybook/components": "^7.0.7",
"@storybook/mdx1-csf": "^1.0.0",
"@storybook/react": "^7.0.7",
"@storybook/react-webpack5": "^7.0.7",
"@storybook/theming": "^7.0.7",
"storybook": "^7.0.7"
"@storybook/addon-docs": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/addon-links": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/addon-storysource": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/blocks": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/components": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/react": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/react-webpack5": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/theming": "^8.0.0-alpha.10 || ^8.0.0",
"storybook": "^8.0.0-alpha.10 || ^8.0.0"
},
"scripts": {
"storybook": "storybook dev -p 6006",
Expand Down
75 changes: 40 additions & 35 deletions packages/examples/stories/docs/advanced/index.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,53 @@ import { config } from "@storybook/addon-designs";

import { Button } from "../../Button";

export default {
const meta = {
title: "Docs/Advanced usage",
};

export const setTabName = () => <Button>Button</Button>;
export default meta;

setTabName.parameters = {
design: config({
name: "Wireframe",
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
}),
};

export const embedMultipleDesigns = () => <Button>Button</Button>;

embedMultipleDesigns.parameters = {
design: config([
{
export const setTabName = {
render: () => <Button>Button</Button>,
parameters: {
design: config({
name: "Wireframe",
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
{
type: "link",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
]),
}),
},
};

export const setTabNames = () => <Button>Button</Button>;
export const embedMultipleDesigns = {
render: () => <Button>Button</Button>,
parameters: {
design: config([
{
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
{
type: "link",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
]),
},
};

setTabNames.parameters = {
design: config([
{
name: "Foo",
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
{
name: "Bar",
type: "link",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
]),
export const setTabNames = {
render: () => <Button>Button</Button>,
parameters: {
design: config([
{
name: "Foo",
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
{
name: "Bar",
type: "link",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
},
]),
},
};
75 changes: 39 additions & 36 deletions packages/examples/stories/docs/figma/examples.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,56 @@ import { config } from "@storybook/addon-designs";

import { Button } from "../../Button";

export default {
const meta = {
title: "Docs/Figma/Examples",
component: Button,
render: () => <Button>Button</Button>,
};

export const embedFile = () => <Button>Button</Button>;
export default meta;

embedFile.parameters = {
design: config({
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
}),
export const embedFile = {
parameters: {
design: config({
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
}),
},
};

export const embedFrame = () => <Button>Button</Button>;

embedFrame.parameters = {
design: config({
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample?node-id=2%3A5",
}),
export const embedFrame = {
parameters: {
design: config({
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample?node-id=2%3A5",
}),
},
};

export const embedPrivateFile = () => <Button>Button</Button>;

embedPrivateFile.parameters = {
design: config({
type: "figma",
url: "https://www.figma.com/file/WOpzYgwlTe1UV6MpJP6SMv/private-test",
}),
export const embedPrivateFile = {
parameters: {
design: config({
type: "figma",
url: "https://www.figma.com/file/WOpzYgwlTe1UV6MpJP6SMv/private-test",
}),
},
};

export const embedPrototype = () => <Button>Button</Button>;

embedPrototype.parameters = {
design: config({
type: "figma",
url: "https://www.figma.com/proto/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
}),
export const embedPrototype = {
parameters: {
design: config({
type: "figma",
url: "https://www.figma.com/proto/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
}),
},
};

export const allowFullscreen = () => <Button>Button</Button>;

allowFullscreen.parameters = {
design: config({
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
allowFullscreen: true,
}),
export const allowFullscreen = {
parameters: {
design: config({
type: "figma",
url: "https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample",
allowFullscreen: true,
}),
},
};
2 changes: 2 additions & 0 deletions packages/examples/stories/internal/blocks/1.design.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import React from "react";

export default {
title: "Internal/Blocks/Design",
};
Expand Down
31 changes: 16 additions & 15 deletions packages/storybook-addon-designs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-designs",
"version": "7.0.0--canary.ca11952.0",
"version": "8.0.0-alpha.1",
"description": "Storybook addon for embedding your design preview in addon panel",
"main": "cjs/index.js",
"module": "esm/index.js",
Expand All @@ -24,26 +24,27 @@
"devDependencies": {
"@auto-it/released": "^11.0.1",
"@figspec/components": "^1.0.0",
"@storybook/addon-docs": "^7.0.7",
"@storybook/components": "^7.0.7",
"@storybook/core-events": "^7.0.7",
"@storybook/manager-api": "^7.0.7",
"@storybook/preview-api": "^7.0.7",
"@storybook/theming": "^7.0.7",
"@types/react": "^17.0.0",
"@types/react-dom": "^17.0.0",
"@storybook/addon-docs": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/components": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/core-events": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/manager-api": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/preview-api": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/theming": "^8.0.0-alpha.10 || ^8.0.0",
"@types/react": "^18.2.0",
"@types/react-dom": "^18.2.0",
"@types/webpack-env": "^1.13.9",
"auto": "^11.0.1",
"figma-js": "^1.13.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"typescript": "^4.7.3"
},
"peerDependencies": {
"@storybook/addon-docs": "^7.0.0",
"@storybook/addons": "^7.0.0",
"@storybook/components": "^7.0.0",
"@storybook/manager-api": "^7.0.0",
"@storybook/preview-api": "^7.0.0",
"@storybook/theming": "^7.0.0",
"@storybook/addon-docs": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/components": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/manager-api": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/preview-api": "^8.0.0-alpha.10 || ^8.0.0",
"@storybook/theming": "^8.0.0-alpha.10 || ^8.0.0",
"react": "^16.8.0 || ^17.0.0 || ^18.0.0",
"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
},
Expand Down
2 changes: 2 additions & 0 deletions packages/storybook-addon-designs/src/blocks.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ export interface BlocksCommonProps {
*/
collapsable?: boolean;

children?: React.ReactNode;

/**
* **Doc Block Props**
*
Expand Down
2 changes: 1 addition & 1 deletion packages/storybook-addon-designs/src/register/components/ErrorBoundary.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type State =
error: unknown;
};

export class ErrorBoundary extends Component {
export class ErrorBoundary extends Component<{ children: React.ReactNode }> {
public state: State = { hasError: false };

static getDerivedStateFromError(error: unknown): State {
Expand Down
6 changes: 3 additions & 3 deletions packages/storybook-addon-designs/src/register/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ export default function register(renderTarget: "panel" | "tab") {
if (renderTarget === "tab") {
addons.add(PanelName, {
title: DEFAULT_TAB_NAME,
render({ active, key }) {
render({ active }) {
if (!active) {
// NOTE: Return type of render is `ReactElement`, hence returning `null` causes
// type error. I'm using `<noscript>` in place of `null`.
return <noscript key={key} />;
return <noscript />;
}

return (
<ErrorBoundary key={key}>
<ErrorBoundary>
<Wrapper active />
</ErrorBoundary>
);
Expand Down
Loading