@storybook/html 7.6.0-beta.2 → 8.0.0-alpha.0

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.
@@ -1,5 +1,13 @@
1
- export { render, renderToCanvas } from './chunk-JHBKUHDQ.mjs';
1
+ import { global } from '@storybook/global';
2
+ import { dedent } from 'ts-dedent';
3
+ import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/preview-api';
2
4
 
3
- var parameters={renderer:"html"};
5
+ var {Node}=global,render=(args,context)=>{let{id,component:Component}=context;if(typeof Component=="string"){let output=Component;return Object.keys(args).forEach(key=>{output=output.replace(`{{${key}}}`,args[key]);}),output}if(Component instanceof HTMLElement){let output=Component.cloneNode(!0);return Object.keys(args).forEach(key=>{output.setAttribute(key,typeof args[key]=="string"?args[key]:JSON.stringify(args[key]));}),output}if(typeof Component=="function")return Component(args,context);throw console.warn(dedent`
6
+ Storybook's HTML renderer only supports rendering DOM elements and strings.
7
+ Received: ${Component}
8
+ `),new Error(`Unable to render story ${id}`)};function renderToCanvas({storyFn,kind,name,showMain,showError,forceRemount},canvasElement){let element=storyFn();if(showMain(),typeof element=="string")canvasElement.innerHTML=element,simulatePageLoad(canvasElement);else if(element instanceof Node){if(canvasElement.firstChild===element&&forceRemount===!1)return;canvasElement.innerHTML="",canvasElement.appendChild(element),simulateDOMContentLoaded();}else showError({title:`Expecting an HTML snippet or DOM node from the story: "${name}" of "${kind}".`,description:dedent`
9
+ Did you forget to return the HTML snippet from the story?
10
+ Use "() => <your snippet or node>" or when defining the story.
11
+ `});}var parameters={renderer:"html"};
4
12
 
5
- export { parameters };
13
+ export { parameters, render, renderToCanvas };
package/dist/index.d.ts CHANGED
@@ -1,18 +1,8 @@
1
- import { Addon_ClientStoryApi, Addon_Loadable, Args, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations, StrictArgs, DecoratorFunction, LoaderFunction, StoryContext as StoryContext$1, ProjectAnnotations } from '@storybook/types';
1
+ import { Args, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations, StrictArgs, DecoratorFunction, LoaderFunction, StoryContext as StoryContext$1, ProjectAnnotations } from '@storybook/types';
2
2
  export { ArgTypes, Args, Parameters, StrictArgs } from '@storybook/types';
3
3
  import { H as HtmlRenderer } from './types-43cfeb83.js';
4
4
  import '@storybook/docs-tools';
5
5
 
