@storybook/vue3 8.3.0-alpha.5 → 8.3.0-alpha.7
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/dist/index.d.ts +31 -24
- package/dist/index.js +1 -1
- package/dist/index.mjs +3 -4
- package/package.json +8 -8
- package/template/stories/preview.js +0 -1
package/dist/index.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
export { s as setup } from './render-0377a2e9.js';
|
2
2
|
import { M as Meta } from './public-types-bcb3e860.js';
|
3
3
|
export { C as ComponentPropsAndSlots, D as Decorator, L as Loader, P as Preview, b as StoryContext, S as StoryFn, a as StoryObj } from './public-types-bcb3e860.js';
|
4
|
-
import { NamedOrDefaultProjectAnnotations, ProjectAnnotations, Args, StoryAnnotationsOrFn, ComposedStoryFn, Store_CSFExports, StoriesWithPartialProps } from 'storybook/internal/types';
|
4
|
+
import { NamedOrDefaultProjectAnnotations, NormalizedProjectAnnotations, ProjectAnnotations, Args, StoryAnnotationsOrFn, ComposedStoryFn, Store_CSFExports, StoriesWithPartialProps } from 'storybook/internal/types';
|
5
5
|
export { ArgTypes, Args, Parameters, StrictArgs } from 'storybook/internal/types';
|
6
6
|
import { V as VueRenderer } from './types-1ede6954.js';
|
7
7
|
import 'vue';
|
@@ -15,33 +15,37 @@ type JSXAble<TElement> = TElement & {
|
|
15
15
|
type MapToJSXAble<T> = {
|
16
16
|
[K in keyof T]: JSXAble<T[K]>;
|
17
17
|
};
|
18
|
-
/**
|
18
|
+
/**
|
19
|
+
* Function that sets the globalConfig of your Storybook. The global config is the preview module of
|
20
|
+
* your .storybook folder.
|
19
21
|
*
|
20
|
-
* It should be run a single time, so that your global config (e.g. decorators) is applied to your
|
22
|
+
* It should be run a single time, so that your global config (e.g. decorators) is applied to your
|
23
|
+
* stories when using `composeStories` or `composeStory`.
|
21
24
|
*
|
22
25
|
* Example:
|
23
|
-
|
26
|
+
*
|
27
|
+
* ```jsx
|
24
28
|
* // setup.js (for jest)
|
25
29
|
* import { setProjectAnnotations } from '@storybook/vue3';
|
26
30
|
* import projectAnnotations from './.storybook/preview';
|
27
31
|
*
|
28
32
|
* setProjectAnnotations(projectAnnotations);
|
29
|
-
|
33
|
+
* ```
|
30
34
|
*
|
31
|
-
* @param projectAnnotations -
|
35
|
+
* @param projectAnnotations - E.g. (import projectAnnotations from '../.storybook/preview')
|
32
36
|
*/
|
33
|
-
declare function setProjectAnnotations(projectAnnotations: NamedOrDefaultProjectAnnotations<
|
37
|
+
declare function setProjectAnnotations(projectAnnotations: NamedOrDefaultProjectAnnotations<any> | NamedOrDefaultProjectAnnotations<any>[]): NormalizedProjectAnnotations<VueRenderer>;
|
34
38
|
declare const vueProjectAnnotations: ProjectAnnotations<VueRenderer>;
|
35
39
|
/**
|
36
40
|
* Function that will receive a story along with meta (e.g. a default export from a .stories file)
|
37
|
-
* and optionally projectAnnotations e.g. (import * from '../.storybook/preview)
|
38
|
-
*
|
39
|
-
*
|
41
|
+
* and optionally projectAnnotations e.g. (import * from '../.storybook/preview) and will return a
|
42
|
+
* composed component that has all args/parameters/decorators/etc combined and applied to it.
|
40
43
|
*
|
41
44
|
* It's very useful for reusing a story in scenarios outside of Storybook like unit testing.
|
42
45
|
*
|
43
46
|
* Example:
|
44
|
-
|
47
|
+
*
|
48
|
+
* ```jsx
|
45
49
|
* import { render } from '@testing-library/vue';
|
46
50
|
* import { composeStory } from '@storybook/vue3';
|
47
51
|
* import Meta, { Primary as PrimaryStory } from './Button.stories';
|
@@ -49,27 +53,29 @@ declare const vueProjectAnnotations: ProjectAnnotations<VueRenderer>;
|
|
49
53
|
* const Primary = composeStory(PrimaryStory, Meta);
|
50
54
|
*
|
51
55
|
* test('renders primary button with Hello World', () => {
|
52
|
-
* const { getByText } = render(Primary, { props: { label:
|
56
|
+
* const { getByText } = render(Primary, { props: { label: 'Hello world' } });
|
53
57
|
* expect(getByText(/Hello world/i)).not.toBeNull();
|
54
58
|
* });
|
55
|
-
|
59
|
+
* ```
|
56
60
|
*
|
57
61
|
* @param story
|
58
|
-
* @param componentAnnotations -
|
59
|
-
* @param [projectAnnotations] -
|
60
|
-
*
|
62
|
+
* @param componentAnnotations - E.g. (import Meta from './Button.stories')
|
63
|
+
* @param [projectAnnotations] - E.g. (import * as projectAnnotations from '../.storybook/preview')
|
64
|
+
* this can be applied automatically if you use `setProjectAnnotations` in your setup files.
|
65
|
+
* @param [exportsName] - In case your story does not contain a name and you want it to have a name.
|
61
66
|
*/
|
62
67
|
declare function composeStory<TArgs extends Args = Args>(story: StoryAnnotationsOrFn<VueRenderer, TArgs>, componentAnnotations: Meta<TArgs | any>, projectAnnotations?: ProjectAnnotations<VueRenderer>, exportsName?: string): JSXAble<ComposedStoryFn<VueRenderer, Partial<TArgs>>>;
|
63
68
|
/**
|
64
69
|
* Function that will receive a stories import (e.g. `import * as stories from './Button.stories'`)
|
65
|
-
* and optionally projectAnnotations (e.g. `import * from '../.storybook/preview`)
|
66
|
-
*
|
67
|
-
*
|
70
|
+
* and optionally projectAnnotations (e.g. `import * from '../.storybook/preview`) and will return
|
71
|
+
* an object containing all the stories passed, but now as a composed component that has all
|
72
|
+
* args/parameters/decorators/etc combined and applied to it.
|
68
73
|
*
|
69
74
|
* It's very useful for reusing stories in scenarios outside of Storybook like unit testing.
|
70
75
|
*
|
71
76
|
* Example:
|
72
|
-
|
77
|
+
*
|
78
|
+
* ```jsx
|
73
79
|
* import { render } from '@testing-library/vue';
|
74
80
|
* import { composeStories } from '@storybook/vue3';
|
75
81
|
* import * as stories from './Button.stories';
|
@@ -77,13 +83,14 @@ declare function composeStory<TArgs extends Args = Args>(story: StoryAnnotations
|
|
77
83
|
* const { Primary, Secondary } = composeStories(stories);
|
78
84
|
*
|
79
85
|
* test('renders primary button with Hello World', () => {
|
80
|
-
* const { getByText } = render(Primary, { props: { label:
|
86
|
+
* const { getByText } = render(Primary, { props: { label: 'Hello world' } });
|
81
87
|
* expect(getByText(/Hello world/i)).not.toBeNull();
|
82
88
|
* });
|
83
|
-
|
89
|
+
* ```
|
84
90
|
*
|
85
|
-
* @param csfExports -
|
86
|
-
* @param [projectAnnotations] -
|
91
|
+
* @param csfExports - E.g. (import * as stories from './Button.stories')
|
92
|
+
* @param [projectAnnotations] - E.g. (import * as projectAnnotations from '../.storybook/preview')
|
93
|
+
* this can be applied automatically if you use `setProjectAnnotations` in your setup files.
|
87
94
|
*/
|
88
95
|
declare function composeStories<TModule extends Store_CSFExports<VueRenderer, any>>(csfExports: TModule, projectAnnotations?: ProjectAnnotations<VueRenderer>): MapToJSXAble<Omit<StoriesWithPartialProps<VueRenderer, TModule>, keyof Store_CSFExports>>;
|
89
96
|
|
package/dist/index.js
CHANGED
@@ -1 +1 @@
|
|
1
|
-
"use strict";var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{composeStories:()=>composeStories,composeStory:()=>composeStory,setProjectAnnotations:()=>setProjectAnnotations,setup:()=>setup,vueProjectAnnotations:()=>vueProjectAnnotations});module.exports=__toCommonJS(src_exports);var import_global=require("@storybook/global"),{window:globalWindow}=import_global.global;globalWindow.STORYBOOK_ENV="vue3";globalWindow.PLUGINS_SETUP_FUNCTIONS||=new Set;var import_vue=require("vue"),render=(props,context)=>{let{id,component:Component}=context;if(!Component)throw new Error(`Unable to render story ${id} as the component annotation is missing from the default export`);return()=>(0,import_vue.h)(Component,props,getSlots(props,context))},setup=fn=>{globalThis.PLUGINS_SETUP_FUNCTIONS??=new Set,globalThis.PLUGINS_SETUP_FUNCTIONS.add(fn)},runSetupFunctions=async(app,storyContext)=>{globalThis&&globalThis.PLUGINS_SETUP_FUNCTIONS&&await Promise.all([...globalThis.PLUGINS_SETUP_FUNCTIONS].map(fn=>fn(app,storyContext)))},map=new Map;async function renderToCanvas({storyFn,forceRemount,showMain,showException,storyContext,id},canvasElement){let existingApp=map.get(canvasElement);if(existingApp&&!forceRemount){let element=storyFn(),args=getArgs(element,storyContext);return updateArgs(existingApp.reactiveArgs,args),()=>{teardown(existingApp.vueApp,canvasElement)}}existingApp&&forceRemount&&teardown(existingApp.vueApp,canvasElement);let vueApp=(0,import_vue.createApp)({setup(){storyContext.args=(0,import_vue.reactive)(storyContext.args);let rootElement=storyFn(),args=getArgs(rootElement,storyContext),appState={vueApp,reactiveArgs:(0,import_vue.reactive)(args)};return map.set(canvasElement,appState),()=>(0,import_vue.h)(rootElement)}});return vueApp.config.errorHandler=(e,instance,info)=>{window.__STORYBOOK_PREVIEW__?.storyRenders.some(renderer=>renderer.id===id&&renderer.phase==="playing")?setTimeout(()=>{throw e},0):showException(e)},await runSetupFunctions(vueApp,storyContext),vueApp.mount(canvasElement),showMain(),()=>{teardown(vueApp,canvasElement)}}function getSlots(props,context){let{argTypes}=context,slots=Object.entries(props).filter(([key])=>argTypes[key]?.table?.category==="slots").map(([key,value])=>[key,typeof value=="function"?value:()=>value]);return Object.fromEntries(slots)}function getArgs(element,storyContext){return element.props&&(0,import_vue.isVNode)(element)?element.props:storyContext.args}function updateArgs(reactiveArgs,nextArgs){if(Object.keys(nextArgs).length===0)return;let currentArgs=(0,import_vue.isReactive)(reactiveArgs)?reactiveArgs:(0,import_vue.reactive)(reactiveArgs);Object.keys(currentArgs).forEach(key=>{key in nextArgs||delete currentArgs[key]}),Object.assign(currentArgs,nextArgs)}function teardown(storybookApp,canvasElement){storybookApp?.unmount(),map.has(canvasElement)&&map.delete(canvasElement)}var import_preview_api2=require("storybook/internal/preview-api"),
|
1
|
+
"use strict";var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{composeStories:()=>composeStories,composeStory:()=>composeStory,setProjectAnnotations:()=>setProjectAnnotations,setup:()=>setup,vueProjectAnnotations:()=>vueProjectAnnotations});module.exports=__toCommonJS(src_exports);var import_global=require("@storybook/global"),{window:globalWindow}=import_global.global;globalWindow.STORYBOOK_ENV="vue3";globalWindow.PLUGINS_SETUP_FUNCTIONS||=new Set;var import_vue=require("vue"),render=(props,context)=>{let{id,component:Component}=context;if(!Component)throw new Error(`Unable to render story ${id} as the component annotation is missing from the default export`);return()=>(0,import_vue.h)(Component,props,getSlots(props,context))},setup=fn=>{globalThis.PLUGINS_SETUP_FUNCTIONS??=new Set,globalThis.PLUGINS_SETUP_FUNCTIONS.add(fn)},runSetupFunctions=async(app,storyContext)=>{globalThis&&globalThis.PLUGINS_SETUP_FUNCTIONS&&await Promise.all([...globalThis.PLUGINS_SETUP_FUNCTIONS].map(fn=>fn(app,storyContext)))},map=new Map;async function renderToCanvas({storyFn,forceRemount,showMain,showException,storyContext,id},canvasElement){let existingApp=map.get(canvasElement);if(existingApp&&!forceRemount){let element=storyFn(),args=getArgs(element,storyContext);return updateArgs(existingApp.reactiveArgs,args),()=>{teardown(existingApp.vueApp,canvasElement)}}existingApp&&forceRemount&&teardown(existingApp.vueApp,canvasElement);let vueApp=(0,import_vue.createApp)({setup(){storyContext.args=(0,import_vue.reactive)(storyContext.args);let rootElement=storyFn(),args=getArgs(rootElement,storyContext),appState={vueApp,reactiveArgs:(0,import_vue.reactive)(args)};return map.set(canvasElement,appState),()=>(0,import_vue.h)(rootElement)}});return vueApp.config.errorHandler=(e,instance,info)=>{window.__STORYBOOK_PREVIEW__?.storyRenders.some(renderer=>renderer.id===id&&renderer.phase==="playing")?setTimeout(()=>{throw e},0):showException(e)},await runSetupFunctions(vueApp,storyContext),vueApp.mount(canvasElement),showMain(),()=>{teardown(vueApp,canvasElement)}}function getSlots(props,context){let{argTypes}=context,slots=Object.entries(props).filter(([key])=>argTypes[key]?.table?.category==="slots").map(([key,value])=>[key,typeof value=="function"?value:()=>value]);return Object.fromEntries(slots)}function getArgs(element,storyContext){return element.props&&(0,import_vue.isVNode)(element)?element.props:storyContext.args}function updateArgs(reactiveArgs,nextArgs){if(Object.keys(nextArgs).length===0)return;let currentArgs=(0,import_vue.isReactive)(reactiveArgs)?reactiveArgs:(0,import_vue.reactive)(reactiveArgs);Object.keys(currentArgs).forEach(key=>{key in nextArgs||delete currentArgs[key]}),Object.assign(currentArgs,nextArgs)}function teardown(storybookApp,canvasElement){storybookApp?.unmount(),map.has(canvasElement)&&map.delete(canvasElement)}var import_preview_api2=require("storybook/internal/preview-api"),import_vue4=require("vue");var entry_preview_exports={};__export(entry_preview_exports,{applyDecorators:()=>decorateStory,mount:()=>mount,parameters:()=>parameters,render:()=>render,renderToCanvas:()=>renderToCanvas});var import_preview_api=require("storybook/internal/preview-api"),import_vue2=require("vue");function normalizeFunctionalComponent(options){return typeof options=="function"?{render:options,name:options.name}:options}function prepare(rawStory,innerStory){let story=rawStory;return story===null?null:typeof story=="function"?story:innerStory?{...normalizeFunctionalComponent(story),components:{...story.components||{},story:innerStory}}:{render(){return(0,import_vue2.h)(story)}}}function decorateStory(storyFn,decorators){return decorators.reduce((decorated,decorator)=>context=>{let story,decoratedStory=decorator(update=>{let sanitizedUpdate=(0,import_preview_api.sanitizeStoryContextUpdate)(update);return update&&(sanitizedUpdate.args=Object.assign(context.args,sanitizedUpdate.args)),story=decorated({...context,...sanitizedUpdate}),story},context);return story||(story=decorated(context)),decoratedStory===story?story:prepare(decoratedStory,()=>(0,import_vue2.h)(story))},context=>prepare(storyFn(context)))}var import_vue3=require("vue"),mount=context=>async(Component,options)=>(Component&&(context.originalStoryFn=()=>()=>(0,import_vue3.h)(Component,options?.props,options?.slots)),await context.renderToCanvas(),context.canvas);var parameters={renderer:"vue3"};function setProjectAnnotations(projectAnnotations){return(0,import_preview_api2.setDefaultProjectAnnotations)(vueProjectAnnotations),(0,import_preview_api2.setProjectAnnotations)(projectAnnotations)}var vueProjectAnnotations={...entry_preview_exports,renderToCanvas:(renderContext,canvasElement)=>{if(renderContext.storyContext.testingLibraryRender==null)return renderToCanvas(renderContext,canvasElement);let{storyFn,storyContext:{testingLibraryRender:render2}}=renderContext,{unmount}=render2(storyFn(),{container:canvasElement});return unmount}};function composeStory(story,componentAnnotations,projectAnnotations,exportsName){let composedStory=(0,import_preview_api2.composeStory)(story,componentAnnotations,projectAnnotations,vueProjectAnnotations,exportsName),renderable=(...args)=>(0,import_vue4.h)(composedStory(...args));return Object.assign(renderable,composedStory),renderable}function composeStories(csfExports,projectAnnotations){return(0,import_preview_api2.composeStories)(csfExports,projectAnnotations,composeStory)}try{module?.hot?.decline&&module.hot.decline()}catch{}0&&(module.exports={composeStories,composeStory,setProjectAnnotations,setup,vueProjectAnnotations});
|
package/dist/index.mjs
CHANGED
@@ -1,11 +1,10 @@
|
|
1
|
-
import { entry_preview_exports } from './chunk-IBPFZ7LW.mjs';
|
1
|
+
import { entry_preview_exports, renderToCanvas } from './chunk-IBPFZ7LW.mjs';
|
2
2
|
export { setup } from './chunk-IBPFZ7LW.mjs';
|
3
3
|
import './chunk-CEH6MNVV.mjs';
|
4
4
|
import { global } from '@storybook/global';
|
5
|
-
import { setProjectAnnotations as setProjectAnnotations$1, composeStory as composeStory$1, composeStories as composeStories$1 } from 'storybook/internal/preview-api';
|
6
|
-
import { TestingLibraryMustBeConfiguredError } from 'storybook/internal/preview-errors';
|
5
|
+
import { setDefaultProjectAnnotations, setProjectAnnotations as setProjectAnnotations$1, composeStory as composeStory$1, composeStories as composeStories$1 } from 'storybook/internal/preview-api';
|
7
6
|
import { h } from 'vue';
|
8
7
|
|
9
|
-
var{window:globalWindow}=global;globalWindow.STORYBOOK_ENV="vue3";globalWindow.PLUGINS_SETUP_FUNCTIONS||=new Set;function setProjectAnnotations(projectAnnotations){return setProjectAnnotations$1(projectAnnotations)}var vueProjectAnnotations={...entry_preview_exports,renderToCanvas:(renderContext,canvasElement)=>{if(renderContext.storyContext.testingLibraryRender==null)
|
8
|
+
var{window:globalWindow}=global;globalWindow.STORYBOOK_ENV="vue3";globalWindow.PLUGINS_SETUP_FUNCTIONS||=new Set;function setProjectAnnotations(projectAnnotations){return setDefaultProjectAnnotations(vueProjectAnnotations),setProjectAnnotations$1(projectAnnotations)}var vueProjectAnnotations={...entry_preview_exports,renderToCanvas:(renderContext,canvasElement)=>{if(renderContext.storyContext.testingLibraryRender==null)return renderToCanvas(renderContext,canvasElement);let{storyFn,storyContext:{testingLibraryRender:render}}=renderContext,{unmount}=render(storyFn(),{container:canvasElement});return unmount}};function composeStory(story,componentAnnotations,projectAnnotations,exportsName){let composedStory=composeStory$1(story,componentAnnotations,projectAnnotations,vueProjectAnnotations,exportsName),renderable=(...args)=>h(composedStory(...args));return Object.assign(renderable,composedStory),renderable}function composeStories(csfExports,projectAnnotations){return composeStories$1(csfExports,projectAnnotations,composeStory)}try{module?.hot?.decline&&module.hot.decline();}catch{}
|
10
9
|
|
11
10
|
export { composeStories, composeStory, setProjectAnnotations, vueProjectAnnotations };
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@storybook/vue3",
|
3
|
-
"version": "8.3.0-alpha.
|
3
|
+
"version": "8.3.0-alpha.7",
|
4
4
|
"description": "Storybook Vue 3 renderer",
|
5
5
|
"keywords": [
|
6
6
|
"storybook"
|
@@ -22,9 +22,9 @@
|
|
22
22
|
"exports": {
|
23
23
|
".": {
|
24
24
|
"types": "./dist/index.d.ts",
|
25
|
-
"node": "./dist/index.js",
|
26
25
|
"import": "./dist/index.mjs",
|
27
|
-
"require": "./dist/index.js"
|
26
|
+
"require": "./dist/index.js",
|
27
|
+
"node": "./dist/index.js"
|
28
28
|
},
|
29
29
|
"./experimental-playwright": {
|
30
30
|
"types": "./dist/playwright.d.ts",
|
@@ -63,11 +63,11 @@
|
|
63
63
|
"prep": "jiti ../../../scripts/prepare/bundle.ts"
|
64
64
|
},
|
65
65
|
"dependencies": {
|
66
|
-
"@storybook/components": "^8.3.0-alpha.
|
66
|
+
"@storybook/components": "^8.3.0-alpha.7",
|
67
67
|
"@storybook/global": "^5.0.0",
|
68
|
-
"@storybook/manager-api": "^8.3.0-alpha.
|
69
|
-
"@storybook/preview-api": "^8.3.0-alpha.
|
70
|
-
"@storybook/theming": "^8.3.0-alpha.
|
68
|
+
"@storybook/manager-api": "^8.3.0-alpha.7",
|
69
|
+
"@storybook/preview-api": "^8.3.0-alpha.7",
|
70
|
+
"@storybook/theming": "^8.3.0-alpha.7",
|
71
71
|
"@vue/compiler-core": "^3.0.0",
|
72
72
|
"ts-dedent": "^2.0.0",
|
73
73
|
"type-fest": "~2.19",
|
@@ -84,7 +84,7 @@
|
|
84
84
|
"vue-tsc": "latest"
|
85
85
|
},
|
86
86
|
"peerDependencies": {
|
87
|
-
"storybook": "^8.3.0-alpha.
|
87
|
+
"storybook": "^8.3.0-alpha.7",
|
88
88
|
"vue": "^3.0.0"
|
89
89
|
},
|
90
90
|
"engines": {
|