@storybook/addon-docs 7.0.0-alpha.12 → 7.0.0-alpha.17

package/README.md

@@ -81,7 +81,6 @@ Storybook Docs supports all view layers that Storybook supports except for React
 
 [Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)
 
-
 **Note:** `#` = WIP support
 
 Want to add enhanced features to your favorite framework? Check out this [dev guide](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/multiframework.md)

package/dist/cjs/DocsRenderer.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaultComponents = exports.DocsRenderer = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _reactDom = _interopRequireDefault(require("react-dom"));
+
+var _components = require("@storybook/components");
+
+var _blocks = require("@storybook/blocks");
+
+var _react2 = require("@mdx-js/react");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// TS doesn't like that we export a component with types that it doesn't know about (TS4203)
+const defaultComponents = Object.assign({}, _components.components, {
+  code: _blocks.CodeOrSourceMdx,
+  a: _blocks.AnchorMdx
+}, _blocks.HeadersMdx);
+exports.defaultComponents = defaultComponents;
+
+class DocsRenderer {
+  constructor() {
+    this.render = void 0;
+    this.unmount = void 0;
+
+    this.render = (context, docsParameter, element, callback) => {
+      // Use a random key to force the container to re-render each time we call `renderDocs`
+      //   TODO: do we still need this? It was needed for angular (legacy) inline rendering:
+      //   https://github.com/storybookjs/storybook/pull/16149
+      _reactDom.default.render( /*#__PURE__*/_react.default.createElement(_react2.MDXProvider, {
+        components: defaultComponents
+      }, /*#__PURE__*/_react.default.createElement(_blocks.Docs, {
+        key: Math.random(),
+        context: context,
+        docsParameter: docsParameter
+      })), element, callback);
+    };
+
+    this.unmount = element => {
+      _reactDom.default.unmountComponentAtNode(element);
+    };
+  }
+
+}
+
+exports.DocsRenderer = DocsRenderer;

package/dist/cjs/index.js

@@ -3,11 +3,21 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+var _exportNames = {
+  DocsRenderer: true
+};
+Object.defineProperty(exports, "DocsRenderer", {
+  enumerable: true,
+  get: function () {
+    return _DocsRenderer.DocsRenderer;
+  }
+});
 
 var _blocks = require("./blocks");
 
 Object.keys(_blocks).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
   if (key in exports && exports[key] === _blocks[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
@@ -15,4 +25,6 @@ Object.keys(_blocks).forEach(function (key) {
       return _blocks[key];
     }
   });
-});
+});
+
+var _DocsRenderer = require("./DocsRenderer");

package/dist/cjs/preset.js

@@ -64,6 +64,7 @@ async function webpack(webpackConfig = {}, options) {
     transcludeMarkdown = false
   } = options;
   const mdxLoaderOptions = {
+    // whether to skip storybook files, useful for docs only mdx or md files
     skipCsf: true,
     remarkPlugins: [_remarkSlug.default, _remarkExternalLinks.default]
   };
@@ -116,7 +117,10 @@ async function webpack(webpackConfig = {}, options) {
             configureJSX
           })
         }, {
-          loader: mdxLoader
+          loader: mdxLoader,
+          options: Object.assign({}, mdxLoaderOptions, {
+            skipCsf: false
+          })
         }]
       }, {
         test: /\.mdx$/,

package/dist/cjs/preview.js

@@ -14,7 +14,7 @@ const parameters = {
     renderer: async () => {
       const {
         DocsRenderer
-      } = await Promise.resolve().then(() => _interopRequireWildcard(require('./blocks')));
+      } = await Promise.resolve().then(() => _interopRequireWildcard(require('./DocsRenderer')));
       return new DocsRenderer();
     }
   }

package/dist/esm/DocsRenderer.js

