@storybook/types 8.1.0-alpha.8 → 8.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +10 -14
  2. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -1282,6 +1282,10 @@ type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
1282
1282
  * Define a custom render function for the story(ies). If not passed, a default render function by the renderer will be used.
1283
1283
  */
1284
1284
  render?: ArgsStoryFn<TRenderer, TArgs>;
1285
+ /**
1286
+ * Named tags for a story, used to filter stories in different contexts.
1287
+ */
1288
+ tags?: Tag$1[];
1285
1289
  };
1286
1290
  type ProjectAnnotations$1<TRenderer extends Renderer = Renderer, TArgs = Args> = BaseAnnotations<TRenderer, TArgs> & {
1287
1291
  argsEnhancers?: ArgsEnhancer<TRenderer, Args>[];
@@ -1363,10 +1367,6 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
1363
1367
  * Function that is executed after the story is rendered.
1364
1368
  */
1365
1369
  play?: PlayFunction<TRenderer, TArgs>;
1366
- /**
1367
- * Named tags for a story, used to filter stories in different contexts.
1368
- */
1369
- tags?: Tag$1[];
1370
1370
  }
1371
1371
  type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequiredArgs = Partial<TArgs>> = BaseAnnotations<TRenderer, TArgs> & {
1372
1372
  /**
@@ -1381,10 +1381,6 @@ type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequ
1381
1381
  * Function that is executed after the story is rendered.
1382
1382
  */
1383
1383
  play?: PlayFunction<TRenderer, TArgs>;
1384
- /**
1385
- * Named tags for a story, used to filter stories in different contexts.
1386
- */
1387
- tags?: Tag$1[];
1388
1384
  /** @deprecated */
1389
1385
  story?: Omit<StoryAnnotations<TRenderer, TArgs>, 'story'>;
1390
1386
  } & ({} extends TRequiredArgs ? {
@@ -1708,8 +1704,6 @@ type BaseIndexInput = {
1708
1704
  metaId?: MetaId;
1709
1705
  /** Tags for filtering entries in Storybook and its tools. */
1710
1706
  tags?: Tag$1[];
1711
- /** Tags from the meta for filtering entries in Storybook and its tools. */
1712
- metaTags?: Tag$1[];
1713
1707
  /**
1714
1708
  * The id of the entry, auto-generated from {@link title}/{@link metaId} and {@link exportName} if unspecified.
1715
1709
  * If specified, the story in the CSF file _must_ have a matching id set at `parameters.__id`, to be correctly matched.
@@ -1966,6 +1960,8 @@ type DocsOptions = {
1966
1960
  * Should we generate a docs entry per CSF file?
1967
1961
  * Set to 'tag' (the default) to generate an entry for every CSF file with the
1968
1962
  * 'autodocs' tag.
1963
+ *
1964
+ * @deprecated Use `tags: ['autodocs']` in `.storybook/preview.js` instead
1969
1965
  */
1970
1966
  autodocs?: boolean | 'tag';
1971
1967
  /**
@@ -2208,7 +2204,7 @@ interface API_BaseEntry {
2208
2204
  depth: number;
2209
2205
  name: string;
2210
2206
  refId?: string;
2211
- renderLabel?: (item: API_BaseEntry) => any;
2207
+ renderLabel?: (item: API_BaseEntry, api: any) => any;
2212
2208
  }
2213
2209
  interface API_RootEntry extends API_BaseEntry {
2214
2210
  type: 'root';
@@ -2392,7 +2388,7 @@ interface API_Provider<API> {
2392
2388
  renderPreview?: API_IframeRenderer;
2393
2389
  handleAPI(api: API): void;
2394
2390
  getConfig(): {
2395
- sidebar?: API_SidebarOptions;
2391
+ sidebar?: API_SidebarOptions<API>;
2396
2392
  theme?: ThemeVars;
2397
2393
  StoryMapper?: API_StoryMapper;
2398
2394
  [k: string]: any;
@@ -2440,11 +2436,11 @@ interface API_UI {
2440
2436
  }
2441
2437
  type API_PanelPositions = 'bottom' | 'right';
2442
2438
  type API_ActiveTabsType = 'sidebar' | 'canvas' | 'addons';
2443
- interface API_SidebarOptions {
2439
+ interface API_SidebarOptions<API = any> {
2444
2440
  showRoots?: boolean;
2445
2441
  filters?: Record<string, API_FilterFunction>;
2446
2442
  collapsedRoots?: string[];
2447
- renderLabel?: (item: API_HashEntry) => any;
2443
+ renderLabel?: (item: API_HashEntry, api: API) => any;
2448
2444
  }
2449
2445
  interface OnClearOptions {
2450
2446
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/types",
3
- "version": "8.1.0-alpha.8",
3
+ "version": "8.1.0-beta.1",
4
4
  "description": "Core Storybook TS Types",
5
5
  "keywords": [
6
6
  "storybook"
@@ -44,12 +44,12 @@
44
44
  "prep": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/bundle.ts"
45
45
  },
46
46
  "dependencies": {
47
- "@storybook/channels": "8.1.0-alpha.8",
47
+ "@storybook/channels": "8.1.0-beta.1",
48
48
  "@types/express": "^4.7.0",
49
49
  "file-system-cache": "2.3.0"
50
50
  },
51
51
  "devDependencies": {
52
- "@storybook/csf": "^0.1.6",
52
+ "@storybook/csf": "^0.1.7",
53
53
  "@types/fs-extra": "^11.0.1",
54
54
  "@types/node": "^18.0.0",
55
55
  "typescript": "^5.3.2"