@storybook/addon-docs 7.1.0-alpha.9 → 7.1.0-beta.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.
@@ -0,0 +1 @@
1
+ export { DocsRenderer, defaultComponents } from './chunk-S4VUQJ4A.mjs';
package/dist/blocks.d.ts CHANGED
@@ -1 +1,2 @@
1
1
  export * from '@storybook/blocks';
2
+ import '@mdx-js/react';
package/dist/blocks.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 __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},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default"));var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var blocks_exports={};module.exports=__toCommonJS(blocks_exports);var import_client_logger=require("@storybook/client-logger");__reExport(blocks_exports,require("@storybook/blocks"),module.exports);(0,import_client_logger.deprecate)("Import from '@storybook/addon-docs/blocks' is deprecated. Please import from '@storybook/blocks' instead.");
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},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default"));var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var blocks_exports={};module.exports=__toCommonJS(blocks_exports);var import_client_logger=require("@storybook/client-logger");__reExport(blocks_exports,require("@storybook/blocks"),module.exports);(0,import_client_logger.deprecate)("Import from '@storybook/addon-docs/blocks' is deprecated. Please import from '@storybook/blocks' instead.");0&&(module.exports={...require("@storybook/blocks")});
package/dist/blocks.mjs CHANGED
@@ -1 +1,4 @@
1
- import{deprecate}from"@storybook/client-logger";export*from"@storybook/blocks";deprecate("Import from '@storybook/addon-docs/blocks' is deprecated. Please import from '@storybook/blocks' instead.");
1
+ import { deprecate } from '@storybook/client-logger';
2
+ export * from '@storybook/blocks';
3
+
4
+ deprecate("Import from '@storybook/addon-docs/blocks' is deprecated. Please import from '@storybook/blocks' instead.");
@@ -0,0 +1,7 @@
1
+ import React, { Component } from 'react';
2
+ import { renderElement, unmountElement } from '@storybook/react-dom-shim';
3
+ import { CodeOrSourceMdx, AnchorMdx, HeadersMdx, Docs } from '@storybook/blocks';
4
+
5
+ var defaultComponents={code:CodeOrSourceMdx,a:AnchorMdx,...HeadersMdx},ErrorBoundary=class extends Component{constructor(){super(...arguments);this.state={hasError:!1};}static getDerivedStateFromError(){return {hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err);}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter?.components},TDocs=Docs;return new Promise((resolve,reject)=>{import('@mdx-js/react').then(({MDXProvider})=>renderElement(React.createElement(ErrorBoundary,{showException:reject,key:Math.random()},React.createElement(MDXProvider,{components},React.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve());})},this.unmount=element=>{unmountElement(element);};}};
6
+
7
+ export { DocsRenderer, defaultComponents };
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- "use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__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},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default")),__toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{DocsRenderer:()=>DocsRenderer});module.exports=__toCommonJS(src_exports);__reExport(src_exports,require("@storybook/blocks"),module.exports);var import_react=__toESM(require("react")),import_react_dom_shim=require("@storybook/react-dom-shim"),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_react.Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}};0&&(module.exports={DocsRenderer});
1
+ "use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__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},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default")),__toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{DocsRenderer:()=>DocsRenderer});module.exports=__toCommonJS(src_exports);__reExport(src_exports,require("@storybook/blocks"),module.exports);var import_react=__toESM(require("react")),import_react_dom_shim=require("@storybook/react-dom-shim"),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_react.Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components},TDocs=import_blocks.Docs;return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}};0&&(module.exports={DocsRenderer,...require("@storybook/blocks")});
package/dist/index.mjs CHANGED
@@ -1 +1,2 @@
1
- import{DocsRenderer}from"./chunk-P6PZAA6U.mjs";import"./chunk-R4NKYYJA.mjs";export*from"@storybook/blocks";export{DocsRenderer};
1
+ export { DocsRenderer } from './chunk-S4VUQJ4A.mjs';
2
+ export * from '@storybook/blocks';
package/dist/preview.js CHANGED
@@ -1 +1 @@
1
- "use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __esm=(fn,res)=>function(){return fn&&(res=(0,fn[__getOwnPropNames(fn)[0]])(fn=0)),res};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 __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>DocsRenderer,defaultComponents:()=>defaultComponents});var import_react,import_react_dom_shim,import_blocks,defaultComponents,ErrorBoundary,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){"use strict";import_react=__toESM(require("react")),import_react_dom_shim=require("@storybook/react-dom-shim"),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_react.Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}}}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});module.exports=__toCommonJS(preview_exports);var parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2}}};0&&(module.exports={parameters});
1
+ "use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __esm=(fn,res)=>function(){return fn&&(res=(0,fn[__getOwnPropNames(fn)[0]])(fn=0)),res};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 __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>DocsRenderer,defaultComponents:()=>defaultComponents});var import_react,import_react_dom_shim,import_blocks,defaultComponents,ErrorBoundary,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){"use strict";import_react=__toESM(require("react")),import_react_dom_shim=require("@storybook/react-dom-shim"),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_react.Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components},TDocs=import_blocks.Docs;return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}}}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});module.exports=__toCommonJS(preview_exports);var parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2}}};0&&(module.exports={parameters});
package/dist/preview.mjs CHANGED
@@ -1 +1,3 @@
1
- import"./chunk-R4NKYYJA.mjs";var parameters={docs:{renderer:async()=>{let{DocsRenderer}=await import("./DocsRenderer-TLBHEYVW.mjs");return new DocsRenderer}}};export{parameters};
1
+ var parameters={docs:{renderer:async()=>{let{DocsRenderer}=await import('./DocsRenderer-3PUGWF3O.mjs');return new DocsRenderer}}};
2
+
3
+ export { parameters };
@@ -1 +1 @@
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},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default"));var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var mdx_react_shim_exports={};module.exports=__toCommonJS(mdx_react_shim_exports);__reExport(mdx_react_shim_exports,require("@mdx-js/react"),module.exports);
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},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default"));var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var mdx_react_shim_exports={};module.exports=__toCommonJS(mdx_react_shim_exports);__reExport(mdx_react_shim_exports,require("@mdx-js/react"),module.exports);0&&(module.exports={...require("@mdx-js/react")});
@@ -1 +1 @@
1
- export*from"@mdx-js/react";
1
+ export * from '@mdx-js/react';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/addon-docs",
3
- "version": "7.1.0-alpha.9",
3
+ "version": "7.1.0-beta.0",
4
4
  "description": "Document component usage and properties in Markdown",
