storybook 9.0.0-alpha.2 → 9.0.0-alpha.4
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/README.md +1 -1
- package/dist/actions/decorator.d.ts +6 -0
- package/dist/actions/decorator.js +139 -0
- package/dist/actions/index.cjs +127 -0
- package/dist/actions/index.d.ts +105 -0
- package/dist/actions/index.js +112 -0
- package/dist/actions/manager.js +1196 -0
- package/dist/actions/preview.cjs +165 -0
- package/dist/actions/preview.d.ts +55 -0
- package/dist/actions/preview.js +156 -0
- package/dist/bin/index.cjs +63 -65
- package/dist/bin/index.js +63 -65
- package/dist/channels/index.cjs +209 -234
- package/dist/channels/index.js +304 -308
- package/dist/cli/bin/index.cjs +409 -409
- package/dist/cli/bin/index.js +414 -414
- package/dist/cli/index.cjs +1 -1
- package/dist/cli/index.d.ts +2 -2
- package/dist/cli/index.js +1 -1
- package/dist/client-logger/index.cjs +56 -88
- package/dist/client-logger/index.js +41 -47
- package/dist/common/index.cjs +148 -148
- package/dist/common/index.d.ts +1 -5
- package/dist/common/index.js +171 -171
- package/dist/components/index.cjs +9413 -11578
- package/dist/components/index.d.ts +92 -92
- package/dist/components/index.js +6768 -7544
- package/dist/core-events/index.d.ts +138 -25
- package/dist/core-server/index.cjs +5244 -5270
- package/dist/core-server/index.d.ts +1 -1
- package/dist/core-server/index.js +5356 -5380
- package/dist/core-server/presets/common-manager.js +11 -19
- package/dist/core-server/presets/common-preset.cjs +243 -242
- package/dist/core-server/presets/common-preset.js +379 -378
- package/dist/csf/index.cjs +76 -120
- package/dist/csf/index.d.ts +1 -3
- package/dist/csf/index.js +69 -113
- package/dist/docs-tools/index.cjs +1 -1
- package/dist/docs-tools/index.d.ts +2 -2
- package/dist/docs-tools/index.js +1 -1
- package/dist/instrumenter/index.cjs +1260 -1289
- package/dist/instrumenter/index.js +1344 -1348
- package/dist/manager/globals-module-info.cjs +272 -135
- package/dist/manager/globals-module-info.d.ts +1 -1
- package/dist/manager/globals-module-info.js +257 -120
- package/dist/manager/globals-runtime.js +59553 -22373
- package/dist/manager/globals.cjs +23 -19
- package/dist/manager/globals.d.ts +8 -5
- package/dist/manager/globals.js +10 -6
- package/dist/manager/runtime.js +129 -129
- package/dist/manager-api/index.cjs +1184 -1209
- package/dist/manager-api/index.d.ts +3 -3
- package/dist/manager-api/index.js +1012 -1012
- package/dist/preview/globals.cjs +21 -17
- package/dist/preview/globals.d.ts +4 -1
- package/dist/preview/globals.js +6 -2
- package/dist/preview/runtime.js +43946 -6548
- package/dist/preview-api/index.cjs +1245 -1243
- package/dist/preview-api/index.d.ts +105 -61
- package/dist/preview-api/index.js +1311 -1273
- package/dist/preview-errors.cjs +1 -1
- package/dist/preview-errors.js +1 -1
- package/dist/router/index.cjs +847 -871
- package/dist/router/index.js +193 -199
- package/dist/test/index.cjs +34778 -0
- package/dist/test/index.d.ts +186 -0
- package/dist/test/index.js +32916 -0
- package/dist/test/preview.cjs +15870 -0
- package/dist/test/preview.d.ts +54 -0
- package/dist/test/preview.js +14441 -0
- package/dist/test/spy.cjs +258 -0
- package/dist/test/spy.d.ts +66 -0
- package/dist/test/spy.js +240 -0
- package/dist/theming/create.cjs +79 -2269
- package/dist/theming/create.js +67 -841
- package/dist/theming/index.cjs +1065 -3232
- package/dist/theming/index.js +951 -1719
- package/dist/types/index.d.ts +242 -242
- package/package.json +155 -3
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Channel } from 'storybook/internal/channels';
|
|
2
2
|
import * as storybook_internal_types from 'storybook/internal/types';
|
|
3
|
-
import { ProjectAnnotations, Renderer, Args, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, LegacyStoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, Parameters, StoryContextForEnhancers, StoryIndexV3, BoundStory, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas, ViewMode } from 'storybook/internal/types';
|
|
3
|
+
import { ProjectAnnotations as ProjectAnnotations$1, Renderer as Renderer$1, Args, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, LegacyStoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations as NormalizedProjectAnnotations$1, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, Parameters, StoryContextForEnhancers, StoryIndexV3, BoundStory, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas as RenderToCanvas$1, ViewMode } from 'storybook/internal/types';
|
|
4
4
|
import * as storybook_internal_csf from 'storybook/internal/csf';
|
|
5
|
-
import { CleanupCallback, Canvas } from 'storybook/internal/csf';
|
|
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';
|
|
6
6
|
import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
|
|
7
7
|
|
|
8
8
|
declare class AddonStore {
|
|
@@ -17,7 +17,7 @@ declare class AddonStore {
|
|
|
17
17
|
}
|
|
18
18
|
declare const addons: AddonStore;
|
|
19
19
|
|
|
20
|
-
declare function definePreview(config: ProjectAnnotations<Renderer>): ProjectAnnotations<Renderer>;
|
|
20
|
+
declare function definePreview(config: ProjectAnnotations$1<Renderer$1>): ProjectAnnotations$1<Renderer$1>;
|
|
21
21
|
|
|
22
22
|
interface Hook {
|
|
23
23
|
name: string;
|
|
@@ -29,7 +29,7 @@ interface Effect {
|
|
|
29
29
|
destroy?: (() => void) | void;
|
|
30
30
|
}
|
|
31
31
|
type AbstractFunction = (...args: any[]) => any;
|
|
32
|
-
declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args> {
|
|
32
|
+
declare class HooksContext<TRenderer extends Renderer$1, TArgs extends Args = Args> {
|
|
33
33
|
hookListsMap: WeakMap<AbstractFunction, Hook[]>;
|
|
34
34
|
mountedDecorators: Set<AbstractFunction>;
|
|
35
35
|
prevMountedDecorators: Set<AbstractFunction>;
|
|
@@ -50,7 +50,7 @@ declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args
|
|
|
50
50
|
addRenderListeners(): void;
|
|
51
51
|
removeRenderListeners(): void;
|
|
52
52
|
}
|
|
53
|
-
declare const applyHooks: <TRenderer extends Renderer>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
53
|
+
declare const applyHooks: <TRenderer extends Renderer$1>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
54
54
|
/**
|
|
55
55
|
* Returns a memoized value.
|
|
56
56
|
*
|
|
@@ -216,7 +216,7 @@ declare function useChannel(eventMap: EventMap, deps?: any[]): (eventName: strin
|
|
|
216
216
|
* @template TArgs The type of the story's args.
|
|
217
217
|
* @returns {StoryContext<TRenderer>} The current story context.
|
|
218
218
|
*/
|
|
219
|
-
declare function useStoryContext<TRenderer extends Renderer, TArgs extends Args = Args>(): StoryContext<TRenderer>;
|
|
219
|
+
declare function useStoryContext<TRenderer extends Renderer$1, TArgs extends Args = Args>(): StoryContext<TRenderer>;
|
|
220
220
|
/**
|
|
221
221
|
* Returns the value of a specific parameter for the current story, or a default value if the
|
|
222
222
|
* parameter is not set.
|
|
@@ -559,7 +559,7 @@ declare class UniversalStore<State, CustomEvent extends {
|
|
|
559
559
|
* @param universalStore The UniversalStore instance to use.
|
|
560
560
|
* @param selector An optional selector function to select a subset of the store state.
|
|
561
561
|
* @remark This hook is intended for use in the preview. For use in the manager UI, import from
|
|
562
|
-
* `storybook/
|
|
562
|
+
* `storybook/manager-api` instead.
|
|
563
563
|
*/
|
|
564
564
|
declare const useUniversalStore: {
|
|
565
565
|
<TUniversalStore extends UniversalStore<TState, any>, TState = TUniversalStore extends UniversalStore<infer S, any> ? S : never>(universalStore: TUniversalStore): [TState, TUniversalStore['setState']];
|
|
@@ -582,7 +582,7 @@ declare const useUniversalStore: {
|
|
|
582
582
|
* @example
|
|
583
583
|
*
|
|
584
584
|
* ```ts
|
|
585
|
-
* import * as testUtils from '
|
|
585
|
+
* import * as testUtils from 'storybook/test'; // in stories
|
|
586
586
|
* import { vi as testUtils } from 'vitest'; // ... or in Vitest tests
|
|
587
587
|
*
|
|
588
588
|
* const initialState = { ... };
|
|
@@ -658,16 +658,16 @@ declare class StoryIndexStore {
|
|
|
658
658
|
importPathToEntry(importPath: Path): IndexEntry;
|
|
659
659
|
}
|
|
660
660
|
|
|
661
|
-
declare function normalizeStory<TRenderer extends Renderer>(key: StoryId, storyAnnotations: LegacyStoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
661
|
+
declare function normalizeStory<TRenderer extends Renderer$1>(key: StoryId, storyAnnotations: LegacyStoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
662
662
|
|
|
663
|
-
declare function processCSFFile<TRenderer extends Renderer>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
|
|
663
|
+
declare function processCSFFile<TRenderer extends Renderer$1>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
|
|
664
664
|
|
|
665
|
-
declare function prepareStory<TRenderer extends Renderer>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
|
|
666
|
-
declare function prepareMeta<TRenderer extends Renderer>(componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>, moduleExport: ModuleExport): PreparedMeta<TRenderer>;
|
|
665
|
+
declare function prepareStory<TRenderer extends Renderer$1>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations$1<TRenderer>): PreparedStory<TRenderer>;
|
|
666
|
+
declare function prepareMeta<TRenderer extends Renderer$1>(componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations$1<TRenderer>, moduleExport: ModuleExport): PreparedMeta<TRenderer>;
|
|
667
667
|
|
|
668
|
-
declare function normalizeProjectAnnotations<TRenderer extends Renderer>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, globals, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
|
|
668
|
+
declare function normalizeProjectAnnotations<TRenderer extends Renderer$1>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, globals, initialGlobals, ...annotations }: ProjectAnnotations$1<TRenderer>): NormalizedProjectAnnotations$1<TRenderer>;
|
|
669
669
|
|
|
670
|
-
declare function composeConfigs<TRenderer extends Renderer>(moduleExportList: ModuleExports[]): NormalizedProjectAnnotations<TRenderer>;
|
|
670
|
+
declare function composeConfigs<TRenderer extends Renderer$1>(moduleExportList: ModuleExports[]): NormalizedProjectAnnotations$1<TRenderer>;
|
|
671
671
|
|
|
672
672
|
/**
|
|
673
673
|
* Compose step runners to create a single step runner that applies each step runner in order.
|
|
@@ -693,16 +693,16 @@ declare function composeConfigs<TRenderer extends Renderer>(moduleExportList: Mo
|
|
|
693
693
|
* @param stepRunners An array of StepRunner
|
|
694
694
|
* @returns A StepRunner that is the composition of the arguments
|
|
695
695
|
*/
|
|
696
|
-
declare function composeStepRunners<TRenderer extends Renderer>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
696
|
+
declare function composeStepRunners<TRenderer extends Renderer$1>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
697
697
|
|
|
698
698
|
declare global {
|
|
699
|
-
var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
|
|
700
|
-
var defaultProjectAnnotations: ProjectAnnotations<any>;
|
|
699
|
+
var globalProjectAnnotations: NormalizedProjectAnnotations$1<any>;
|
|
700
|
+
var defaultProjectAnnotations: ProjectAnnotations$1<any>;
|
|
701
701
|
}
|
|
702
|
-
declare function setDefaultProjectAnnotations<TRenderer extends Renderer = Renderer>(_defaultProjectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
703
|
-
declare function setProjectAnnotations<TRenderer extends Renderer = Renderer>(projectAnnotations: NamedOrDefaultProjectAnnotations<TRenderer> | NamedOrDefaultProjectAnnotations<TRenderer>[]): NormalizedProjectAnnotations<TRenderer>;
|
|
704
|
-
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>>;
|
|
705
|
-
declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations<Renderer>, composeStoryFn?: ComposeStoryFn): {};
|
|
702
|
+
declare function setDefaultProjectAnnotations<TRenderer extends Renderer$1 = Renderer$1>(_defaultProjectAnnotations: ProjectAnnotations$1<TRenderer>): void;
|
|
703
|
+
declare function setProjectAnnotations<TRenderer extends Renderer$1 = Renderer$1>(projectAnnotations: NamedOrDefaultProjectAnnotations<TRenderer> | NamedOrDefaultProjectAnnotations<TRenderer>[]): NormalizedProjectAnnotations$1<TRenderer>;
|
|
704
|
+
declare function composeStory<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args = Args>(storyAnnotations: LegacyStoryAnnotationsOrFn<TRenderer>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations$1<TRenderer>, defaultConfig?: ProjectAnnotations$1<TRenderer>, exportsName?: string): ComposedStoryFn<TRenderer, Partial<TArgs>>;
|
|
705
|
+
declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations$1<Renderer$1>, composeStoryFn?: ComposeStoryFn): {};
|
|
706
706
|
type WrappedStoryRef = {
|
|
707
707
|
__pw_type: 'jsx' | 'importRef';
|
|
708
708
|
};
|
|
@@ -718,14 +718,14 @@ declare function createPlaywrightTest<TFixture extends {
|
|
|
718
718
|
extend: any;
|
|
719
719
|
}>(baseTest: TFixture): TFixture;
|
|
720
720
|
|
|
721
|
-
declare function getCsfFactoryAnnotations<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>): {
|
|
722
|
-
story: storybook_internal_csf.StoryAnnotations<Renderer, Args>;
|
|
723
|
-
meta: ComponentAnnotations<Renderer, Args>;
|
|
724
|
-
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer>;
|
|
721
|
+
declare function getCsfFactoryAnnotations<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations$1<TRenderer>): {
|
|
722
|
+
story: storybook_internal_csf.StoryAnnotations<Renderer$1, Args>;
|
|
723
|
+
meta: ComponentAnnotations<Renderer$1, Args>;
|
|
724
|
+
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer$1>;
|
|
725
725
|
} | {
|
|
726
726
|
story: LegacyStoryAnnotationsOrFn<TRenderer>;
|
|
727
727
|
meta: ComponentAnnotations<TRenderer, TArgs> | undefined;
|
|
728
|
-
preview: ProjectAnnotations<TRenderer> | undefined;
|
|
728
|
+
preview: ProjectAnnotations$1<TRenderer> | undefined;
|
|
729
729
|
};
|
|
730
730
|
|
|
731
731
|
interface Report<T = unknown> {
|
|
@@ -739,10 +739,10 @@ declare class ReporterAPI {
|
|
|
739
739
|
addReport(report: Report): Promise<void>;
|
|
740
740
|
}
|
|
741
741
|
|
|
742
|
-
declare class StoryStore<TRenderer extends Renderer> {
|
|
742
|
+
declare class StoryStore<TRenderer extends Renderer$1> {
|
|
743
743
|
importFn: ModuleImportFn;
|
|
744
744
|
storyIndex: StoryIndexStore;
|
|
745
|
-
projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
|
|
745
|
+
projectAnnotations: NormalizedProjectAnnotations$1<TRenderer>;
|
|
746
746
|
userGlobals: GlobalsStore;
|
|
747
747
|
args: ArgsStore;
|
|
748
748
|
hooks: Record<StoryId, HooksContext<TRenderer>>;
|
|
@@ -751,8 +751,8 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
751
751
|
processCSFFileWithCache: typeof processCSFFile;
|
|
752
752
|
prepareMetaWithCache: typeof prepareMeta;
|
|
753
753
|
prepareStoryWithCache: typeof prepareStory;
|
|
754
|
-
constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations<TRenderer>);
|
|
755
|
-
setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
754
|
+
constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations$1<TRenderer>);
|
|
755
|
+
setProjectAnnotations(projectAnnotations: ProjectAnnotations$1<TRenderer>): void;
|
|
756
756
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
757
757
|
importFn?: ModuleImportFn;
|
|
758
758
|
storyIndex?: StoryIndex;
|
|
@@ -820,7 +820,7 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
820
820
|
renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
|
|
821
821
|
usesMount: boolean;
|
|
822
822
|
storyGlobals: storybook_internal_csf.Globals;
|
|
823
|
-
} & Pick<storybook_internal_csf.StoryContextForLoaders<Renderer, storybook_internal_csf.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
823
|
+
} & Pick<storybook_internal_csf.StoryContextForLoaders<Renderer$1, storybook_internal_csf.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
824
824
|
addCleanupCallbacks(story: PreparedStory<TRenderer>, callbacks: CleanupCallback[]): void;
|
|
825
825
|
cleanupStory(story: PreparedStory<TRenderer>): Promise<void>;
|
|
826
826
|
extract(options?: {
|
|
@@ -846,11 +846,11 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
846
846
|
declare const combineParameters: (...parameterSets: (Parameters | undefined)[]) => Parameters;
|
|
847
847
|
|
|
848
848
|
type PropDescriptor = string[] | RegExp;
|
|
849
|
-
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<
|
|
849
|
+
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_csf.Args>>;
|
|
850
850
|
|
|
851
|
-
declare const inferControls: ArgTypesEnhancer<Renderer>;
|
|
851
|
+
declare const inferControls: ArgTypesEnhancer<Renderer$1>;
|
|
852
852
|
|
|
853
|
-
declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorator: DecoratorFunction<TRenderer>, bindWithContext: (storyFn: LegacyStoryFn<TRenderer>) => PartialStoryFn<TRenderer>): LegacyStoryFn<TRenderer>;
|
|
853
|
+
declare function decorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStoryFn<TRenderer>, decorator: DecoratorFunction<TRenderer>, bindWithContext: (storyFn: LegacyStoryFn<TRenderer>) => PartialStoryFn<TRenderer>): LegacyStoryFn<TRenderer>;
|
|
854
854
|
/**
|
|
855
855
|
* Currently StoryContextUpdates are allowed to have any key in the type. However, you cannot
|
|
856
856
|
* overwrite any of the build-it "static" keys.
|
|
@@ -859,7 +859,7 @@ declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryF
|
|
|
859
859
|
* @returns StoryContextUpdate
|
|
860
860
|
*/
|
|
861
861
|
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate): StoryContextUpdate;
|
|
862
|
-
declare function defaultDecorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn<TRenderer>;
|
|
862
|
+
declare function defaultDecorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn<TRenderer>;
|
|
863
863
|
|
|
864
864
|
declare const combineArgs: (value: any, update: any) => Args;
|
|
865
865
|
|
|
@@ -868,7 +868,7 @@ declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStor
|
|
|
868
868
|
|
|
869
869
|
declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
|
|
870
870
|
|
|
871
|
-
declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
|
|
871
|
+
declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextProps<TRenderer> {
|
|
872
872
|
channel: Channel;
|
|
873
873
|
protected store: StoryStore<TRenderer>;
|
|
874
874
|
renderStoryToElement: DocsContextProps<TRenderer>['renderStoryToElement'];
|
|
@@ -951,7 +951,7 @@ type RenderType = 'story' | 'docs';
|
|
|
951
951
|
* - Tracking the state of the rendering as it moves between preparing, rendering and tearing down.
|
|
952
952
|
* - Tracking what is rendered to know if a change requires re-rendering or teardown + recreation.
|
|
953
953
|
*/
|
|
954
|
-
interface Render<TRenderer extends Renderer> {
|
|
954
|
+
interface Render<TRenderer extends Renderer$1> {
|
|
955
955
|
type: RenderType;
|
|
956
956
|
id: StoryId;
|
|
957
957
|
isPreparing: () => boolean;
|
|
@@ -975,7 +975,7 @@ interface Render<TRenderer extends Renderer> {
|
|
|
975
975
|
*
|
|
976
976
|
* - Autodocs, where there is no story, and we fall back to the globally defined template.
|
|
977
977
|
*/
|
|
978
|
-
declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
978
|
+
declare class CsfDocsRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
979
979
|
protected channel: Channel;
|
|
980
980
|
protected store: StoryStore<TRenderer>;
|
|
981
981
|
entry: IndexEntry;
|
|
@@ -1013,7 +1013,7 @@ declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRende
|
|
|
1013
1013
|
*
|
|
1014
1014
|
* - *.mdx file that may or may not reference a specific CSF file with `<Meta of={} />`
|
|
1015
1015
|
*/
|
|
1016
|
-
declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
1016
|
+
declare class MdxDocsRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
1017
1017
|
protected channel: Channel;
|
|
1018
1018
|
protected store: StoryStore<TRenderer>;
|
|
1019
1019
|
entry: IndexEntry;
|
|
@@ -1042,7 +1042,7 @@ declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRende
|
|
|
1042
1042
|
}
|
|
1043
1043
|
|
|
1044
1044
|
type RenderPhase = 'preparing' | 'loading' | 'beforeEach' | 'rendering' | 'playing' | 'played' | 'afterEach' | 'completed' | 'finished' | 'aborted' | 'errored';
|
|
1045
|
-
declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
1045
|
+
declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
1046
1046
|
channel: Channel;
|
|
1047
1047
|
store: StoryStore<TRenderer>;
|
|
1048
1048
|
private renderToScreen;
|
|
@@ -1060,7 +1060,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
1060
1060
|
disableKeyListeners: boolean;
|
|
1061
1061
|
private teardownRender;
|
|
1062
1062
|
torndown: boolean;
|
|
1063
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
1063
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas$1<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
1064
1064
|
showStoryDuringRender?: () => void;
|
|
1065
1065
|
}, id: StoryId, viewMode: StoryContext<TRenderer>['viewMode'], renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
1066
1066
|
private runPhase;
|
|
@@ -1087,15 +1087,15 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
1087
1087
|
teardown(): Promise<void>;
|
|
1088
1088
|
}
|
|
1089
1089
|
|
|
1090
|
-
type MaybePromise<T> = Promise<T> | T;
|
|
1091
|
-
declare class Preview<TRenderer extends Renderer> {
|
|
1090
|
+
type MaybePromise$1<T> = Promise<T> | T;
|
|
1091
|
+
declare class Preview<TRenderer extends Renderer$1> {
|
|
1092
1092
|
importFn: ModuleImportFn;
|
|
1093
|
-
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1093
|
+
getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>;
|
|
1094
1094
|
protected channel: Channel;
|
|
1095
1095
|
/** @deprecated Will be removed in 8.0, please use channel instead */
|
|
1096
1096
|
serverChannel?: Channel;
|
|
1097
1097
|
protected storyStoreValue?: StoryStore<TRenderer>;
|
|
1098
|
-
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1098
|
+
renderToCanvas?: RenderToCanvas$1<TRenderer>;
|
|
1099
1099
|
storyRenders: StoryRender<TRenderer>[];
|
|
1100
1100
|
previewEntryError?: Error;
|
|
1101
1101
|
private projectAnnotationsBeforeInitialization?;
|
|
@@ -1103,20 +1103,20 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
1103
1103
|
protected storeInitializationPromise: Promise<void>;
|
|
1104
1104
|
protected resolveStoreInitializationPromise: () => void;
|
|
1105
1105
|
protected rejectStoreInitializationPromise: (err: Error) => void;
|
|
1106
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, channel?: Channel, shouldInitialize?: boolean);
|
|
1106
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>, channel?: Channel, shouldInitialize?: boolean);
|
|
1107
1107
|
get storyStore(): StoryStore<TRenderer>;
|
|
1108
1108
|
protected initialize(): Promise<void>;
|
|
1109
1109
|
ready(): Promise<void>;
|
|
1110
1110
|
setupListeners(): void;
|
|
1111
|
-
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations<TRenderer>>;
|
|
1112
|
-
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
1113
|
-
runBeforeAllHook(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
1111
|
+
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations$1<TRenderer>>;
|
|
1112
|
+
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations$1<TRenderer>): Promise<void>;
|
|
1113
|
+
runBeforeAllHook(projectAnnotations: ProjectAnnotations$1<TRenderer>): Promise<void>;
|
|
1114
1114
|
getStoryIndexFromServer(): Promise<StoryIndex>;
|
|
1115
1115
|
protected initializeWithStoryIndex(storyIndex: StoryIndex): void;
|
|
1116
1116
|
setInitialGlobals(): Promise<void>;
|
|
1117
1117
|
emitGlobals(): void;
|
|
1118
1118
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
1119
|
-
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1119
|
+
getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>;
|
|
1120
1120
|
}): Promise<void>;
|
|
1121
1121
|
onStoryIndexChanged(): Promise<void>;
|
|
1122
1122
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
@@ -1186,10 +1186,10 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
1186
1186
|
runStep: storybook_internal_csf.StepRunner<TRenderer>;
|
|
1187
1187
|
mount: (context: storybook_internal_csf.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_csf.Canvas>;
|
|
1188
1188
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
1189
|
-
renderToCanvas?: RenderToCanvas<TRenderer> | undefined;
|
|
1189
|
+
renderToCanvas?: RenderToCanvas$1<TRenderer> | undefined;
|
|
1190
1190
|
usesMount: boolean;
|
|
1191
1191
|
storyGlobals: Globals;
|
|
1192
|
-
} & Pick<storybook_internal_csf.StoryContextForLoaders<Renderer, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
1192
|
+
} & Pick<storybook_internal_csf.StoryContextForLoaders<Renderer$1, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
1193
1193
|
extract(options?: {
|
|
1194
1194
|
includeDocsOnly: boolean;
|
|
1195
1195
|
}): Promise<Record<string, storybook_internal_csf.StoryContextForEnhancers<TRenderer, Args>>>;
|
|
@@ -1233,21 +1233,21 @@ interface View<TStorybookRoot> {
|
|
|
1233
1233
|
showStoryDuringRender(): void;
|
|
1234
1234
|
}
|
|
1235
1235
|
|
|
1236
|
-
type PossibleRender<TRenderer extends Renderer> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
1237
|
-
declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<TRenderer> {
|
|
1236
|
+
type PossibleRender<TRenderer extends Renderer$1> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
1237
|
+
declare class PreviewWithSelection<TRenderer extends Renderer$1> extends Preview<TRenderer> {
|
|
1238
1238
|
importFn: ModuleImportFn;
|
|
1239
|
-
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1239
|
+
getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>;
|
|
1240
1240
|
selectionStore: SelectionStore;
|
|
1241
1241
|
view: View<TRenderer['canvasElement']>;
|
|
1242
1242
|
currentSelection?: Selection;
|
|
1243
1243
|
currentRender?: PossibleRender<TRenderer>;
|
|
1244
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
|
|
1244
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
|
|
1245
1245
|
setupListeners(): void;
|
|
1246
1246
|
setInitialGlobals(): Promise<void>;
|
|
1247
1247
|
initializeWithStoryIndex(storyIndex: StoryIndex): Promise<void>;
|
|
1248
1248
|
selectSpecifiedStory(): Promise<void>;
|
|
1249
1249
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
1250
|
-
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1250
|
+
getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>;
|
|
1251
1251
|
}): Promise<void>;
|
|
1252
1252
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
1253
1253
|
importFn?: ModuleImportFn;
|
|
@@ -1294,10 +1294,10 @@ declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<T
|
|
|
1294
1294
|
}): void;
|
|
1295
1295
|
}
|
|
1296
1296
|
|
|
1297
|
-
declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
|
|
1297
|
+
declare class PreviewWeb<TRenderer extends Renderer$1> extends PreviewWithSelection<TRenderer> {
|
|
1298
1298
|
importFn: ModuleImportFn;
|
|
1299
|
-
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1300
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
|
|
1299
|
+
getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>;
|
|
1300
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise$1<ProjectAnnotations$1<TRenderer>>);
|
|
1301
1301
|
}
|
|
1302
1302
|
|
|
1303
1303
|
declare class UrlStore implements SelectionStore {
|
|
@@ -1353,4 +1353,48 @@ declare class WebView implements View<HTMLElement> {
|
|
|
1353
1353
|
declare function simulateDOMContentLoaded(): void;
|
|
1354
1354
|
declare function simulatePageLoad($container: any): void;
|
|
1355
1355
|
|
|
1356
|
-
|
|
1356
|
+
declare global {
|
|
1357
|
+
interface SymbolConstructor {
|
|
1358
|
+
readonly observable: symbol;
|
|
1359
|
+
}
|
|
1360
|
+
}
|
|
1361
|
+
|
|
1362
|
+
interface Renderer extends Renderer$2 {
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
type MaybePromise<T> = Promise<T> | T;
|
|
1366
|
+
type TeardownRenderToCanvas = () => MaybePromise<void>;
|
|
1367
|
+
type RenderToCanvas<TRenderer extends Renderer> = (context: RenderContext<TRenderer>, element: TRenderer['canvasElement']) => MaybePromise<void | TeardownRenderToCanvas>;
|
|
1368
|
+
interface ProjectAnnotations<TRenderer extends Renderer> extends ProjectAnnotations$2<TRenderer> {
|
|
1369
|
+
addons?: ProjectAnnotations<TRenderer>[];
|
|
1370
|
+
testingLibraryRender?: (...args: never[]) => {
|
|
1371
|
+
unmount: () => void;
|
|
1372
|
+
};
|
|
1373
|
+
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1374
|
+
renderToDOM?: RenderToCanvas<TRenderer>;
|
|
1375
|
+
}
|
|
1376
|
+
type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = Omit<ProjectAnnotations<TRenderer>, 'decorators' | 'loaders' | 'runStep' | 'beforeAll'> & {
|
|
1377
|
+
argTypes?: StrictArgTypes$1;
|
|
1378
|
+
globalTypes?: StrictGlobalTypes;
|
|
1379
|
+
decorators?: DecoratorFunction$1<TRenderer>[];
|
|
1380
|
+
loaders?: LoaderFunction<TRenderer>[];
|
|
1381
|
+
runStep: StepRunner$1<TRenderer>;
|
|
1382
|
+
beforeAll: BeforeAll;
|
|
1383
|
+
};
|
|
1384
|
+
declare type RenderContext<TRenderer extends Renderer = Renderer> = StoryIdentifier & {
|
|
1385
|
+
showMain: () => void;
|
|
1386
|
+
showError: (error: {
|
|
1387
|
+
title: string;
|
|
1388
|
+
description: string;
|
|
1389
|
+
}) => void;
|
|
1390
|
+
showException: (err: Error) => void;
|
|
1391
|
+
forceRemount: boolean;
|
|
1392
|
+
storyContext: StoryContext$1<TRenderer>;
|
|
1393
|
+
storyFn: PartialStoryFn$1<TRenderer>;
|
|
1394
|
+
unboundStoryFn: LegacyStoryFn$1<TRenderer>;
|
|
1395
|
+
};
|
|
1396
|
+
|
|
1397
|
+
declare function getCoreAnnotations(): any[];
|
|
1398
|
+
declare function getComposedCoreAnnotations<TRenderer extends Renderer$1>(): NormalizedProjectAnnotations<TRenderer>;
|
|
1399
|
+
|
|
1400
|
+
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, MockUniversalStore as experimental_MockUniversalStore, UniversalStore as experimental_UniversalStore, useUniversalStore as experimental_useUniversalStore, filterArgTypes, getComposedCoreAnnotations, 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 };
|