storybook 9.0.0-alpha.9 → 9.0.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.
- package/assets/docs/addon-backgrounds.gif +0 -0
- package/assets/docs/addon-controls-args-annotated.png +0 -0
- package/assets/docs/addon-controls-args-background-color.png +0 -0
- package/assets/docs/addon-controls-args-background-string.png +0 -0
- package/assets/docs/addon-controls-args-docs.png +0 -0
- package/assets/docs/addon-controls-args-logging.png +0 -0
- package/assets/docs/addon-controls-args-no-annotation.png +0 -0
- package/assets/docs/addon-controls-args-reflow-slider.png +0 -0
- package/assets/docs/addon-controls-args-reflow.png +0 -0
- package/assets/docs/addon-controls-args-template.png +0 -0
- package/assets/docs/addon-controls-expanded.png +0 -0
- package/assets/docs/addon-controls-hero.gif +0 -0
- package/assets/docs/addon-controls-install.png +0 -0
- package/assets/docs/hero.gif +0 -0
- package/assets/docs/highlight.png +0 -0
- package/assets/docs/viewport.png +0 -0
- package/assets/server/base-preview-head.html +1 -3
- package/bin/index.cjs +2 -2
- package/dist/actions/decorator.js +67 -72
- package/dist/actions/index.cjs +27 -31
- package/dist/actions/index.d.ts +0 -3
- package/dist/actions/index.js +27 -31
- package/dist/actions/preview.cjs +23 -27
- package/dist/actions/preview.d.ts +0 -1
- package/dist/actions/preview.js +19 -23
- package/dist/babel/index.cjs +822 -816
- package/dist/babel/index.js +822 -816
- package/dist/backgrounds/index.cjs +148 -0
- package/dist/backgrounds/index.d.ts +91 -0
- package/dist/backgrounds/index.js +130 -0
- package/dist/backgrounds/preview.cjs +143 -0
- package/dist/backgrounds/preview.d.ts +54 -0
- package/dist/backgrounds/preview.js +127 -0
- package/dist/bin/index.cjs +73 -92
- package/dist/bin/index.js +66 -85
- package/dist/builder-manager/index.cjs +316 -296
- package/dist/builder-manager/index.js +567 -547
- package/dist/channels/index.cjs +1020 -950
- package/dist/channels/index.js +1256 -1201
- package/dist/cli/bin/index.cjs +198 -198
- package/dist/cli/bin/index.js +204 -204
- package/dist/cli/index.cjs +61735 -7589
- package/dist/cli/index.d.ts +24 -20
- package/dist/cli/index.js +61776 -7630
- package/dist/common/index.cjs +16133 -9095
- package/dist/common/index.d.ts +32 -24
- package/dist/common/index.js +16227 -9183
- package/dist/component-testing/index.cjs +23 -0
- package/dist/component-testing/index.d.ts +3 -0
- package/dist/component-testing/index.js +5 -0
- package/dist/component-testing/preview.cjs +40 -0
- package/dist/component-testing/preview.d.ts +5 -0
- package/dist/component-testing/preview.js +25 -0
- package/dist/components/index.cjs +6479 -13005
- package/dist/components/index.d.ts +8 -257
- package/dist/components/index.js +6160 -18689
- package/dist/controls/decorator.d.ts +5 -0
- package/dist/controls/decorator.js +8 -0
- package/dist/controls/index.cjs +26 -0
- package/dist/controls/index.d.ts +39 -0
- package/dist/controls/index.js +6 -0
- package/dist/controls/preview.cjs +26 -0
- package/dist/controls/preview.d.ts +54 -0
- package/dist/controls/preview.js +9 -0
- package/dist/core-events/index.cjs +91 -106
- package/dist/core-events/index.d.ts +2 -80
- package/dist/core-events/index.js +79 -94
- package/dist/core-server/index.cjs +12409 -12231
- package/dist/core-server/index.d.ts +32 -23
- package/dist/core-server/index.js +12567 -12389
- package/dist/core-server/presets/common-manager.css +170 -0
- package/dist/core-server/presets/common-manager.js +12153 -12
- package/dist/core-server/presets/common-preset.cjs +3004 -3151
- package/dist/core-server/presets/common-preset.js +2833 -2981
- package/dist/csf/index.d.ts +1 -3
- package/dist/csf-tools/index.cjs +412 -403
- package/dist/csf-tools/index.d.ts +0 -4
- package/dist/csf-tools/index.js +410 -401
- package/dist/docs-tools/index.cjs +2569 -575
- package/dist/docs-tools/index.js +2565 -564
- package/dist/highlight/index.cjs +27 -0
- package/dist/highlight/index.d.ts +61 -0
- package/dist/highlight/index.js +7 -0
- package/dist/highlight/preview.cjs +535 -0
- package/dist/highlight/preview.d.ts +54 -0
- package/dist/highlight/preview.js +519 -0
- package/dist/instrumenter/index.cjs +1411 -1758
- package/dist/instrumenter/index.d.ts +8 -7
- package/dist/instrumenter/index.js +1325 -1663
- package/dist/manager/globals-module-info.cjs +22 -33
- package/dist/manager/globals-module-info.js +7 -18
- package/dist/manager/globals-runtime.js +45452 -49541
- package/dist/manager/runtime.js +4392 -3774
- package/dist/manager-api/index.cjs +2622 -2529
- package/dist/manager-api/index.d.ts +109 -114
- package/dist/manager-api/index.js +2603 -2475
- package/dist/manager-errors.js +41 -37
- package/dist/measure/index.cjs +476 -0
- package/dist/measure/index.d.ts +66 -0
- package/dist/measure/index.js +464 -0
- package/dist/measure/preview.cjs +466 -0
- package/dist/measure/preview.d.ts +59 -0
- package/dist/measure/preview.js +450 -0
- package/dist/outline/index.cjs +528 -0
- package/dist/outline/index.d.ts +66 -0
- package/dist/outline/index.js +500 -0
- package/dist/outline/preview.cjs +518 -0
- package/dist/outline/preview.d.ts +59 -0
- package/dist/outline/preview.js +486 -0
- package/dist/preview/runtime.js +41973 -38159
- package/dist/preview-api/index.cjs +1204 -1293
- package/dist/preview-api/index.d.ts +126 -178
- package/dist/preview-api/index.js +1614 -1685
- package/dist/preview-errors.cjs +65 -51
- package/dist/preview-errors.d.ts +6 -2
- package/dist/preview-errors.js +176 -142
- package/dist/server-errors.cjs +160 -113
- package/dist/server-errors.d.ts +12 -2
- package/dist/server-errors.js +157 -110
- package/dist/telemetry/index.cjs +374 -370
- package/dist/telemetry/index.d.ts +1 -1
- package/dist/telemetry/index.js +460 -456
- package/dist/test/index.cjs +1553 -1552
- package/dist/test/index.js +9603 -9514
- package/dist/test/preview.cjs +1906 -1905
- package/dist/test/preview.d.ts +0 -6
- package/dist/test/preview.js +3664 -3603
- package/dist/test/spy.cjs +65 -64
- package/dist/test/spy.js +59 -58
- package/dist/types/index.cjs +11 -12
- package/dist/types/index.d.ts +601 -334
- package/dist/types/index.js +1 -2
- package/dist/viewport/index.cjs +310 -0
- package/dist/viewport/index.d.ts +320 -0
- package/dist/viewport/index.js +290 -0
- package/dist/viewport/preview.cjs +35 -0
- package/dist/viewport/preview.d.ts +68 -0
- package/dist/viewport/preview.js +19 -0
- package/package.json +207 -12
- package/dist/actions/manager.js +0 -1196
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Channel } from 'storybook/internal/channels';
|
|
2
2
|
import * as storybook_internal_types from 'storybook/internal/types';
|
|
3
|
-
import { ProjectAnnotations
|
|
4
|
-
import
|
|
5
|
-
import { CleanupCallback, Canvas, Renderer as Renderer$2, ProjectAnnotations as ProjectAnnotations$2, StoryIdentifier, StoryContext as StoryContext$1, PartialStoryFn as PartialStoryFn$1, LegacyStoryFn as LegacyStoryFn$1, StrictArgTypes as StrictArgTypes$1, StrictGlobalTypes, DecoratorFunction as DecoratorFunction$1, LoaderFunction, StepRunner as StepRunner$1, BeforeAll } from 'storybook/internal/csf';
|
|
3
|
+
import { ProjectAnnotations, Renderer, Args, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, StoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, LegacyStoryAnnotationsOrFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, StoryContextForEnhancers, Parameters, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas, ViewMode } from 'storybook/internal/types';
|
|
4
|
+
import { CleanupCallback, StoryContext as StoryContext$1, Args as Args$1 } from 'storybook/internal/csf';
|
|
6
5
|
import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
|
|
7
6
|
|
|
8
7
|
declare class AddonStore {
|
|
@@ -17,7 +16,7 @@ declare class AddonStore {
|
|
|
17
16
|
}
|
|
18
17
|
declare const addons: AddonStore;
|
|
19
18
|
|
|
20
|
-
declare function definePreview(config: ProjectAnnotations
|
|
19
|
+
declare function definePreview(config: ProjectAnnotations<Renderer>): ProjectAnnotations<Renderer>;
|
|
21
20
|
|
|
22
21
|
interface Hook {
|
|
23
22
|
name: string;
|
|
@@ -29,7 +28,7 @@ interface Effect {
|
|
|
29
28
|
destroy?: (() => void) | void;
|
|
30
29
|
}
|
|
31
30
|
type AbstractFunction = (...args: any[]) => any;
|
|
32
|
-
declare class HooksContext<TRenderer extends Renderer
|
|
31
|
+
declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args> {
|
|
33
32
|
hookListsMap: WeakMap<AbstractFunction, Hook[]>;
|
|
34
33
|
mountedDecorators: Set<AbstractFunction>;
|
|
35
34
|
prevMountedDecorators: Set<AbstractFunction>;
|
|
@@ -50,7 +49,7 @@ declare class HooksContext<TRenderer extends Renderer$1, TArgs extends Args = Ar
|
|
|
50
49
|
addRenderListeners(): void;
|
|
51
50
|
removeRenderListeners(): void;
|
|
52
51
|
}
|
|
53
|
-
declare const applyHooks: <TRenderer extends Renderer
|
|
52
|
+
declare const applyHooks: <TRenderer extends Renderer>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
54
53
|
/**
|
|
55
54
|
* Returns a memoized value.
|
|
56
55
|
*
|
|
@@ -216,7 +215,7 @@ declare function useChannel(eventMap: EventMap, deps?: any[]): (eventName: strin
|
|
|
216
215
|
* @template TArgs The type of the story's args.
|
|
217
216
|
* @returns {StoryContext<TRenderer>} The current story context.
|
|
218
217
|
*/
|
|
219
|
-
declare function useStoryContext<TRenderer extends Renderer
|
|
218
|
+
declare function useStoryContext<TRenderer extends Renderer, TArgs extends Args = Args>(): StoryContext<TRenderer>;
|
|
220
219
|
/**
|
|
221
220
|
* Returns the value of a specific parameter for the current story, or a default value if the
|
|
222
221
|
* parameter is not set.
|
|
@@ -352,16 +351,16 @@ declare class StoryIndexStore {
|
|
|
352
351
|
importPathToEntry(importPath: Path): IndexEntry;
|
|
353
352
|
}
|
|
354
353
|
|
|
355
|
-
declare function normalizeStory<TRenderer extends Renderer
|
|
354
|
+
declare function normalizeStory<TRenderer extends Renderer>(key: StoryId, storyAnnotations: StoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
356
355
|
|
|
357
|
-
declare function processCSFFile<TRenderer extends Renderer
|
|
356
|
+
declare function processCSFFile<TRenderer extends Renderer>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
|
|
358
357
|
|
|
359
|
-
declare function prepareStory<TRenderer extends Renderer
|
|
360
|
-
declare function prepareMeta<TRenderer extends Renderer
|
|
358
|
+
declare function prepareStory<TRenderer extends Renderer>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
|
|
359
|
+
declare function prepareMeta<TRenderer extends Renderer>(componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>, moduleExport: ModuleExport): PreparedMeta<TRenderer>;
|
|
361
360
|
|
|
362
|
-
declare function normalizeProjectAnnotations<TRenderer extends Renderer
|
|
361
|
+
declare function normalizeProjectAnnotations<TRenderer extends Renderer>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
|
|
363
362
|
|
|
364
|
-
declare function composeConfigs<TRenderer extends Renderer
|
|
363
|
+
declare function composeConfigs<TRenderer extends Renderer>(input: ModuleExports[]): NormalizedProjectAnnotations<TRenderer>;
|
|
365
364
|
|
|
366
365
|
/**
|
|
367
366
|
* Compose step runners to create a single step runner that applies each step runner in order.
|
|
@@ -374,8 +373,8 @@ declare function composeConfigs<TRenderer extends Renderer$1>(moduleExportList:
|
|
|
374
373
|
* step('label', () => {});
|
|
375
374
|
* ```
|
|
376
375
|
*
|
|
377
|
-
* ...and runs it. The prototypical example is from
|
|
378
|
-
*
|
|
376
|
+
* ...and runs it. The prototypical example is from `core/interactions` where the step runner will
|
|
377
|
+
* decorate all instrumented code inside the step with information about the label.
|
|
379
378
|
*
|
|
380
379
|
* In theory it is possible to have more than one addon that wants to run steps; they can be
|
|
381
380
|
* composed together in a similar fashion to decorators. In some ways step runners are like
|
|
@@ -387,16 +386,16 @@ declare function composeConfigs<TRenderer extends Renderer$1>(moduleExportList:
|
|
|
387
386
|
* @param stepRunners An array of StepRunner
|
|
388
387
|
* @returns A StepRunner that is the composition of the arguments
|
|
389
388
|
*/
|
|
390
|
-
declare function composeStepRunners<TRenderer extends Renderer
|
|
389
|
+
declare function composeStepRunners<TRenderer extends Renderer>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
391
390
|
|
|
392
391
|
declare global {
|
|
393
|
-
var globalProjectAnnotations: NormalizedProjectAnnotations
|
|
394
|
-
var defaultProjectAnnotations: ProjectAnnotations
|
|
392
|
+
var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
|
|
393
|
+
var defaultProjectAnnotations: ProjectAnnotations<any>;
|
|
395
394
|
}
|
|
396
|
-
declare function setDefaultProjectAnnotations<TRenderer extends Renderer
|
|
397
|
-
declare function setProjectAnnotations<TRenderer extends Renderer
|
|
398
|
-
declare function composeStory<TRenderer extends Renderer
|
|
399
|
-
declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations
|
|
395
|
+
declare function setDefaultProjectAnnotations<TRenderer extends Renderer = Renderer>(_defaultProjectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
396
|
+
declare function setProjectAnnotations<TRenderer extends Renderer = Renderer>(projectAnnotations: NamedOrDefaultProjectAnnotations<TRenderer> | NamedOrDefaultProjectAnnotations<TRenderer>[]): NormalizedProjectAnnotations<TRenderer>;
|
|
397
|
+
declare function composeStory<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(storyAnnotations: LegacyStoryAnnotationsOrFn<TRenderer>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>, defaultConfig?: ProjectAnnotations<TRenderer>, exportsName?: string): ComposedStoryFn<TRenderer, Partial<TArgs>>;
|
|
398
|
+
declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations<Renderer>, composeStoryFn?: ComposeStoryFn): {};
|
|
400
399
|
type WrappedStoryRef = {
|
|
401
400
|
__pw_type: 'jsx' | 'importRef';
|
|
402
401
|
};
|
|
@@ -412,14 +411,14 @@ declare function createPlaywrightTest<TFixture extends {
|
|
|
412
411
|
extend: any;
|
|
413
412
|
}>(baseTest: TFixture): TFixture;
|
|
414
413
|
|
|
415
|
-
declare function getCsfFactoryAnnotations<TRenderer extends Renderer
|
|
416
|
-
story:
|
|
417
|
-
meta: ComponentAnnotations<Renderer
|
|
418
|
-
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer
|
|
414
|
+
declare function getCsfFactoryAnnotations<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>): {
|
|
415
|
+
story: storybook_internal_types.StoryAnnotations<Renderer, Args>;
|
|
416
|
+
meta: ComponentAnnotations<Renderer, Args>;
|
|
417
|
+
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer>;
|
|
419
418
|
} | {
|
|
420
419
|
story: LegacyStoryAnnotationsOrFn<TRenderer>;
|
|
421
420
|
meta: ComponentAnnotations<TRenderer, TArgs> | undefined;
|
|
422
|
-
preview: ProjectAnnotations
|
|
421
|
+
preview: ProjectAnnotations<TRenderer> | undefined;
|
|
423
422
|
};
|
|
424
423
|
|
|
425
424
|
interface Report<T = unknown> {
|
|
@@ -433,10 +432,10 @@ declare class ReporterAPI {
|
|
|
433
432
|
addReport(report: Report): Promise<void>;
|
|
434
433
|
}
|
|
435
434
|
|
|
436
|
-
declare class StoryStore<TRenderer extends Renderer
|
|
435
|
+
declare class StoryStore<TRenderer extends Renderer> {
|
|
437
436
|
importFn: ModuleImportFn;
|
|
438
437
|
storyIndex: StoryIndexStore;
|
|
439
|
-
projectAnnotations: NormalizedProjectAnnotations
|
|
438
|
+
projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
|
|
440
439
|
userGlobals: GlobalsStore;
|
|
441
440
|
args: ArgsStore;
|
|
442
441
|
hooks: Record<StoryId, HooksContext<TRenderer>>;
|
|
@@ -445,8 +444,8 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
445
444
|
processCSFFileWithCache: typeof processCSFFile;
|
|
446
445
|
prepareMetaWithCache: typeof prepareMeta;
|
|
447
446
|
prepareStoryWithCache: typeof prepareStory;
|
|
448
|
-
constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations
|
|
449
|
-
setProjectAnnotations(projectAnnotations: ProjectAnnotations
|
|
447
|
+
constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations<TRenderer>);
|
|
448
|
+
setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
450
449
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
451
450
|
importFn?: ModuleImportFn;
|
|
452
451
|
storyIndex?: StoryIndex;
|
|
@@ -475,10 +474,10 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
475
474
|
getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
|
|
476
475
|
forceInitialArgs?: boolean | undefined;
|
|
477
476
|
}): {
|
|
478
|
-
args:
|
|
479
|
-
initialGlobals:
|
|
480
|
-
globalTypes: (
|
|
481
|
-
userGlobals:
|
|
477
|
+
args: storybook_internal_types.Args;
|
|
478
|
+
initialGlobals: storybook_internal_types.Globals;
|
|
479
|
+
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
480
|
+
userGlobals: storybook_internal_types.Globals;
|
|
482
481
|
reporting: ReporterAPI;
|
|
483
482
|
globals: {
|
|
484
483
|
[x: string]: any;
|
|
@@ -490,46 +489,36 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
490
489
|
subcomponents?: Record<string, (TRenderer & {
|
|
491
490
|
T: any;
|
|
492
491
|
})["component"]> | undefined;
|
|
493
|
-
parameters: Parameters;
|
|
494
|
-
initialArgs:
|
|
495
|
-
argTypes:
|
|
496
|
-
componentId:
|
|
497
|
-
title: ComponentTitle;
|
|
498
|
-
kind: ComponentTitle;
|
|
492
|
+
parameters: storybook_internal_types.Parameters;
|
|
493
|
+
initialArgs: storybook_internal_types.Args;
|
|
494
|
+
argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
|
|
495
|
+
componentId: storybook_internal_types.ComponentId;
|
|
496
|
+
title: storybook_internal_types.ComponentTitle;
|
|
497
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
499
498
|
id: StoryId;
|
|
500
|
-
name:
|
|
501
|
-
story:
|
|
502
|
-
tags:
|
|
499
|
+
name: storybook_internal_types.StoryName;
|
|
500
|
+
story: storybook_internal_types.StoryName;
|
|
501
|
+
tags: storybook_internal_types.Tag[];
|
|
503
502
|
moduleExport: storybook_internal_types.ModuleExport;
|
|
504
|
-
originalStoryFn:
|
|
505
|
-
undecoratedStoryFn:
|
|
506
|
-
unboundStoryFn:
|
|
507
|
-
applyLoaders: (context: StoryContext<TRenderer,
|
|
508
|
-
applyBeforeEach: (context: StoryContext<TRenderer,
|
|
509
|
-
applyAfterEach: (context: StoryContext<TRenderer,
|
|
510
|
-
playFunction?: ((context: StoryContext<TRenderer,
|
|
511
|
-
runStep:
|
|
512
|
-
mount: (context: StoryContext<TRenderer,
|
|
503
|
+
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
504
|
+
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
505
|
+
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
506
|
+
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
|
|
507
|
+
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<CleanupCallback[]>;
|
|
508
|
+
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
|
|
509
|
+
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
|
|
510
|
+
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
511
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
513
512
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
514
513
|
renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
|
|
515
514
|
usesMount: boolean;
|
|
516
|
-
storyGlobals:
|
|
517
|
-
} & Pick<
|
|
515
|
+
storyGlobals: storybook_internal_types.Globals;
|
|
516
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer, storybook_internal_types.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
518
517
|
addCleanupCallbacks(story: PreparedStory<TRenderer>, callbacks: CleanupCallback[]): void;
|
|
519
518
|
cleanupStory(story: PreparedStory<TRenderer>): Promise<void>;
|
|
520
519
|
extract(options?: {
|
|
521
520
|
includeDocsOnly?: boolean;
|
|
522
521
|
}): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
|
|
523
|
-
getSetStoriesPayload(): {
|
|
524
|
-
v: number;
|
|
525
|
-
globals: storybook_internal_csf.Globals;
|
|
526
|
-
globalParameters: {};
|
|
527
|
-
kindParameters: Parameters;
|
|
528
|
-
stories: Record<string, StoryContextForEnhancers<TRenderer, storybook_internal_csf.Args>>;
|
|
529
|
-
};
|
|
530
|
-
getStoriesJsonData: () => StoryIndexV3;
|
|
531
|
-
raw(): BoundStory<TRenderer>[];
|
|
532
|
-
fromId(storyId: StoryId): BoundStory<TRenderer> | null;
|
|
533
522
|
}
|
|
534
523
|
|
|
535
524
|
/**
|
|
@@ -540,11 +529,11 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
540
529
|
declare const combineParameters: (...parameterSets: (Parameters | undefined)[]) => Parameters;
|
|
541
530
|
|
|
542
531
|
type PropDescriptor = string[] | RegExp;
|
|
543
|
-
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<
|
|
532
|
+
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_types.Args>>;
|
|
544
533
|
|
|
545
|
-
declare const inferControls: ArgTypesEnhancer<Renderer
|
|
534
|
+
declare const inferControls: ArgTypesEnhancer<Renderer>;
|
|
546
535
|
|
|
547
|
-
declare function decorateStory<TRenderer extends Renderer
|
|
536
|
+
declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorator: DecoratorFunction<TRenderer>, bindWithContext: (storyFn: LegacyStoryFn<TRenderer>) => PartialStoryFn<TRenderer>): LegacyStoryFn<TRenderer>;
|
|
548
537
|
/**
|
|
549
538
|
* Currently StoryContextUpdates are allowed to have any key in the type. However, you cannot
|
|
550
539
|
* overwrite any of the build-it "static" keys.
|
|
@@ -553,7 +542,7 @@ declare function decorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStor
|
|
|
553
542
|
* @returns StoryContextUpdate
|
|
554
543
|
*/
|
|
555
544
|
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate): StoryContextUpdate;
|
|
556
|
-
declare function defaultDecorateStory<TRenderer extends Renderer
|
|
545
|
+
declare function defaultDecorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn<TRenderer>;
|
|
557
546
|
|
|
558
547
|
declare const combineArgs: (value: any, update: any) => Args;
|
|
559
548
|
|
|
@@ -562,7 +551,7 @@ declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStor
|
|
|
562
551
|
|
|
563
552
|
declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
|
|
564
553
|
|
|
565
|
-
declare class DocsContext<TRenderer extends Renderer
|
|
554
|
+
declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
|
|
566
555
|
channel: Channel;
|
|
567
556
|
protected store: StoryStore<TRenderer>;
|
|
568
557
|
renderStoryToElement: DocsContextProps<TRenderer>['renderStoryToElement'];
|
|
@@ -590,10 +579,10 @@ declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextPr
|
|
|
590
579
|
getStoryContext: (story: PreparedStory<TRenderer>) => {
|
|
591
580
|
loaded: {};
|
|
592
581
|
viewMode: string;
|
|
593
|
-
args:
|
|
594
|
-
initialGlobals:
|
|
595
|
-
globalTypes: (
|
|
596
|
-
userGlobals:
|
|
582
|
+
args: storybook_internal_types.Args;
|
|
583
|
+
initialGlobals: storybook_internal_types.Globals;
|
|
584
|
+
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
585
|
+
userGlobals: storybook_internal_types.Globals;
|
|
597
586
|
reporting: ReporterAPI;
|
|
598
587
|
globals: {
|
|
599
588
|
[x: string]: any;
|
|
@@ -605,30 +594,30 @@ declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextPr
|
|
|
605
594
|
subcomponents?: Record<string, (TRenderer & {
|
|
606
595
|
T: any;
|
|
607
596
|
})["component"]> | undefined;
|
|
608
|
-
parameters:
|
|
609
|
-
initialArgs:
|
|
610
|
-
argTypes:
|
|
611
|
-
componentId:
|
|
612
|
-
title:
|
|
613
|
-
kind:
|
|
597
|
+
parameters: storybook_internal_types.Parameters;
|
|
598
|
+
initialArgs: storybook_internal_types.Args;
|
|
599
|
+
argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
|
|
600
|
+
componentId: storybook_internal_types.ComponentId;
|
|
601
|
+
title: storybook_internal_types.ComponentTitle;
|
|
602
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
614
603
|
id: StoryId;
|
|
615
604
|
name: StoryName;
|
|
616
605
|
story: StoryName;
|
|
617
|
-
tags:
|
|
606
|
+
tags: storybook_internal_types.Tag[];
|
|
618
607
|
moduleExport: ModuleExport;
|
|
619
|
-
originalStoryFn:
|
|
620
|
-
undecoratedStoryFn:
|
|
621
|
-
unboundStoryFn:
|
|
622
|
-
applyLoaders: (context:
|
|
623
|
-
applyBeforeEach: (context:
|
|
624
|
-
applyAfterEach: (context:
|
|
625
|
-
playFunction?: ((context:
|
|
626
|
-
runStep:
|
|
627
|
-
mount: (context:
|
|
608
|
+
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
609
|
+
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
610
|
+
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
611
|
+
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
|
|
612
|
+
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<storybook_internal_types.CleanupCallback[]>;
|
|
613
|
+
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
|
|
614
|
+
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
|
|
615
|
+
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
616
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
628
617
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
629
618
|
renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
|
|
630
619
|
usesMount: boolean;
|
|
631
|
-
storyGlobals:
|
|
620
|
+
storyGlobals: storybook_internal_types.Globals;
|
|
632
621
|
allArgs: any;
|
|
633
622
|
argsByTarget: any;
|
|
634
623
|
unmappedArgs: any;
|
|
@@ -645,7 +634,7 @@ type RenderType = 'story' | 'docs';
|
|
|
645
634
|
* - Tracking the state of the rendering as it moves between preparing, rendering and tearing down.
|
|
646
635
|
* - Tracking what is rendered to know if a change requires re-rendering or teardown + recreation.
|
|
647
636
|
*/
|
|
648
|
-
interface Render<TRenderer extends Renderer
|
|
637
|
+
interface Render<TRenderer extends Renderer> {
|
|
649
638
|
type: RenderType;
|
|
650
639
|
id: StoryId;
|
|
651
640
|
isPreparing: () => boolean;
|
|
@@ -669,7 +658,7 @@ interface Render<TRenderer extends Renderer$1> {
|
|
|
669
658
|
*
|
|
670
659
|
* - Autodocs, where there is no story, and we fall back to the globally defined template.
|
|
671
660
|
*/
|
|
672
|
-
declare class CsfDocsRender<TRenderer extends Renderer
|
|
661
|
+
declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
673
662
|
protected channel: Channel;
|
|
674
663
|
protected store: StoryStore<TRenderer>;
|
|
675
664
|
entry: IndexEntry;
|
|
@@ -707,7 +696,7 @@ declare class CsfDocsRender<TRenderer extends Renderer$1> implements Render<TRen
|
|
|
707
696
|
*
|
|
708
697
|
* - *.mdx file that may or may not reference a specific CSF file with `<Meta of={} />`
|
|
709
698
|
*/
|
|
710
|
-
declare class MdxDocsRender<TRenderer extends Renderer
|
|
699
|
+
declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
711
700
|
protected channel: Channel;
|
|
712
701
|
protected store: StoryStore<TRenderer>;
|
|
713
702
|
entry: IndexEntry;
|
|
@@ -736,7 +725,7 @@ declare class MdxDocsRender<TRenderer extends Renderer$1> implements Render<TRen
|
|
|
736
725
|
}
|
|
737
726
|
|
|
738
727
|
type RenderPhase = 'preparing' | 'loading' | 'beforeEach' | 'rendering' | 'playing' | 'played' | 'afterEach' | 'completed' | 'finished' | 'aborted' | 'errored';
|
|
739
|
-
declare class StoryRender<TRenderer extends Renderer
|
|
728
|
+
declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
740
729
|
channel: Channel;
|
|
741
730
|
store: StoryStore<TRenderer>;
|
|
742
731
|
private renderToScreen;
|
|
@@ -754,7 +743,7 @@ declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRende
|
|
|
754
743
|
disableKeyListeners: boolean;
|
|
755
744
|
private teardownRender;
|
|
756
745
|
torndown: boolean;
|
|
757
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas
|
|
746
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
758
747
|
showStoryDuringRender?: () => void;
|
|
759
748
|
}, id: StoryId, viewMode: StoryContext<TRenderer>['viewMode'], renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
760
749
|
private runPhase;
|
|
@@ -781,15 +770,13 @@ declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRende
|
|
|
781
770
|
teardown(): Promise<void>;
|
|
782
771
|
}
|
|
783
772
|
|
|
784
|
-
type MaybePromise
|
|
785
|
-
declare class Preview<TRenderer extends Renderer
|
|
773
|
+
type MaybePromise<T> = Promise<T> | T;
|
|
774
|
+
declare class Preview<TRenderer extends Renderer> {
|
|
786
775
|
importFn: ModuleImportFn;
|
|
787
|
-
getProjectAnnotations: () => MaybePromise
|
|
776
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
788
777
|
protected channel: Channel;
|
|
789
|
-
/** @deprecated Will be removed in 8.0, please use channel instead */
|
|
790
|
-
serverChannel?: Channel;
|
|
791
778
|
protected storyStoreValue?: StoryStore<TRenderer>;
|
|
792
|
-
renderToCanvas?: RenderToCanvas
|
|
779
|
+
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
793
780
|
storyRenders: StoryRender<TRenderer>[];
|
|
794
781
|
previewEntryError?: Error;
|
|
795
782
|
private projectAnnotationsBeforeInitialization?;
|
|
@@ -797,20 +784,20 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
797
784
|
protected storeInitializationPromise: Promise<void>;
|
|
798
785
|
protected resolveStoreInitializationPromise: () => void;
|
|
799
786
|
protected rejectStoreInitializationPromise: (err: Error) => void;
|
|
800
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
787
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, channel?: Channel, shouldInitialize?: boolean);
|
|
801
788
|
get storyStore(): StoryStore<TRenderer>;
|
|
802
789
|
protected initialize(): Promise<void>;
|
|
803
790
|
ready(): Promise<void>;
|
|
804
791
|
setupListeners(): void;
|
|
805
|
-
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations
|
|
806
|
-
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations
|
|
807
|
-
runBeforeAllHook(projectAnnotations: ProjectAnnotations
|
|
792
|
+
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations<TRenderer>>;
|
|
793
|
+
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
794
|
+
runBeforeAllHook(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
808
795
|
getStoryIndexFromServer(): Promise<StoryIndex>;
|
|
809
796
|
protected initializeWithStoryIndex(storyIndex: StoryIndex): void;
|
|
810
797
|
setInitialGlobals(): Promise<void>;
|
|
811
798
|
emitGlobals(): void;
|
|
812
799
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
813
|
-
getProjectAnnotations: () => MaybePromise
|
|
800
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
814
801
|
}): Promise<void>;
|
|
815
802
|
onStoryIndexChanged(): Promise<void>;
|
|
816
803
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
@@ -846,7 +833,7 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
846
833
|
}): {
|
|
847
834
|
args: Args;
|
|
848
835
|
initialGlobals: Globals;
|
|
849
|
-
globalTypes: (
|
|
836
|
+
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
850
837
|
userGlobals: Globals;
|
|
851
838
|
reporting: ReporterAPI;
|
|
852
839
|
globals: {
|
|
@@ -859,34 +846,34 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
859
846
|
subcomponents?: Record<string, (TRenderer & {
|
|
860
847
|
T: any;
|
|
861
848
|
})["component"]> | undefined;
|
|
862
|
-
parameters:
|
|
849
|
+
parameters: storybook_internal_types.Parameters;
|
|
863
850
|
initialArgs: Args;
|
|
864
|
-
argTypes:
|
|
865
|
-
componentId:
|
|
866
|
-
title:
|
|
867
|
-
kind:
|
|
851
|
+
argTypes: storybook_internal_types.StrictArgTypes<Args>;
|
|
852
|
+
componentId: storybook_internal_types.ComponentId;
|
|
853
|
+
title: storybook_internal_types.ComponentTitle;
|
|
854
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
868
855
|
id: StoryId;
|
|
869
|
-
name:
|
|
870
|
-
story:
|
|
871
|
-
tags:
|
|
856
|
+
name: storybook_internal_types.StoryName;
|
|
857
|
+
story: storybook_internal_types.StoryName;
|
|
858
|
+
tags: storybook_internal_types.Tag[];
|
|
872
859
|
moduleExport: storybook_internal_types.ModuleExport;
|
|
873
|
-
originalStoryFn:
|
|
874
|
-
undecoratedStoryFn:
|
|
875
|
-
unboundStoryFn:
|
|
876
|
-
applyLoaders: (context:
|
|
877
|
-
applyBeforeEach: (context:
|
|
878
|
-
applyAfterEach: (context:
|
|
879
|
-
playFunction?: ((context:
|
|
880
|
-
runStep:
|
|
881
|
-
mount: (context:
|
|
860
|
+
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
861
|
+
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
862
|
+
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
863
|
+
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<Record<string, any>>;
|
|
864
|
+
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<CleanupCallback[]>;
|
|
865
|
+
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<void>;
|
|
866
|
+
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<void> | void) | undefined;
|
|
867
|
+
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
868
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
882
869
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
883
|
-
renderToCanvas?: RenderToCanvas
|
|
870
|
+
renderToCanvas?: RenderToCanvas<TRenderer> | undefined;
|
|
884
871
|
usesMount: boolean;
|
|
885
872
|
storyGlobals: Globals;
|
|
886
|
-
} & Pick<
|
|
873
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
887
874
|
extract(options?: {
|
|
888
875
|
includeDocsOnly: boolean;
|
|
889
|
-
}): Promise<Record<string,
|
|
876
|
+
}): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args>>>;
|
|
890
877
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
891
878
|
}
|
|
892
879
|
|
|
@@ -927,21 +914,21 @@ interface View<TStorybookRoot> {
|
|
|
927
914
|
showStoryDuringRender(): void;
|
|
928
915
|
}
|
|
929
916
|
|
|
930
|
-
type PossibleRender<TRenderer extends Renderer
|
|
931
|
-
declare class PreviewWithSelection<TRenderer extends Renderer
|
|
917
|
+
type PossibleRender<TRenderer extends Renderer> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
918
|
+
declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<TRenderer> {
|
|
932
919
|
importFn: ModuleImportFn;
|
|
933
|
-
getProjectAnnotations: () => MaybePromise
|
|
920
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
934
921
|
selectionStore: SelectionStore;
|
|
935
922
|
view: View<TRenderer['canvasElement']>;
|
|
936
923
|
currentSelection?: Selection;
|
|
937
924
|
currentRender?: PossibleRender<TRenderer>;
|
|
938
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
925
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
|
|
939
926
|
setupListeners(): void;
|
|
940
927
|
setInitialGlobals(): Promise<void>;
|
|
941
928
|
initializeWithStoryIndex(storyIndex: StoryIndex): Promise<void>;
|
|
942
929
|
selectSpecifiedStory(): Promise<void>;
|
|
943
930
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
944
|
-
getProjectAnnotations: () => MaybePromise
|
|
931
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
945
932
|
}): Promise<void>;
|
|
946
933
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
947
934
|
importFn?: ModuleImportFn;
|
|
@@ -988,10 +975,10 @@ declare class PreviewWithSelection<TRenderer extends Renderer$1> extends Preview
|
|
|
988
975
|
}): void;
|
|
989
976
|
}
|
|
990
977
|
|
|
991
|
-
declare class PreviewWeb<TRenderer extends Renderer
|
|
978
|
+
declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
|
|
992
979
|
importFn: ModuleImportFn;
|
|
993
|
-
getProjectAnnotations: () => MaybePromise
|
|
994
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
980
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
981
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
|
|
995
982
|
}
|
|
996
983
|
|
|
997
984
|
declare class UrlStore implements SelectionStore {
|
|
@@ -1047,48 +1034,9 @@ declare class WebView implements View<HTMLElement> {
|
|
|
1047
1034
|
declare function simulateDOMContentLoaded(): void;
|
|
1048
1035
|
declare function simulatePageLoad($container: any): void;
|
|
1049
1036
|
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
readonly observable: symbol;
|
|
1053
|
-
}
|
|
1054
|
-
}
|
|
1055
|
-
|
|
1056
|
-
interface Renderer extends Renderer$2 {
|
|
1057
|
-
}
|
|
1058
|
-
|
|
1059
|
-
type MaybePromise<T> = Promise<T> | T;
|
|
1060
|
-
type TeardownRenderToCanvas = () => MaybePromise<void>;
|
|
1061
|
-
type RenderToCanvas<TRenderer extends Renderer> = (context: RenderContext<TRenderer>, element: TRenderer['canvasElement']) => MaybePromise<void | TeardownRenderToCanvas>;
|
|
1062
|
-
interface ProjectAnnotations<TRenderer extends Renderer> extends ProjectAnnotations$2<TRenderer> {
|
|
1063
|
-
addons?: ProjectAnnotations<TRenderer>[];
|
|
1064
|
-
testingLibraryRender?: (...args: never[]) => {
|
|
1065
|
-
unmount: () => void;
|
|
1066
|
-
};
|
|
1067
|
-
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1068
|
-
renderToDOM?: RenderToCanvas<TRenderer>;
|
|
1069
|
-
}
|
|
1070
|
-
type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = Omit<ProjectAnnotations<TRenderer>, 'decorators' | 'loaders' | 'runStep' | 'beforeAll'> & {
|
|
1071
|
-
argTypes?: StrictArgTypes$1;
|
|
1072
|
-
globalTypes?: StrictGlobalTypes;
|
|
1073
|
-
decorators?: DecoratorFunction$1<TRenderer>[];
|
|
1074
|
-
loaders?: LoaderFunction<TRenderer>[];
|
|
1075
|
-
runStep: StepRunner$1<TRenderer>;
|
|
1076
|
-
beforeAll: BeforeAll;
|
|
1077
|
-
};
|
|
1078
|
-
declare type RenderContext<TRenderer extends Renderer = Renderer> = StoryIdentifier & {
|
|
1079
|
-
showMain: () => void;
|
|
1080
|
-
showError: (error: {
|
|
1081
|
-
title: string;
|
|
1082
|
-
description: string;
|
|
1083
|
-
}) => void;
|
|
1084
|
-
showException: (err: Error) => void;
|
|
1085
|
-
forceRemount: boolean;
|
|
1086
|
-
storyContext: StoryContext$1<TRenderer>;
|
|
1087
|
-
storyFn: PartialStoryFn$1<TRenderer>;
|
|
1088
|
-
unboundStoryFn: LegacyStoryFn$1<TRenderer>;
|
|
1089
|
-
};
|
|
1037
|
+
type ReducedStoryContext = Omit<StoryContext$1<any, Args$1>, 'abortSignal' | 'canvasElement' | 'step' | 'context'>;
|
|
1038
|
+
declare function emitTransformCode(source: string | undefined, context: ReducedStoryContext): Promise<void>;
|
|
1090
1039
|
|
|
1091
1040
|
declare function getCoreAnnotations(): any[];
|
|
1092
|
-
declare function getComposedCoreAnnotations<TRenderer extends Renderer$1>(): NormalizedProjectAnnotations<TRenderer>;
|
|
1093
1041
|
|
|
1094
|
-
export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, definePreview,
|
|
1042
|
+
export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, definePreview, emitTransformCode, filterArgTypes, getCoreAnnotations, getCsfFactoryAnnotations, inferControls, makeDecorator, mockChannel, normalizeProjectAnnotations, normalizeStory, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setDefaultProjectAnnotations, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, useArgs, useCallback, useChannel, useEffect, useGlobals, useMemo, useParameter, useReducer, useRef, useState, useStoryContext, userOrAutoTitle, userOrAutoTitleFromSpecifier };
|