@storybook/html 6.4.0-alpha.8 → 6.4.0-beta.2

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.
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ Object.defineProperty(exports, "renderToDOM", {
7
+ enumerable: true,
8
+ get: function get() {
9
+ return _render.renderToDOM;
10
+ }
11
+ });
12
+ exports.parameters = void 0;
13
+
14
+ var _render = require("./render");
15
+
16
+ var parameters = {
17
+ framework: 'html'
18
+ };
19
+ exports.parameters = parameters;
@@ -11,13 +11,11 @@ var _client = require("@storybook/core/client");
11
11
 
12
12
  require("./globals");
13
13
 
14
- var _render = _interopRequireDefault(require("./render"));
15
-
16
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
+ var _render = require("./render");
17
15
 
18
16
  /* eslint-disable prefer-destructuring */
19
17
  var framework = 'html';
20
- var api = (0, _client.start)(_render.default);
18
+ var api = (0, _client.start)(_render.renderToDOM);
21
19
 
22
20
  var storiesOf = function storiesOf(kind, m) {
23
21
  return api.clientApi.storiesOf(kind, m).addParameters({
@@ -7,7 +7,7 @@ require("core-js/modules/es.object.freeze.js");
7
7
  Object.defineProperty(exports, "__esModule", {
8
8
  value: true
9
9
  });
10
- exports.default = renderMain;
10
+ exports.renderToDOM = renderToDOM;
11
11
 
12
12
  require("core-js/modules/es.function.name.js");
13
13
 
@@ -17,7 +17,7 @@ var _global = _interopRequireDefault(require("global"));
17
17
 
18
18
  var _tsDedent = _interopRequireDefault(require("ts-dedent"));
19
19
 
20
- var _clientApi = require("@storybook/client-api");
20
+ var _previewWeb = require("@storybook/preview-web");
21
21
 
22
22
  var _templateObject;
23
23
 
@@ -25,32 +25,29 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
25
25
 
26
26
  function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
27
27
 
28
- var document = _global.default.document,
29
- Node = _global.default.Node;
30
- var rootElement = document.getElementById('root');
28
+ var Node = _global.default.Node;
31
29
 
32
- function renderMain(_ref) {
30
+ function renderToDOM(_ref, domElement) {
33
31
  var storyFn = _ref.storyFn,
34
32
  kind = _ref.kind,
35
33
  name = _ref.name,
36
34
  showMain = _ref.showMain,
37
35
  showError = _ref.showError,
38
- forceRender = _ref.forceRender;
36
+ forceRemount = _ref.forceRemount;
39
37
  var element = storyFn();
40
38
  showMain();
41
39
 
42
40
  if (typeof element === 'string') {
43
- rootElement.innerHTML = element;
44
- (0, _clientApi.simulatePageLoad)(rootElement);
41
+ domElement.innerHTML = element;
42
+ (0, _previewWeb.simulatePageLoad)(domElement);
45
43
  } else if (element instanceof Node) {
46
- // Don't re-mount the element if it didn't change and neither did the story
47
- if (rootElement.firstChild === element && forceRender === true) {
44
+ if (domElement.firstChild === element && forceRemount === false) {
48
45
  return;
49
46
  }
50
47
 
51
- rootElement.innerHTML = '';
52
- rootElement.appendChild(element);
53
- (0, _clientApi.simulateDOMContentLoaded)();
48
+ domElement.innerHTML = '';
49
+ domElement.appendChild(element);
50
+ (0, _previewWeb.simulateDOMContentLoaded)();
54
51
  } else {
55
52
  showError({
56
53
  title: "Expecting an HTML snippet or DOM node from the story: \"".concat(name, "\" of \"").concat(kind, "\"."),
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,4 @@
1
+ export { renderToDOM } from './render';
2
+ export var parameters = {
3
+ framework: 'html'
4
+ };
@@ -3,9 +3,9 @@ import "core-js/modules/es.array.concat.js";
3
3
  /* eslint-disable prefer-destructuring */
4
4
  import { start } from '@storybook/core/client';
5
5
  import './globals';
6
- import render from './render';
6
+ import { renderToDOM } from './render';
7
7
  var framework = 'html';
8
- var api = start(render);
8
+ var api = start(renderToDOM);
9
9
  export var storiesOf = function storiesOf(kind, m) {
10
10
  return api.clientApi.storiesOf(kind, m).addParameters({
11
11
  framework: framework
@@ -6,33 +6,32 @@ import "core-js/modules/es.function.name.js";
6
6
  import "core-js/modules/es.array.concat.js";
7
7
  import "core-js/modules/es.array.slice.js";
8
8
  import "core-js/modules/es.object.freeze.js";
9
+
10
+ /* eslint-disable no-param-reassign */
9
11
  import global from 'global';
10
12
  import dedent from 'ts-dedent';
11
- import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/client-api';
12
- var document = global.document,
13
- Node = global.Node;
14
- var rootElement = document.getElementById('root');
15
- export default function renderMain(_ref) {
13
+ import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/preview-web';
14
+ var Node = global.Node;
15
+ export function renderToDOM(_ref, domElement) {
16
16
  var storyFn = _ref.storyFn,
17
17
  kind = _ref.kind,
18
18
  name = _ref.name,
19
19
  showMain = _ref.showMain,
20
20
  showError = _ref.showError,
21
- forceRender = _ref.forceRender;
21
+ forceRemount = _ref.forceRemount;
22
22
  var element = storyFn();
23
23
  showMain();
24
24
 
25
25
  if (typeof element === 'string') {
26
- rootElement.innerHTML = element;
27
- simulatePageLoad(rootElement);
26
+ domElement.innerHTML = element;
27
+ simulatePageLoad(domElement);
28
28
  } else if (element instanceof Node) {
29
- // Don't re-mount the element if it didn't change and neither did the story
30
- if (rootElement.firstChild === element && forceRender === true) {
29
+ if (domElement.firstChild === element && forceRemount === false) {
31
30
  return;
32
31
  }
33
32
 
34
- rootElement.innerHTML = '';
35
- rootElement.appendChild(element);
33
+ domElement.innerHTML = '';
34
+ domElement.appendChild(element);
36
35
  simulateDOMContentLoaded();
37
36
  } else {
38
37
  showError({
File without changes
@@ -0,0 +1,4 @@
1
+ export { renderToDOM } from './render';
2
+ export const parameters = {
3
+ framework: 'html'
4
+ };
@@ -1,9 +1,9 @@
1
1
  /* eslint-disable prefer-destructuring */
2
2
  import { start } from '@storybook/core/client';
3
3
  import './globals';
4
- import render from './render';
4
+ import { renderToDOM } from './render';
5
5
  const framework = 'html';
6
- const api = start(render);
6
+ const api = start(renderToDOM);
7
7
  export const storiesOf = (kind, m) => {
8
8
  return api.clientApi.storiesOf(kind, m).addParameters({
9
9
  framework
@@ -1,33 +1,31 @@
1
+ /* eslint-disable no-param-reassign */
1
2
  import global from 'global';
2
3
  import dedent from 'ts-dedent';
3
- import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/client-api';
4
+ import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/preview-web';
4
5
  const {
5
- document,
6
6
  Node
7
7
  } = global;
8
- const rootElement = document.getElementById('root');
9
- export default function renderMain({
8
+ export function renderToDOM({
10
9
  storyFn,
11
10
  kind,
12
11
  name,
13
12
  showMain,
14
13
  showError,
15
- forceRender
16
- }) {
14
+ forceRemount
15
+ }, domElement) {
17
16
  const element = storyFn();
18
17
  showMain();
19
18
 
20
19
  if (typeof element === 'string') {
21
- rootElement.innerHTML = element;
22
- simulatePageLoad(rootElement);
20
+ domElement.innerHTML = element;
21
+ simulatePageLoad(domElement);
23
22
  } else if (element instanceof Node) {
24
- // Don't re-mount the element if it didn't change and neither did the story
25
- if (rootElement.firstChild === element && forceRender === true) {
23
+ if (domElement.firstChild === element && forceRemount === false) {
26
24
  return;
27
25
  }
28
26
 
29
- rootElement.innerHTML = '';
30
- rootElement.appendChild(element);
27
+ domElement.innerHTML = '';
28
+ domElement.appendChild(element);
31
29
  simulateDOMContentLoaded();
32
30
  } else {
33
31
  showError({
File without changes
@@ -0,0 +1,4 @@
1
+ export { renderToDOM } from './render';
2
+ export declare const parameters: {
3
+ framework: string;
4
+ };
@@ -1,9 +1,10 @@
1
1
  /// <reference types="webpack-env" />
2
2
  /// <reference types="node" />
3
3
  import { ClientStoryApi, Loadable } from '@storybook/addons';
4
+ import { HtmlFramework } from './types-6-0';
4
5
  import './globals';
5
- import { StoryFnHtmlReturnType, IStorybookSection } from './types';
6
- interface ClientApi extends ClientStoryApi<StoryFnHtmlReturnType> {
6
+ import { IStorybookSection } from './types';
7
+ interface ClientApi extends ClientStoryApi<HtmlFramework['storyResult']> {
7
8
  setAddon(addon: any): void;
8
9
  configure(loader: Loadable, module: NodeModule): void;
9
10
  getStorybook(): IStorybookSection[];
@@ -1,2 +1,3 @@
1
- import { RenderContext } from './types';
2
- export default function renderMain({ storyFn, kind, name, showMain, showError, forceRender, }: RenderContext): void;
1
+ import { RenderContext } from '@storybook/store';
2
+ import { HtmlFramework } from './types-6-0';
3
+ export declare function renderToDOM({ storyFn, kind, name, showMain, showError, forceRemount }: RenderContext<HtmlFramework>, domElement: HTMLElement): void;
@@ -1,16 +1,34 @@
1
- import { Args as DefaultArgs, Annotations, BaseMeta, BaseStory } from '@storybook/addons';
1
+ import { Args, ComponentAnnotations, StoryAnnotations, AnnotatedStoryFn } from '@storybook/csf';
2
2
  import { StoryFnHtmlReturnType } from './types';
3
3
  export { Args, ArgTypes, Parameters, StoryContext } from '@storybook/addons';
4
- declare type HTMLReturnType = StoryFnHtmlReturnType;
4
+ export declare type HtmlFramework = {
5
+ component: HTMLElement;
6
+ storyResult: StoryFnHtmlReturnType;
7
+ };
5
8
  /**
6
9
  * Metadata to configure the stories for a component.
7
10
  *
8
11
  * @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
9
12
  */
10
- export declare type Meta<Args = DefaultArgs> = BaseMeta<HTMLElement> & Annotations<Args, HTMLReturnType>;
13
+ export declare type Meta<TArgs = Args> = ComponentAnnotations<HtmlFramework, TArgs>;
11
14
  /**
12
- * Story function that represents a component example.
15
+ * Story function that represents a CSFv2 component example.
13
16
  *
14
17
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
15
18
  */
16
- export declare type Story<Args = DefaultArgs> = BaseStory<Args, HTMLReturnType> & Annotations<Args, HTMLReturnType>;
19
+ export declare type StoryFn<TArgs = Args> = AnnotatedStoryFn<HtmlFramework, TArgs>;
20
+ /**
21
+ * Story function that represents a CSFv3 component example.
22
+ *
23
+ * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
24
+ */
25
+ export declare type StoryObj<TArgs = Args> = StoryAnnotations<HtmlFramework, TArgs>;
26
+ /**
27
+ * Story function that represents a CSFv2 component example.
28
+ *
29
+ * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
30
+ *
31
+ * NOTE that in Storybook 7.0, this type will be renamed to `StoryFn` and replaced by the current `StoryObj` type.
32
+ *
33
+ */
34
+ export declare type Story<TArgs = Args> = StoryFn<TArgs>;
@@ -0,0 +1,9 @@
1
+ import { Args } from '@storybook/csf';
2
+ import { StoryObj } from './types-6-0';
3
+ export { StoryFn, StoryObj, Meta } from './types-6-0';
4
+ /**
5
+ * Story function that represents a CSFv3 component example.
6
+ *
7
+ * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
8
+ */
9
+ export declare type Story<TArgs = Args> = StoryObj<TArgs>;
@@ -2,7 +2,7 @@ export { RenderContext } from '@storybook/core';
2
2
  export declare type StoryFnHtmlReturnType = string | Node;
3
3
  export interface IStorybookStory {
4
4
  name: string;
5
- render: () => any;
5
+ render: (context: any) => any;
6
6
  }
7
7
  export interface IStorybookSection {
8
8
  kind: string;
@@ -0,0 +1,4 @@
1
+ export { renderToDOM } from './render';
2
+ export declare const parameters: {
3
+ framework: string;
4
+ };
@@ -1,9 +1,10 @@
1
1
  /// <reference types="webpack-env" />
2
2
  /// <reference types="node" />
3
3
  import { ClientStoryApi, Loadable } from '@storybook/addons';
4
+ import { HtmlFramework } from './types-6-0';
4
5
  import './globals';
5
- import { StoryFnHtmlReturnType, IStorybookSection } from './types';
6
- interface ClientApi extends ClientStoryApi<StoryFnHtmlReturnType> {
6
+ import { IStorybookSection } from './types';
7
+ interface ClientApi extends ClientStoryApi<HtmlFramework['storyResult']> {
7
8
  setAddon(addon: any): void;
8
9
  configure(loader: Loadable, module: NodeModule): void;
9
10
  getStorybook(): IStorybookSection[];
@@ -1,2 +1,3 @@
1
- import { RenderContext } from './types';
2
- export default function renderMain({ storyFn, kind, name, showMain, showError, forceRender, }: RenderContext): void;
1
+ import { RenderContext } from '@storybook/store';
2
+ import { HtmlFramework } from './types-6-0';
3
+ export declare function renderToDOM({ storyFn, kind, name, showMain, showError, forceRemount }: RenderContext<HtmlFramework>, domElement: HTMLElement): void;
@@ -1,16 +1,34 @@
1
- import { Args as DefaultArgs, Annotations, BaseMeta, BaseStory } from '@storybook/addons';
1
+ import { Args, ComponentAnnotations, StoryAnnotations, AnnotatedStoryFn } from '@storybook/csf';
2
2
  import { StoryFnHtmlReturnType } from './types';
3
3
  export type { Args, ArgTypes, Parameters, StoryContext } from '@storybook/addons';
4
- declare type HTMLReturnType = StoryFnHtmlReturnType;
4
+ export declare type HtmlFramework = {
5
+ component: HTMLElement;
6
+ storyResult: StoryFnHtmlReturnType;
7
+ };
5
8
  /**
6
9
  * Metadata to configure the stories for a component.
7
10
  *
8
11
  * @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
9
12
  */
10
- export declare type Meta<Args = DefaultArgs> = BaseMeta<HTMLElement> & Annotations<Args, HTMLReturnType>;
13
+ export declare type Meta<TArgs = Args> = ComponentAnnotations<HtmlFramework, TArgs>;
11
14
  /**
12
- * Story function that represents a component example.
15
+ * Story function that represents a CSFv2 component example.
13
16
  *
14
17
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
15
18
  */
16
- export declare type Story<Args = DefaultArgs> = BaseStory<Args, HTMLReturnType> & Annotations<Args, HTMLReturnType>;
19
+ export declare type StoryFn<TArgs = Args> = AnnotatedStoryFn<HtmlFramework, TArgs>;
20
+ /**
21
+ * Story function that represents a CSFv3 component example.
22
+ *
23
+ * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
24
+ */
25
+ export declare type StoryObj<TArgs = Args> = StoryAnnotations<HtmlFramework, TArgs>;
26
+ /**
27
+ * Story function that represents a CSFv2 component example.
28
+ *
29
+ * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
30
+ *
31
+ * NOTE that in Storybook 7.0, this type will be renamed to `StoryFn` and replaced by the current `StoryObj` type.
32
+ *
33
+ */
34
+ export declare type Story<TArgs = Args> = StoryFn<TArgs>;
@@ -0,0 +1,9 @@
1
+ import { Args } from '@storybook/csf';
2
+ import type { StoryObj } from './types-6-0';
3
+ export type { StoryFn, StoryObj, Meta } from './types-6-0';
4
+ /**
5
+ * Story function that represents a CSFv3 component example.
6
+ *
7
+ * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
8
+ */
9
+ export declare type Story<TArgs = Args> = StoryObj<TArgs>;
@@ -2,7 +2,7 @@ export type { RenderContext } from '@storybook/core';
2
2
  export declare type StoryFnHtmlReturnType = string | Node;
3
3
  export interface IStorybookStory {
4
4
  name: string;
5
- render: () => any;
5
+ render: (context: any) => any;
6
6
  }
7
7
  export interface IStorybookSection {
8
8
  kind: string;
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@storybook/html",
3
- "version": "6.4.0-alpha.8",
3
+ "version": "6.4.0-beta.2",
4
4
  "description": "Storybook for HTML: View HTML snippets in isolation with Hot Reloading.",
5
5
  "keywords": [
6
6
  "storybook"
7
7
  ],
8
- "homepage": "https://github.com/storybookjs/storybook/tree/master/app/html",
8
+ "homepage": "https://github.com/storybookjs/storybook/tree/main/app/html",
9
9
  "bugs": {
10
10
  "url": "https://github.com/storybookjs/storybook/issues"
11
11
  },
@@ -24,7 +24,7 @@
24
24
  "types": "dist/ts3.9/client/index.d.ts",
25
25
  "typesVersions": {
26
26
  "<3.8": {
27
- "*": [
27
+ "dist/ts3.9/*": [
28
28
  "dist/ts3.4/*"
29
29
  ]
30
30
  }
@@ -45,10 +45,13 @@
45
45
  "prepare": "node ../../scripts/prepare.js"
46
46
  },
47
47
  "dependencies": {
48
- "@storybook/addons": "6.4.0-alpha.8",
49
- "@storybook/client-api": "6.4.0-alpha.8",
50
- "@storybook/core": "6.4.0-alpha.8",
51
- "@storybook/core-common": "6.4.0-alpha.8",
48
+ "@storybook/addons": "6.4.0-beta.2",
49
+ "@storybook/client-api": "6.4.0-beta.2",
50
+ "@storybook/core": "6.4.0-beta.2",
51
+ "@storybook/core-common": "6.4.0-beta.2",
52
+ "@storybook/csf": "0.0.2--canary.6aca495.0",
53
+ "@storybook/preview-web": "6.4.0-beta.2",
54
+ "@storybook/store": "6.4.0-beta.2",
52
55
  "@types/webpack-env": "^1.16.0",
53
56
  "core-js": "^3.8.2",
54
57
  "global": "^4.4.0",
@@ -68,6 +71,6 @@
68
71
  "publishConfig": {
69
72
  "access": "public"
70
73
  },
71
- "gitHead": "1ea7d55df3dc036f6ea091cb09cdc8f9512bda3d",
74
+ "gitHead": "3358e1e90c4e46dfd28e7ab822d5d20579463186",
72
75
  "sbmodern": "dist/modern/client/index.js"
73
76
  }
package/preset.js ADDED
@@ -0,0 +1,7 @@
1
+ function config(entry = []) {
2
+ return [...entry, require.resolve('./dist/esm/client/preview/config')];
3
+ }
4
+
5
+ module.exports = {
6
+ config,
7
+ };