Skip to content

Commit 1c4c238

Browse files
Feature: Add CSF Factory definePreview parameter types
1 parent 5b7054c commit 1c4c238

File tree

4 files changed

+26
-93
lines changed

4 files changed

+26
-93
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
},
1414
"devDependencies": {
1515
"@auto-it/released": "^11.3.0",
16-
"@storybook/addon-designs": "*",
16+
"@storybook/addon-designs": "workspace:*",
1717
"@storybook/addon-docs": "^10.0.0-0",
1818
"@storybook/react-vite": "^10.0.0-0",
1919
"@types/react": "^18.2.65",
@@ -29,4 +29,4 @@
2929
"typescript": "^5.9.2"
3030
},
3131
"packageManager": "pnpm@10.11.1+sha512.e519b9f7639869dc8d5c3c5dfef73b3f091094b0a006d7317353c72b124e80e1afd429732e28705ad6bfa1ee879c1fce46c128ccebd3192101f43dd67c667912"
32-
}
32+
}

packages/storybook-addon-designs/src/index.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
import { definePreviewAddon } from "storybook/internal/csf";
2+
13
import { PanelName, ParameterName } from "./constants";
24
import { Config } from "./config";
5+
import type { DesignTypes } from "./types";
36

47
/**
58
* Dumb function to ensure typings or enchance IDE auto completion.
@@ -10,3 +13,6 @@ export const config = (c: Config | Config[]) => c;
1013
* Useful exports for third party developers and advanced usages
1114
*/
1215
export { Config, ParameterName as PARAM_KEY, PanelName };
16+
export type { DesignTypes } from "./types";
17+
18+
export default () => definePreviewAddon<DesignTypes>({});
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import type { Config } from "./config";
2+
3+
export interface DesignParameters {
4+
/**
5+
* Design addon configuration for embedding design previews in the addon panel.
6+
*
7+
* Supports Figma, Sketch, images, iframes, and links.
8+
*
9+
* @see https://github.com/storybookjs/addon-designs
10+
*/
11+
design?: Config | Config[];
12+
}
13+
14+
export interface DesignTypes {
15+
parameters: DesignParameters;
16+
}

pnpm-lock.yaml

Lines changed: 2 additions & 91 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)