@@ -0,0 +1,34 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { components as htmlComponents } from '@storybook/components';
+import { Docs, CodeOrSourceMdx, AnchorMdx, HeadersMdx } from '@storybook/blocks';
+import { MDXProvider } from '@mdx-js/react'; // TS doesn't like that we export a component with types that it doesn't know about (TS4203)
+
+export const defaultComponents = Object.assign({}, htmlComponents, {
+  code: CodeOrSourceMdx,
+  a: AnchorMdx
+}, HeadersMdx);
+export class DocsRenderer {
+  constructor() {
+    this.render = void 0;
+    this.unmount = void 0;
+
+    this.render = (context, docsParameter, element, callback) => {
+      // Use a random key to force the container to re-render each time we call `renderDocs`
+      //   TODO: do we still need this? It was needed for angular (legacy) inline rendering:
+      //   https://github.com/storybookjs/storybook/pull/16149
+      ReactDOM.render( /*#__PURE__*/React.createElement(MDXProvider, {
+        components: defaultComponents
+      }, /*#__PURE__*/React.createElement(Docs, {
+        key: Math.random(),
+        context: context,
+        docsParameter: docsParameter
+      })), element, callback);
+    };
+
+    this.unmount = element => {
+      ReactDOM.unmountComponentAtNode(element);
+    };
+  }
+
+}

package/dist/esm/index.js

@@ -1 +1,2 @@
-export * from './blocks';
+export * from './blocks';
+export { DocsRenderer } from './DocsRenderer';

package/dist/esm/preset.js

@@ -45,6 +45,7 @@ export async function webpack(webpackConfig = {}, options) {
     transcludeMarkdown = false
   } = options;
   const mdxLoaderOptions = {
+    // whether to skip storybook files, useful for docs only mdx or md files
     skipCsf: true,
     remarkPlugins: [remarkSlug, remarkExternalLinks]
   };
@@ -91,7 +92,10 @@ export async function webpack(webpackConfig = {}, options) {
             configureJSX
           })
         }, {
-          loader: mdxLoader
+          loader: mdxLoader,
+          options: Object.assign({}, mdxLoaderOptions, {
+            skipCsf: false
+          })
         }]
       }, {
         test: /\.mdx$/,

package/dist/esm/preview.js

@@ -3,7 +3,7 @@ export const parameters = {
     renderer: async () => {
       const {
         DocsRenderer
-      } = await import('./blocks');
+      } = await import('./DocsRenderer');
       return new DocsRenderer();
     }
   }

package/dist/types/DocsRenderer.d.ts

@@ -0,0 +1,8 @@
+import { AnyFramework } from '@storybook/csf';
+import { DocsRenderFunction } from '@storybook/preview-web';
+export declare const defaultComponents: Record<string, any>;
+export declare class DocsRenderer<TFramework extends AnyFramework> {
+    render: DocsRenderFunction<TFramework>;
+    unmount: (element: HTMLElement) => void;
+    constructor();
+}

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export * from './blocks';
+export { DocsRenderer } from './DocsRenderer';

package/dist/types/preset.d.ts