5
5
  "keywords": [
6
6
  "addon",
@@ -17,7 +17,7 @@
17
17
  "repository": {
18
18
  "type": "git",
19
19
  "url": "https://github.com/storybookjs/storybook.git",
20
- "directory": "addons/docs"
20
+ "directory": "code/addons/docs"
21
21
  },
22
22
  "funding": {
23
23
  "type": "opencollective",
@@ -27,44 +27,42 @@
27
27
  "exports": {
28
28
  ".": {
29
29
  "node": "./dist/index.js",
30
+ "types": "./dist/index.d.ts",
30
31
  "require": "./dist/index.js",
31
- "import": "./dist/index.mjs",
32
- "types": "./dist/index.d.ts"
32
+ "import": "./dist/index.mjs"
33
33
  },
34
34
  "./preview": {
35
+ "types": "./dist/preview.d.ts",
35
36
  "require": "./dist/preview.js",
36
- "import": "./dist/preview.mjs",
37
- "types": "./dist/preview.d.ts"
37
+ "import": "./dist/preview.mjs"
38
38
  },
39
39
  "./preset": {
40
- "require": "./dist/preset.js",
41
- "import": "./dist/preset.mjs",
42
- "types": "./dist/preset.d.ts"
40
+ "types": "./dist/preset.d.ts",
41
+ "require": "./dist/preset.js"
43
42
  },
44
43
  "./blocks": {
44
+ "types": "./dist/blocks.d.ts",
45
45
  "require": "./dist/blocks.js",
46
- "import": "./dist/blocks.mjs",
47
- "types": "./dist/blocks.d.ts"
46
+ "import": "./dist/blocks.mjs"
48
47
  },
49
48
  "./dist/preview": {
49
+ "types": "./dist/preview.d.ts",
50
50
  "require": "./dist/preview.js",
51
- "import": "./dist/preview.mjs",
52
- "types": "./dist/preview.d.ts"
51
+ "import": "./dist/preview.mjs"
53
52
  },
54
53
  "./dist/preset": {
55
- "require": "./dist/preset.js",
56
- "import": "./dist/preset.mjs",
57
- "types": "./dist/preset.d.ts"
54
+ "types": "./dist/preset.d.ts",
55
+ "require": "./dist/preset.js"
58
56
  },
59
57
  "./dist/shims/mdx-react-shim": {
58
+ "types": "./dist/shims/mdx-react-shim.d.ts",
60
59
  "require": "./dist/shims/mdx-react-shim.js",
61
- "import": "./dist/shims/mdx-react-shim.mjs",
62
- "types": "./dist/shims/mdx-react-shim.d.ts"
60
+ "import": "./dist/shims/mdx-react-shim.mjs"
63
61
  },
64
62
  "./mdx-react-shim": {
63
+ "types": "./dist/shims/mdx-react-shim.d.ts",
65
64
  "require": "./dist/shims/mdx-react-shim.js",
66
- "import": "./dist/shims/mdx-react-shim.mjs",
67
- "types": "./dist/shims/mdx-react-shim.d.ts"
65
+ "import": "./dist/shims/mdx-react-shim.mjs"
68
66
  },
69
67
  "./svelte/HOC.svelte": "./svelte/HOC.svelte",
70
68
  "./ember": "./ember/index.js",
@@ -101,19 +99,19 @@
101
99
  "dependencies": {
102
100
  "@jest/transform": "^29.3.1",
103
101
  "@mdx-js/react": "^2.1.5",
104
- "@storybook/blocks": "7.1.0-alpha.9",
105
- "@storybook/client-logger": "7.1.0-alpha.9",
106
- "@storybook/components": "7.1.0-alpha.9",
107
- "@storybook/csf-plugin": "7.1.0-alpha.9",
108
- "@storybook/csf-tools": "7.1.0-alpha.9",
102
+ "@storybook/blocks": "7.1.0-beta.0",
103
+ "@storybook/client-logger": "7.1.0-beta.0",
104
+ "@storybook/components": "7.1.0-beta.0",
105
+ "@storybook/csf-plugin": "7.1.0-beta.0",
106
+ "@storybook/csf-tools": "7.1.0-beta.0",
109
107
  "@storybook/global": "^5.0.0",
110
108
  "@storybook/mdx2-csf": "^1.0.0",
111
- "@storybook/node-logger": "7.1.0-alpha.9",
112
- "@storybook/postinstall": "7.1.0-alpha.9",
113
- "@storybook/preview-api": "7.1.0-alpha.9",
114
- "@storybook/react-dom-shim": "7.1.0-alpha.9",
115
- "@storybook/theming": "7.1.0-alpha.9",
116
- "@storybook/types": "7.1.0-alpha.9",
109
+ "@storybook/node-logger": "7.1.0-beta.0",
110
+ "@storybook/postinstall": "7.1.0-beta.0",
111
+ "@storybook/preview-api": "7.1.0-beta.0",
112
+ "@storybook/react-dom-shim": "7.1.0-beta.0",
113
+ "@storybook/theming": "7.1.0-beta.0",
114
+ "@storybook/types": "7.1.0-beta.0",
117
115
  "fs-extra": "^11.1.0",
118
116
  "remark-external-links": "^8.0.0",
119
117
  "remark-slug": "^6.0.0",
@@ -143,7 +141,7 @@
143
141
  "@storybook/mdx1-csf"
144
142
  ]
145
143
  },
146
- "gitHead": "ec112401efaae6d3d4996c790a30301177570da9",
144
+ "gitHead": "e6a7fd8a655c69780bc20b9749c2699e44beae17",
147
145
  "storybook": {
148
146
  "displayName": "Docs",
149
147
  "icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
@@ -151,4 +149,4 @@
151
149
  "react-native"
152
150
  ]
153
151
  }
154
- }
152
+ }
@@ -0,0 +1,15 @@
1
+ declare module '@egoist/vue-to-react';
2
+ declare module 'remark-slug';
3
+ declare module 'remark-external-links';
4
+ declare module 'babel-plugin-react-docgen';
5
+ declare module 'acorn-jsx';
6
+ declare module 'vue/dist/vue';
7
+ declare module '@storybook/mdx1-csf';
8
+
9
+ declare module 'sveltedoc-parser' {
10
+ export function parse(options: any): Promise<any>;
11
+ }
12
+
13
+ declare var FEATURES: import('@storybook/types').StorybookConfig['features'];
14
+
15
+ declare var LOGLEVEL: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent' | undefined;
@@ -0,0 +1,19 @@
1
+ // NOTE: commented out default since these stories are re-exported
2
+ // in the primary file './csf-docs-with-mdx-docs.stories.mdx'
3
+ //
4
+ // export default {
5
+ // title: 'Addons/Docs/csf-with-mdx-docs',
6
+ // component: Button,
7
+ // };
8
+
9
+ export const Primary = {
10
+ args: { label: 'Primary' },
11
+ };
12
+
13
+ export const Secondary = {
14
+ args: { label: 'Secondary' },
15
+ };
16
+
17
+ export const ImplicitName = {
18
+ args: { label: 'Implicit Name' },
19
+ };
package/vue3/README.md ADDED
@@ -0,0 +1,152 @@
1
+ <center>
2
+ <img src="../docs/media/vue-hero.png" width="100%" />
3
+ </center>
4
+
5
+ <h1>Storybook Docs for Vue 3</h1>
6
+
7
+ > migration guide: This page documents the method to configure storybook introduced recently in 5.3.0, consult the [migration guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md) if you want to migrate to this format of configuring storybook.
8
+
9
+ Storybook Docs transforms your Storybook stories into world-class component documentation. Storybook Docs for Vue 3 supports [DocsPage](../docs/docspage.md) for auto-generated docs, and [MDX](../docs/mdx.md) for rich long-form docs.
10
+
11
+ To learn more about Storybook Docs, read the [general documentation](../README.md). To learn the Vue 3 specifics, read on!
12
+
13
+ - [Installation](#installation)
14
+ - [Preset options](#preset-options)
15
+ - [DocsPage](#docspage)
16
+ - [Props tables](#props-tables)
17
+ - [MDX](#mdx)
18
+ - [Inline Stories](#inline-stories)
19
+ - [More resources](#more-resources)
20
+
21
+ ## Installation
22
+
23
+ First add the package. Make sure that the versions for your `@storybook/*` packages match:
24
+
25
+ ```sh
26
+ yarn add -D @storybook/addon-docs
27
+ ```
28
+
29
+ Then add the following to your `.storybook/main.js` addons:
30
+
31
+ ```js
32
+ export default {
33
+ addons: ['@storybook/addon-docs'],
34
+ };
35
+ ```
36
+
37
+ ## Preset options
38
+
39
+ The `addon-docs` preset for Vue has a configuration option that can be used to configure [`vue-docgen-api`](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api), a tool which extracts information from Vue components. Here's an example of how to use the preset with options for Vue app:
40
+
41
+ ```js
42
+ import * as path from 'path';
43
+
44
+ export default {
45
+ addons: [
46
+ {
47
+ name: '@storybook/addon-docs',
48
+ options: {
49
+ vueDocgenOptions: {
50
+ alias: {
51
+ '@': path.resolve(__dirname, '../'),
52
+ },
53
+ },
54
+ },
55
+ },
56
+ ],
57
+ };
58
+ ```
59
+
60
+ The `vueDocgenOptions` is an object for configuring `vue-docgen-api`. See [`vue-docgen-api`'s docs](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api#options-docgenoptions) for available configuration options.
61
+
62
+ ## DocsPage
63
+
64
+ When you [install docs](#installation) you should get basic [DocsPage](../docs/docspage.md) documentation automagically for all your stories, available in the `Docs` tab of the Storybook UI.
65
+
66
+ ## Props tables
67
+
68
+ Getting [Props tables](../docs/props-tables.md) for your components requires a few more steps. Docs for Vue relies on [`vue-docgen-loader`](https://github.com/pocka/vue-docgen-loader). It supports `props`, `events`, and `slots` as first class prop types.
69
+
70
+ Finally, be sure to fill in the `component` field in your story metadata:
71
+
72
+ ```ts
73
+ import { InfoButton } from './InfoButton.vue';
74
+
75
+ export default {
76
+ title: 'InfoButton',
77
+ component: InfoButton,
78
+ };
79
+ ```
80
+
81
+ If you haven't upgraded from `storiesOf`, you can use a parameter to do the same thing:
82
+
83
+ ```ts
84
+ import { storiesOf } from '@storybook/vue';
85
+ import { InfoButton } from './InfoButton.vue';
86
+
87
+ storiesOf('InfoButton', module)
88
+ .addParameters({ component: InfoButton })
89
+ .add( ... );
90
+ ```
91
+
92
+ ## MDX
93
+
94
+ [MDX](../docs/mdx.md) is a convenient way to document your components in Markdown and embed documentation components, such as stories and props tables, inline.
95
+
96
+ Docs has peer dependencies on `react`. If you want to write stories in MDX, you may need to add this dependency as well:
97
+
98
+ ```sh
99
+ yarn add -D react
100
+ ```
101
+
102
+ Then update your `.storybook/main.js` to make sure you load MDX files:
103
+
104
+ ```js
105
+ export default {
106
+ stories: ['../src/stories/**/*.stories.@(js|mdx)'],
107
+ };
108
+ ```
109
+
110
+ Finally, you can create MDX files like this:
111
+
112
+ ```md
113
+ import { Meta, Story, ArgsTable } from '@storybook/addon-docs';
114
+ import { InfoButton } from './InfoButton.vue';
115
+
116
+ <Meta title='InfoButton' component={InfoButton} />
117
+
118
+ # InfoButton
119
+
120
+ Some **markdown** description, or whatever you want.
121
+
122
+ <Story name='basic' height='400px'>{{
123
+ components: { InfoButton },
124
+ template: '<info-button label="I\'m a button!"/>',
125
+ }}</Story>
126
+
127
+ ## ArgsTable
128
+
129
+ <ArgsTable of={InfoButton} />
130
+ ```
131
+
132
+ Yes, it's redundant to declare `component` twice. [Coming soon](https://github.com/storybookjs/storybook/issues/8685).
133
+
134
+ ## Inline Stories
135
+
136
+ Storybook Docs renders all Vue stories inline by default.
137
+
138
+ However, you can render stories in an iframe, with a default height of `60px` (configurable using the `docs.story.iframeHeight` story parameter), by using the `docs.stories.inline` parameter.
139
+
140
+ To do so for all stories, update `.storybook/preview.js`:
141
+
142
+ ```js
143
+ export const parameters = { docs: { story: { inline: false } } };
144
+ ```
145
+
146
+ ## More resources
147
+
148
+ Want to learn more? Here are some more articles on Storybook Docs:
149
+
150
+ - References: [DocsPage](../docs/docspage.md) / [MDX](../docs/mdx.md) / [FAQ](../docs/faq.md) / [Recipes](../docs/recipes.md) / [Theming](../docs/theming.md) / [Props](../docs/props-tables.md)
151
+ - Announcements: [Vision](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a) / [DocsPage](https://medium.com/storybookjs/storybook-docspage-e185bc3622bf) / [MDX](https://medium.com/storybookjs/rich-docs-with-storybook-mdx-61bc145ae7bc) / [Framework support](https://medium.com/storybookjs/storybook-docs-for-new-frameworks-b1f6090ee0ea)
152
+ - Example: [Storybook Design System](https://github.com/storybookjs/design-system)
@@ -1 +0,0 @@
1
- import{DocsRenderer,defaultComponents}from"./chunk-P6PZAA6U.mjs";import"./chunk-R4NKYYJA.mjs";export{DocsRenderer,defaultComponents};
@@ -1 +0,0 @@
1
- import React,{Component}from"react";import{renderElement,unmountElement}from"@storybook/react-dom-shim";import{Docs,CodeOrSourceMdx,AnchorMdx,HeadersMdx}from"@storybook/blocks";var defaultComponents={code:CodeOrSourceMdx,a:AnchorMdx,...HeadersMdx},ErrorBoundary=class extends Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter?.components};return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>renderElement(React.createElement(ErrorBoundary,{showException:reject,key:Math.random()},React.createElement(MDXProvider,{components},React.createElement(Docs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{unmountElement(element)}}};export{defaultComponents,DocsRenderer};
@@ -1 +0,0 @@
1
- var __require=(x=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(x,{get:(a,b)=>(typeof require<"u"?require:a)[b]}):x)(function(x){if(typeof require<"u")return require.apply(this,arguments);throw new Error('Dynamic require of "'+x+'" is not supported')});export{__require};
package/dist/preset.mjs DELETED
@@ -1,40 +0,0 @@
1
- import{__require}from"./chunk-R4NKYYJA.mjs";import fs from"fs-extra";import remarkSlug from"remark-slug";import remarkExternalLinks from"remark-external-links";import{dedent as dedent2}from"ts-dedent";import{global}from"@storybook/global";import{loadCsf}from"@storybook/csf-tools";import{logger as logger2}from"@storybook/node-logger";import{logger}from"@storybook/node-logger";import dedent from"ts-dedent";function ensureReactPeerDeps(){try{__require.resolve("react"),__require.resolve("react-dom")}catch{logger.error(dedent`
2
- Starting in 7.0, react and react-dom are now required peer dependencies of Storybook.
3
- https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#react-peer-dependencies-required
4
-
5
- It seems that you haven't run Storybook's CLI to upgrade to the latest version.
6
- The upgrade command will install the required peer dependencies for you and will take
7
- care of other important auto migrations as well.
8
-
9
- If you want to upgrade to the latest prerelease version, please run:
10
-
11
- $ npx storybook@next upgrade --prerelease
12
-
13
- Otherwise, please run:
14
-
15
- $ npx storybook upgrade
16
-
17
- If you do not want to use the upgrade commands,
18
- please install react and react-dom in your project manually.
19
-
20
- npm:
21
- $ npm add react react-dom --dev
22
-
23
- yarn:
24
- $ yarn add react react-dom --dev
25
-
26
- pnpm:
27
- $ pnpm add react react-dom --dev
28
- `),process.exit(1)}}async function webpack(webpackConfig={},options){let{module={}}=webpackConfig,{csfPluginOptions={},jsxOptions={},sourceLoaderOptions=null,configureJsx,mdxBabelOptions,mdxPluginOptions={}}=options,mdxLoaderOptions=await options.presets.apply("mdxLoaderOptions",{skipCsf:!0,...mdxPluginOptions,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",...mdxPluginOptions.mdxCompileOptions,remarkPlugins:[remarkSlug,remarkExternalLinks].concat(mdxPluginOptions?.mdxCompileOptions?.remarkPlugins??[])},jsxOptions});if(sourceLoaderOptions)throw new Error(dedent2`
29
- Addon-docs no longer uses source-loader in 7.0.
30
-
31
- To update your configuration, please see migration instructions here:
32
-
33
- https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
34
- `);if(mdxBabelOptions||configureJsx)throw new Error(dedent2`
35
- Addon-docs no longer uses configureJsx or mdxBabelOptions in 7.0.
36
-
37
- To update your configuration, please see migration instructions here:
38
-
39
- https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-addon-docs-manual-babel-configuration
40
- `);let mdxVersion=global.FEATURES?.legacyMdx1?"MDX1":"MDX2";logger2.info(`Addon-docs: using ${mdxVersion}`);let mdxLoader=global.FEATURES?.legacyMdx1?__require.resolve("@storybook/mdx1-csf/loader"):__require.resolve("@storybook/mdx2-csf/loader");return{...webpackConfig,plugins:[...webpackConfig.plugins||[],...csfPluginOptions?[(await import("@storybook/csf-plugin")).webpack(csfPluginOptions)]:[]],module:{...module,rules:[...module.rules,{test:/(stories|story)\.mdx$/,use:[{loader:mdxLoader,options:{...mdxLoaderOptions,skipCsf:!1}}]},{test:/\.mdx$/,exclude:/(stories|story)\.mdx$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]}}}var storyIndexers=indexers=>[{test:/(stories|story)\.mdx$/,indexer:async(fileName,opts)=>{let code=(await fs.readFile(fileName,"utf-8")).toString(),{compile}=global.FEATURES?.legacyMdx1?await import("@storybook/mdx1-csf"):await import("@storybook/mdx2-csf");return code=await compile(code,{}),loadCsf(code,{...opts,fileName}).parse()}},...indexers||[]],docs=docsOptions=>({...docsOptions,defaultName:"Docs",autodocs:"tag"}),addons=[__require.resolve("@storybook/react-dom-shim/dist/preset")],webpackX=webpack,storyIndexersX=storyIndexers,docsX=docs;ensureReactPeerDeps();export{addons,docsX as docs,storyIndexersX as storyIndexers,webpackX as webpack};