6
- interface ClientApi extends Addon_ClientStoryApi<HtmlRenderer['storyResult']> {
7
- configure(loader: Addon_Loadable, module: NodeModule): void;
8
- forceReRender(): void;
9
- raw: () => any;
10
- }
11
- declare const storiesOf: ClientApi['storiesOf'];
12
- declare const configure: ClientApi['configure'];
13
- declare const forceReRender: ClientApi['forceReRender'];
14
- declare const raw: ClientApi['raw'];
15
-
16
6
  /**
17
7
  * Metadata to configure the stories for a component.
18
8
  *
@@ -46,4 +36,4 @@ type Loader<TArgs = StrictArgs> = LoaderFunction<HtmlRenderer, TArgs>;
46
36
  type StoryContext<TArgs = StrictArgs> = StoryContext$1<HtmlRenderer, TArgs>;
47
37
  type Preview = ProjectAnnotations<HtmlRenderer>;
48
38
 
49
- export { Decorator, HtmlRenderer, Loader, Meta, Preview, Story, StoryContext, StoryFn, StoryObj, configure, forceReRender, raw, storiesOf };
39
+ export { Decorator, HtmlRenderer, Loader, Meta, Preview, Story, StoryContext, StoryFn, StoryObj };
package/dist/index.js CHANGED
@@ -1,7 +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,{configure:()=>configure,forceReRender:()=>forceReRender,raw:()=>raw,storiesOf:()=>storiesOf});module.exports=__toCommonJS(src_exports);var import_global=require("@storybook/global"),{window:globalWindow}=import_global.global;globalWindow.STORYBOOK_ENV="HTML";var import_preview_api2=require("@storybook/preview-api");var import_global2=require("@storybook/global"),import_ts_dedent=require("ts-dedent"),import_preview_api=require("@storybook/preview-api"),{Node}=import_global2.global,render=(args,context)=>{let{id,component:Component}=context;if(typeof Component=="string"){let output=Component;return Object.keys(args).forEach(key=>{output=output.replace(`{{${key}}}`,args[key])}),output}if(Component instanceof HTMLElement){let output=Component.cloneNode(!0);return Object.keys(args).forEach(key=>{output.setAttribute(key,typeof args[key]=="string"?args[key]:JSON.stringify(args[key]))}),output}if(typeof Component=="function")return Component(args,context);throw console.warn(import_ts_dedent.dedent`
2
- Storybook's HTML renderer only supports rendering DOM elements and strings.
3
- Received: ${Component}
4
- `),new Error(`Unable to render story ${id}`)};function renderToCanvas({storyFn,kind,name,showMain,showError,forceRemount},canvasElement){let element=storyFn();if(showMain(),typeof element=="string")canvasElement.innerHTML=element,(0,import_preview_api.simulatePageLoad)(canvasElement);else if(element instanceof Node){if(canvasElement.firstChild===element&&forceRemount===!1)return;canvasElement.innerHTML="",canvasElement.appendChild(element),(0,import_preview_api.simulateDOMContentLoaded)()}else showError({title:`Expecting an HTML snippet or DOM node from the story: "${name}" of "${kind}".`,description:import_ts_dedent.dedent`
5
- Did you forget to return the HTML snippet from the story?
6
- Use "() => <your snippet or node>" or when defining the story.
7
- `})}var RENDERER="html",api=(0,import_preview_api2.start)(renderToCanvas,{render}),storiesOf=(kind,m)=>api.clientApi.storiesOf(kind,m).addParameters({renderer:RENDERER}),configure=(...args)=>api.configure(RENDERER,...args),forceReRender=api.forceReRender,raw=api.clientApi.raw;var _a;typeof module<"u"&&((_a=module==null?void 0:module.hot)==null||_a.decline());0&&(module.exports={configure,forceReRender,raw,storiesOf});
1
+ "use strict";var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __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={};module.exports=__toCommonJS(src_exports);var import_global=require("@storybook/global"),{window:globalWindow}=import_global.global;globalWindow.STORYBOOK_ENV="HTML";var _a;typeof module<"u"&&((_a=module==null?void 0:module.hot)==null||_a.decline());
package/dist/index.mjs CHANGED
@@ -1,7 +1,3 @@
1
- import { renderToCanvas, render } from './chunk-JHBKUHDQ.mjs';
2
1
  import { global } from '@storybook/global';
3
- import { start } from '@storybook/preview-api';
4
2
 
5
- var{window:globalWindow}=global;globalWindow.STORYBOOK_ENV="HTML";var RENDERER="html",api=start(renderToCanvas,{render}),storiesOf=(kind,m)=>api.clientApi.storiesOf(kind,m).addParameters({renderer:RENDERER}),configure=(...args)=>api.configure(RENDERER,...args),forceReRender=api.forceReRender,raw=api.clientApi.raw;typeof module<"u"&&module?.hot?.decline();
6
-
7
- export { configure, forceReRender, raw, storiesOf };
3
+ var{window:globalWindow}=global;globalWindow.STORYBOOK_ENV="HTML";typeof module<"u"&&module?.hot?.decline();
package/dist/preset.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { StorybookConfig } from '@storybook/types';
1
+ import { PresetProperty } from '@storybook/types';
2
2
 
3
- declare const previewAnnotations: StorybookConfig['previewAnnotations'];
3
+ declare const previewAnnotations: PresetProperty<'previewAnnotations'>;
4
4
 
5
5
  export { previewAnnotations };
package/dist/preset.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 preset_exports={};__export(preset_exports,{previewAnnotations:()=>previewAnnotations});module.exports=__toCommonJS(preset_exports);var import_path=require("path"),previewAnnotations=async(input,options)=>{let docsEnabled=Object.keys(await options.presets.apply("docs",{},options)).length>0;return[].concat(input).concat([(0,import_path.join)(__dirname,"entry-preview.mjs")]).concat(docsEnabled?[(0,import_path.join)(__dirname,"entry-preview-docs.mjs")]:[])};0&&(module.exports={previewAnnotations});
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 preset_exports={};__export(preset_exports,{previewAnnotations:()=>previewAnnotations});module.exports=__toCommonJS(preset_exports);var import_path=require("path"),previewAnnotations=async(input=[],options)=>{let docsEnabled=Object.keys(await options.presets.apply("docs",{},options)).length>0;return[].concat(input).concat([(0,import_path.join)(__dirname,"entry-preview.mjs")]).concat(docsEnabled?[(0,import_path.join)(__dirname,"entry-preview-docs.mjs")]:[])};0&&(module.exports={previewAnnotations});
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/html",
3
- "version": "7.6.0-beta.2",
3
+ "version": "8.0.0-alpha.0",
4
4
  "description": "Storybook HTML renderer",
5
5
  "keywords": [
6
6
  "storybook"
@@ -47,15 +47,14 @@
47
47
  "prep": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/bundle.ts"
48
48
  },
49
49
  "dependencies": {
50
- "@storybook/core-client": "7.6.0-beta.2",
51
- "@storybook/docs-tools": "7.6.0-beta.2",
50
+ "@storybook/docs-tools": "8.0.0-alpha.0",
52
51
  "@storybook/global": "^5.0.0",
53
- "@storybook/preview-api": "7.6.0-beta.2",
54
- "@storybook/types": "7.6.0-beta.2",
52
+ "@storybook/preview-api": "8.0.0-alpha.0",
53
+ "@storybook/types": "8.0.0-alpha.0",
55
54
  "ts-dedent": "^2.0.0"
56
55
  },
57
56
  "devDependencies": {
58
- "typescript": "~4.9.3"
57
+ "typescript": "^5.3.2"
59
58
  },
60
59
  "peerDependencies": {
61
60
  "@babel/core": "*"
@@ -1,6 +1,6 @@
1
1
  import { createButton } from './Button';
2
2
 
3
- // More on how to set up stories at: https://storybook.js.org/docs/html/writing-stories/introduction
3
+ // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
4
4
  export default {
5
5
  title: 'Example/Button',
6
6
  tags: ['autodocs'],
@@ -21,7 +21,7 @@ export default {
21
21
  },
22
22
  };
23
23
 
24
- // More on writing stories with args: https://storybook.js.org/docs/html/writing-stories/args
24
+ // More on writing stories with args: https://storybook.js.org/docs/writing-stories/args
25
25
  export const Primary = {
26
26
  args: {
27
27
  primary: true,
@@ -2,14 +2,14 @@ import { createHeader } from './Header';
2
2
 
3
3
  export default {
4
4
  title: 'Example/Header',
5
- // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/html/writing-docs/autodocs
5
+ // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
6
6
  tags: ['autodocs'],
7
7
  render: (args) => createHeader(args),
8
8
  parameters: {
9
- // More on how to position stories at: https://storybook.js.org/docs/html/configure/story-layout
9
+ // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
10
10
  layout: 'fullscreen',
11
11
  },
12
- // More on argTypes: https://storybook.js.org/docs/html/api/argtypes
12
+ // More on argTypes: https://storybook.js.org/docs/api/argtypes
13
13
  argTypes: {
14
14
  onLogin: { action: 'onLogin' },
15
15
  onLogout: { action: 'onLogout' },
@@ -5,14 +5,14 @@ export default {
5
5
  title: 'Example/Page',
6
6
  render: () => createPage(),
7
7
  parameters: {
8
- // More on how to position stories at: https://storybook.js.org/docs/html/configure/story-layout
8
+ // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
9
9
  layout: 'fullscreen',
10
10
  },
11
11
  };
12
12
 
13
13
  export const LoggedOut = {};
14
14
 
15
- // More on interaction testing: https://storybook.js.org/docs/html/writing-tests/interaction-testing
15
+ // More on interaction testing: https://storybook.js.org/docs/writing-tests/interaction-testing
16
16
  export const LoggedIn = {
17
17
  play: async ({ canvasElement }) => {
18
18
  const canvas = within(canvasElement);
@@ -2,7 +2,7 @@ import type { StoryObj, Meta } from '@storybook/html';
2
2
  import type { ButtonProps } from './Button';
3
3
  import { createButton } from './Button';
4
4
 
5
- // More on how to set up stories at: https://storybook.js.org/docs/html/writing-stories/introduction#default-export
5
+ // More on how to set up stories at: https://storybook.js.org/docs/writing-stories#default-export
6
6
  const meta: Meta<ButtonProps> = {
7
7
  title: 'Example/Button',
8
8
  tags: ['autodocs'],
@@ -26,7 +26,7 @@ const meta: Meta<ButtonProps> = {
26
26
  export default meta;
27
27
  type Story = StoryObj<ButtonProps>;
28
28
 
29
- // More on writing stories with args: https://storybook.js.org/docs/html/writing-stories/args
29
+ // More on writing stories with args: https://storybook.js.org/docs/writing-stories/args
30
30
  export const Primary: Story = {
31
31
  args: {
32
32
  primary: true,
@@ -4,14 +4,14 @@ import { createHeader } from './Header';
4
4
 
5
5
  const meta: Meta<HeaderProps> = {
6
6
  title: 'Example/Header',
7
- // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/html/writing-docs/autodocs
7
+ // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
8
8
  tags: ['autodocs'],
9
9
  render: (args) => createHeader(args),
10
10
  parameters: {
11
- // More on how to position stories at: https://storybook.js.org/docs/html/configure/story-layout
11
+ // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
12
12
  layout: 'fullscreen',
13
13
  },
14
- // More on argTypes: https://storybook.js.org/docs/html/api/argtypes
14
+ // More on argTypes: https://storybook.js.org/docs/api/argtypes
15
15
  argTypes: {
16
16
  onLogin: { action: 'onLogin' },
17
17
  onLogout: { action: 'onLogout' },
@@ -6,7 +6,7 @@ const meta: Meta = {
6
6
  title: 'Example/Page',
7
7
  render: () => createPage(),
8
8
  parameters: {
9
- // More on how to position stories at: https://storybook.js.org/docs/html/configure/story-layout
9
+ // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
10
10
  layout: 'fullscreen',
11
11
  },
12
12
  };
@@ -15,7 +15,7 @@ export default meta;
15
15
 
16
16
  export const LoggedOut: StoryObj = {};
17
17
 
18
- // More on interaction testing: https://storybook.js.org/docs/html/writing-tests/interaction-testing
18
+ // More on interaction testing: https://storybook.js.org/docs/writing-tests/interaction-testing
19
19
  export const LoggedIn: StoryObj = {
20
20
  play: async ({ canvasElement }) => {
21
21
  const canvas = within(canvasElement);
@@ -2,7 +2,7 @@ import type { StoryObj, Meta } from '@storybook/html';
2
2
  import type { ButtonProps } from './Button';
3
3
  import { createButton } from './Button';
4
4
 
5
- // More on how to set up stories at: https://storybook.js.org/docs/html/writing-stories/introduction#default-export
5
+ // More on how to set up stories at: https://storybook.js.org/docs/writing-stories#default-export
6
6
  const meta = {
7
7
  title: 'Example/Button',
8
8
  tags: ['autodocs'],
@@ -26,7 +26,7 @@ const meta = {
26
26
  export default meta;
27
27
  type Story = StoryObj<ButtonProps>;
28
28
 
29
- // More on writing stories with args: https://storybook.js.org/docs/html/writing-stories/args
29
+ // More on writing stories with args: https://storybook.js.org/docs/writing-stories/args
30
30
  export const Primary: Story = {
31
31
  args: {
32
32
  primary: true,
@@ -4,14 +4,14 @@ import { createHeader } from './Header';
4
4
 
5
5
  const meta = {
6
6
  title: 'Example/Header',
7
- // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/html/writing-docs/autodocs
7
+ // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
8
8
  tags: ['autodocs'],
9
9
  render: (args) => createHeader(args),
10
10
  parameters: {
11
- // More on how to position stories at: https://storybook.js.org/docs/html/configure/story-layout
11
+ // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
12
12
  layout: 'fullscreen',
13
13
  },
14
- // More on argTypes: https://storybook.js.org/docs/html/api/argtypes
14
+ // More on argTypes: https://storybook.js.org/docs/api/argtypes
15
15
  argTypes: {
16
16
  onLogin: { action: 'onLogin' },
17
17
  onLogout: { action: 'onLogout' },
@@ -6,7 +6,7 @@ const meta = {
6
6
  title: 'Example/Page',
7
7
  render: () => createPage(),
8
8
  parameters: {
9
- // More on how to position stories at: https://storybook.js.org/docs/html/configure/story-layout
9
+ // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
10
10
  layout: 'fullscreen',
11
11
  },
12
12
  } satisfies Meta;
@@ -15,7 +15,7 @@ export default meta;
15
15
 
16
16
  export const LoggedOut: StoryObj = {};
17
17
 
18
- // More on interaction testing: https://storybook.js.org/docs/html/writing-tests/interaction-testing
18
+ // More on interaction testing: https://storybook.js.org/docs/writing-tests/interaction-testing
19
19
  export const LoggedIn: StoryObj = {
20
20
  play: async ({ canvasElement }) => {
21
21
  const canvas = within(canvasElement);
@@ -1,13 +0,0 @@
1
- import { global } from '@storybook/global';
2
- import { dedent } from 'ts-dedent';
3
- import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/preview-api';
4
-
5
- var {Node}=global,render=(args,context)=>{let{id,component:Component}=context;if(typeof Component=="string"){let output=Component;return Object.keys(args).forEach(key=>{output=output.replace(`{{${key}}}`,args[key]);}),output}if(Component instanceof HTMLElement){let output=Component.cloneNode(!0);return Object.keys(args).forEach(key=>{output.setAttribute(key,typeof args[key]=="string"?args[key]:JSON.stringify(args[key]));}),output}if(typeof Component=="function")return Component(args,context);throw console.warn(dedent`
6
- Storybook's HTML renderer only supports rendering DOM elements and strings.
7
- Received: ${Component}
8
- `),new Error(`Unable to render story ${id}`)};function renderToCanvas({storyFn,kind,name,showMain,showError,forceRemount},canvasElement){let element=storyFn();if(showMain(),typeof element=="string")canvasElement.innerHTML=element,simulatePageLoad(canvasElement);else if(element instanceof Node){if(canvasElement.firstChild===element&&forceRemount===!1)return;canvasElement.innerHTML="",canvasElement.appendChild(element),simulateDOMContentLoaded();}else showError({title:`Expecting an HTML snippet or DOM node from the story: "${name}" of "${kind}".`,description:dedent`
9
- Did you forget to return the HTML snippet from the story?
10
- Use "() => <your snippet or node>" or when defining the story.
11
- `});}
12
-
13
- export { render, renderToCanvas };