@@ -13,5 +13,6 @@ export declare const docs: (docsOptions: DocsOptions) => {
     enabled: boolean;
     defaultName: string;
     docsPage: boolean;
+    docsMode?: boolean;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/addon-docs",
-  "version": "7.0.0-alpha.12",
+  "version": "7.0.0-alpha.17",
   "description": "Document component usage and properties in Markdown",
   "keywords": [
     "addon",
@@ -46,29 +46,29 @@
   ],
   "scripts": {
     "check": "tsc --noEmit",
-    "prepare": "node ../../scripts/prepare.js"
+    "prepare": "node ../../../scripts/prepare.js"
   },
   "dependencies": {
     "@babel/plugin-transform-react-jsx": "^7.12.12",
     "@babel/preset-env": "^7.12.11",
     "@jest/transform": "^26.6.2",
     "@mdx-js/react": "^1.6.22",
-    "@storybook/addons": "7.0.0-alpha.12",
-    "@storybook/api": "7.0.0-alpha.12",
-    "@storybook/blocks": "7.0.0-alpha.12",
-    "@storybook/components": "7.0.0-alpha.12",
-    "@storybook/core-common": "7.0.0-alpha.12",
-    "@storybook/core-events": "7.0.0-alpha.12",
+    "@storybook/addons": "7.0.0-alpha.17",
+    "@storybook/api": "7.0.0-alpha.17",
+    "@storybook/blocks": "7.0.0-alpha.17",
+    "@storybook/components": "7.0.0-alpha.17",
+    "@storybook/core-common": "7.0.0-alpha.17",
+    "@storybook/core-events": "7.0.0-alpha.17",
     "@storybook/csf": "0.0.2--canary.4566f4d.1",
-    "@storybook/csf-tools": "7.0.0-alpha.12",
-    "@storybook/docs-tools": "7.0.0-alpha.12",
-    "@storybook/mdx1-csf": "^0.0.1",
-    "@storybook/node-logger": "7.0.0-alpha.12",
-    "@storybook/postinstall": "7.0.0-alpha.12",
-    "@storybook/preview-web": "7.0.0-alpha.12",
-    "@storybook/source-loader": "7.0.0-alpha.12",
-    "@storybook/store": "7.0.0-alpha.12",
-    "@storybook/theming": "7.0.0-alpha.12",
+    "@storybook/csf-tools": "7.0.0-alpha.17",
+    "@storybook/docs-tools": "7.0.0-alpha.17",
+    "@storybook/mdx1-csf": "0.0.5-canary.13.9ce928a.0",
+    "@storybook/node-logger": "7.0.0-alpha.17",
+    "@storybook/postinstall": "7.0.0-alpha.17",
+    "@storybook/preview-web": "7.0.0-alpha.17",
+    "@storybook/source-loader": "7.0.0-alpha.17",
+    "@storybook/store": "7.0.0-alpha.17",
+    "@storybook/theming": "7.0.0-alpha.17",
     "babel-loader": "^8.2.5",
     "core-js": "^3.8.2",
     "dequal": "^2.0.2",
@@ -81,12 +81,12 @@
   },
   "devDependencies": {
     "@babel/core": "^7.12.10",
-    "@storybook/mdx2-csf": "^0.0.3",
+    "@storybook/mdx2-csf": "0.0.4-canary.14.04ffbe8.0",
     "@types/util-deprecate": "^1.0.0",
     "typescript": "~4.6.3"
   },
   "peerDependencies": {
-    "@storybook/mdx2-csf": "^0.0.3",
+    "@storybook/mdx2-csf": "0.0.4-canary.14.04ffbe8.0",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
     "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
@@ -104,7 +104,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5070efff271ecb5c26b3eb94c128c4896171cffe",
+  "gitHead": "7d44bfd3e759c6f17b75029ee2e067fab811f27b",
   "storybook": {
     "displayName": "Docs",
     "icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",

package/web-components/README.md

@@ -39,6 +39,7 @@ Known analyzers that output `custom-elements.json` v1.0.0:
   - Supports Vanilla, LitElement, FASTElement, Stencil, Catalyst, Atomico
 
 Known analyzers that output older versions of `custom-elements.json`:
+
 - [web-component-analyzer](https://github.com/runem/web-component-analyzer)
   - Supports LitElement, Polymer, Vanilla, (Stencil)
 - [stenciljs](https://stenciljs.com/)

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Kadira Inc. <hello@kadira.io>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

package/dist/cjs/manager.js

@@ -1,20 +0,0 @@
-"use strict";
-
-var _addons = require("@storybook/addons");
-
-var _shared = require("./shared");
-
-_addons.addons.register(_shared.ADDON_ID, () => {
-  _addons.addons.add(_shared.PANEL_ID, {
-    type: _addons.types.TAB,
-    title: 'Docs',
-    route: ({
-      storyId,
-      refId
-    }) => refId ? `/docs/${refId}_${storyId}` : `/docs/${storyId}`,
-    match: ({
-      viewMode
-    }) => viewMode === 'docs',
-    render: () => null
-  });
-});

package/dist/esm/manager.js

@@ -1,16 +0,0 @@
-import { addons, types } from '@storybook/addons';
-import { ADDON_ID, PANEL_ID } from './shared';
-addons.register(ADDON_ID, () => {
-  addons.add(PANEL_ID, {
-    type: types.TAB,
-    title: 'Docs',
-    route: ({
-      storyId,
-      refId
-    }) => refId ? `/docs/${refId}_${storyId}` : `/docs/${storyId}`,
-    match: ({
-      viewMode
-    }) => viewMode === 'docs',
-    render: () => null
-  });
-});

package/dist/types/manager.d.ts

@@ -1 +0,0 @@
-export {};

package/manager.js

@@ -1 +0,0 @@
-import './dist/esm/manager';

package/register.js

@@ -1,6 +0,0 @@
-import { once } from '@storybook/client-logger';
-import './manager';
-
-once.warn(
-  'register.js is deprecated see https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-registerjs'
-);