@storybook/addon-docs 7.0.0-beta.2 → 7.0.0-beta.21
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/README.md +21 -19
- package/angular/README.md +7 -12
- package/angular/index.js +2 -2
- package/dist/{DocsRenderer-FLOC7YSC.mjs → DocsRenderer-QMFTTPNP.mjs} +1 -1
- package/dist/blocks.d.ts +1 -0
- package/dist/blocks.js +1 -0
- package/dist/blocks.mjs +1 -0
- package/dist/chunk-R4NKYYJA.mjs +1 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/preset.js +8 -2
- package/dist/preset.mjs +8 -2
- package/dist/preview.js +1 -1
- package/dist/preview.mjs +1 -1
- package/dist/shims/mdx-react-shim.js +1 -1
- package/ember/README.md +1 -3
- package/ember/index.js +2 -2
- package/package.json +20 -14
- package/postinstall/presets.js +1 -3
- package/react/README.md +6 -6
- package/vue/README.md +5 -9
- package/web-components/README.md +4 -14
- package/dist/chunk-HXSBEJGO.mjs +0 -1
package/README.md
CHANGED
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
# Storybook Docs
|
|
6
6
|
|
|
7
|
-
> migration guide: This page documents the method to configure
|
|
7
|
+
> migration guide: This page documents the method to configure Storybook introduced recently in 7.0.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
8
|
|
|
9
9
|
Storybook Docs transforms your Storybook stories into world-class component documentation.
|
|
10
10
|
|
|
11
11
|
**DocsPage.** Out of the box, all your stories get a `DocsPage`. `DocsPage` is a zero-config aggregation of your component stories, text descriptions, docgen comments, props tables, and code examples into clean, readable pages.
|
|
12
12
|
|
|
13
|
-
**MDX.** If you want more control, `MDX` allows you to write long-form markdown documentation and stories in one file. You can also use it to write pure documentation pages and embed them inside your Storybook alongside your stories.
|
|
13
|
+
**MDX.** If you want more control, `MDX` allows you to write long-form markdown documentation and include stories in one file. You can also use it to write pure documentation pages and embed them inside your Storybook alongside your stories.
|
|
14
14
|
|
|
15
15
|
Just like Storybook, Docs supports every major view layer including React, Vue, Angular, HTML, Web components, Svelte, and many more.
|
|
16
16
|
|
|
@@ -40,32 +40,30 @@ For more information on how it works, see the [`DocsPage` reference](https://git
|
|
|
40
40
|
|
|
41
41
|
## MDX
|
|
42
42
|
|
|
43
|
-
`MDX` is a syntax for writing long-form documentation
|
|
43
|
+
`MDX` is a syntax for writing long-form documentation with stories side-by-side in the same file. In contrast to `DocsPage`, which provides smart documentation out of the box, `MDX` gives you full control over your component documentation.
|
|
44
44
|
|
|
45
45
|
Here's an example file:
|
|
46
46
|
|
|
47
|
+
<!-- prettier-ignore-start -->
|
|
48
|
+
|
|
47
49
|
```md
|
|
48
|
-
import { Meta, Story, Canvas } from '@storybook/
|
|
49
|
-
import
|
|
50
|
+
import { Meta, Story, Canvas } from '@storybook/blocks';
|
|
51
|
+
import * as CheckboxStories from './Checkbox.stories';
|
|
50
52
|
|
|
51
|
-
<Meta title="MDX/Checkbox"
|
|
53
|
+
<Meta title="MDX/Checkbox" of={CheckboxStories} />
|
|
52
54
|
|
|
53
55
|
# Checkbox
|
|
54
56
|
|
|
55
|
-
With `MDX` we can
|
|
57
|
+
With `MDX` we can include a story for `Checkbox` right in the middle of our
|
|
56
58
|
markdown documentation.
|
|
57
59
|
|
|
58
60
|
<Canvas>
|
|
59
|
-
<Story
|
|
60
|
-
<form>
|
|
61
|
-
<Checkbox id="Unchecked" label="Unchecked" />
|
|
62
|
-
<Checkbox id="Checked" label="Checked" checked />
|
|
63
|
-
<Checkbox appearance="secondary" id="second" label="Secondary" checked />
|
|
64
|
-
</form>
|
|
65
|
-
</Story>
|
|
61
|
+
<Story of={CheckboxStories.Unchecked} />
|
|
66
62
|
</Canvas>
|
|
67
63
|
```
|
|
68
64
|
|
|
65
|
+
<!-- prettier-ignore-end -->
|
|
66
|
+
|
|
69
67
|
And here's how that's rendered in Storybook:
|
|
70
68
|
|
|
71
69
|
<center>
|
|
@@ -102,8 +100,13 @@ Then add the following to your `.storybook/main.js`:
|
|
|
102
100
|
|
|
103
101
|
```js
|
|
104
102
|
module.exports = {
|
|
105
|
-
stories: [
|
|
106
|
-
|
|
103
|
+
stories: [
|
|
104
|
+
'../src/**/*.mdx)', // 👈 Add this, to match your project's structure
|
|
105
|
+
'../src/**/*.stories.@(js|jsx|ts|tsx)',
|
|
106
|
+
],
|
|
107
|
+
addons: [
|
|
108
|
+
'@storybook/addon-docs', // 👈 Also add this
|
|
109
|
+
],
|
|
107
110
|
};
|
|
108
111
|
```
|
|
109
112
|
|
|
@@ -140,8 +143,7 @@ module.exports = {
|
|
|
140
143
|
{
|
|
141
144
|
name: '@storybook/addon-docs',
|
|
142
145
|
options: {
|
|
143
|
-
|
|
144
|
-
babelOptions: {},
|
|
146
|
+
jsxOptions: {},
|
|
145
147
|
csfPluginOptions: null,
|
|
146
148
|
transcludeMarkdown: true,
|
|
147
149
|
},
|
|
@@ -150,7 +152,7 @@ module.exports = {
|
|
|
150
152
|
};
|
|
151
153
|
```
|
|
152
154
|
|
|
153
|
-
|
|
155
|
+
`jsxOptions` are options that will be passed to `@babel/preset-react` for `.md` and `.mdx` files.
|
|
154
156
|
|
|
155
157
|
`csfPluginOptions` is an object for configuring `@storybook/csf-plugin`. When set to `null` it tells docs not to run the `csf-plugin` at all, which can be used as an optimization, or if you're already using `csf-plugin` in your `main.js`.
|
|
156
158
|
|
package/angular/README.md
CHANGED
|
@@ -15,6 +15,7 @@ To learn more about Storybook Docs, read the [general documentation](../README.m
|
|
|
15
15
|
- [Props tables](#props-tables)
|
|
16
16
|
- [MDX](#mdx)
|
|
17
17
|
- [IFrame height](#iframe-height)
|
|
18
|
+
- [Inline Stories](#inline-stories)
|
|
18
19
|
- [More resources](#more-resources)
|
|
19
20
|
|
|
20
21
|
## Installation
|
|
@@ -186,9 +187,7 @@ Storybook Docs renders all Angular stories inside IFrames, with a default height
|
|
|
186
187
|
To update the global default, modify `.storybook/preview.ts`:
|
|
187
188
|
|
|
188
189
|
```ts
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
addParameters({ docs: { iframeHeight: 400 } });
|
|
190
|
+
export const parameters = { docs: { iframeHeight: 400 } };
|
|
192
191
|
```
|
|
193
192
|
|
|
194
193
|
For `DocsPage`, you need to update the parameter locally in a story:
|
|
@@ -208,18 +207,14 @@ And for `MDX` you can modify it as an attribute on the `Story` element:
|
|
|
208
207
|
|
|
209
208
|
## Inline Stories
|
|
210
209
|
|
|
211
|
-
Storybook Docs renders all Angular stories
|
|
210
|
+
Storybook Docs renders all Angular stories inline by default.
|
|
212
211
|
|
|
213
|
-
|
|
212
|
+
However, you can render stories in an iframe, with a default height of `60px` (configurable using the `docs.iframeHeight` story parameter), by using the `docs.inlineStories` parameter.
|
|
214
213
|
|
|
215
|
-
|
|
216
|
-
import { addParameters } from '@storybook/angular';
|
|
214
|
+
To do so for all stories, update `.storybook/preview.js`:
|
|
217
215
|
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
inlineStories: true,
|
|
221
|
-
},
|
|
222
|
-
});
|
|
216
|
+
```js
|
|
217
|
+
export const parameters = { docs: { inlineStories: false } };
|
|
223
218
|
```
|
|
224
219
|
|
|
225
220
|
## More resources
|
package/angular/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* eslint-disable no-underscore-dangle */
|
|
2
|
-
|
|
2
|
+
import { global } from '@storybook/global';
|
|
3
3
|
|
|
4
4
|
export const setCompodocJson = (compodocJson) => {
|
|
5
5
|
// @ts-expect-error (Converted from ts-ignore)
|
|
6
|
-
|
|
6
|
+
global.__STORYBOOK_COMPODOC_JSON__ = compodocJson;
|
|
7
7
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{DocsRenderer,defaultComponents}from"./chunk-MA2MUXQN.mjs";import"./chunk-
|
|
1
|
+
import{DocsRenderer,defaultComponents}from"./chunk-MA2MUXQN.mjs";import"./chunk-R4NKYYJA.mjs";export{DocsRenderer,defaultComponents};
|
package/dist/blocks.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from '@storybook/blocks';
|
package/dist/blocks.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
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.");
|
package/dist/blocks.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
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.");
|
|
@@ -0,0 +1 @@
|
|
|
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/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
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=__toESM(require("react-dom")),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},DocsRenderer=class{constructor(){this.render=(context,docsParameter,element,callback)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};import("@mdx-js/react").then(({MDXProvider})=>{import_react_dom.default.render(import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{key:Math.random(),context,docsParameter})),element,callback)})},this.unmount=element=>{import_react_dom.default.unmountComponentAtNode(element)}}};0&&(module.exports={DocsRenderer});
|
package/dist/index.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{DocsRenderer}from"./chunk-MA2MUXQN.mjs";import"./chunk-
|
|
1
|
+
import{DocsRenderer}from"./chunk-MA2MUXQN.mjs";import"./chunk-R4NKYYJA.mjs";export*from"@storybook/blocks";export{DocsRenderer};
|
package/dist/preset.js
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
|
-
var
|
|
1
|
+
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};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 preset_exports={};__export(preset_exports,{docs:()=>docsX,storyIndexers:()=>storyIndexersX,webpack:()=>webpackX});module.exports=__toCommonJS(preset_exports);var import_fs_extra=__toESM(require("fs-extra")),import_remark_slug=__toESM(require("remark-slug")),import_remark_external_links=__toESM(require("remark-external-links")),import_ts_dedent=require("ts-dedent"),import_csf_tools=require("@storybook/csf-tools");async function webpack(webpackConfig={},options){let{module:module2={}}=webpackConfig,{csfPluginOptions={},jsxOptions={},transcludeMarkdown=!1,sourceLoaderOptions=null,configureJsx,mdxBabelOptions}=options,mdxLoaderOptions=await options.presets.apply("mdxLoaderOptions",{skipCsf:!0,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",remarkPlugins:[import_remark_slug.default,import_remark_external_links.default]},jsxOptions});if(sourceLoaderOptions)throw new Error(import_ts_dedent.dedent`
|
|
2
2
|
Addon-docs no longer uses source-loader in 7.0.
|
|
3
3
|
|
|
4
4
|
To update your configuration, please see migration instructions here:
|
|
5
5
|
|
|
6
6
|
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
|
|
7
|
-
`);
|
|
7
|
+
`);if(mdxBabelOptions||configureJsx)throw new Error(import_ts_dedent.dedent`
|
|
8
|
+
Addon-docs no longer uses configureJsx or mdxBabelOptions in 7.0.
|
|
9
|
+
|
|
10
|
+
To update your configuration, please see migration instructions here:
|
|
11
|
+
|
|
12
|
+
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-addon-docs-manual-babel-configuration
|
|
13
|
+
`);let mdxLoader=require.resolve("@storybook/mdx2-csf/loader"),rules=module2.rules||[];return transcludeMarkdown&&(rules=[...rules.filter(rule=>{var _a;return((_a=rule.test)==null?void 0:_a.toString())!=="/\\.md$/"}),{test:/\.md$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]),{...webpackConfig,plugins:[...webpackConfig.plugins||[],...csfPluginOptions?[require("@storybook/csf-plugin").webpack(csfPluginOptions)]:[]],module:{...module2,rules:[...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 import_fs_extra.default.readFile(fileName,"utf-8")).toString(),{compile}=await import("@storybook/mdx2-csf");return code=await compile(code,{}),(0,import_csf_tools.loadCsf)(code,{...opts,fileName}).parse()}},...indexers||[]],docs=docsOptions=>({...docsOptions,disable:!1,defaultName:"Docs",autodocs:"tag"}),webpackX=webpack,storyIndexersX=storyIndexers,docsX=docs;0&&(module.exports={docs,storyIndexers,webpack});
|
package/dist/preset.mjs
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
|
-
import{__require}from"./chunk-
|
|
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}from"ts-dedent";import{loadCsf}from"@storybook/csf-tools";async function webpack(webpackConfig={},options){let{module={}}=webpackConfig,{csfPluginOptions={},jsxOptions={},transcludeMarkdown=!1,sourceLoaderOptions=null,configureJsx,mdxBabelOptions}=options,mdxLoaderOptions=await options.presets.apply("mdxLoaderOptions",{skipCsf:!0,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",remarkPlugins:[remarkSlug,remarkExternalLinks]},jsxOptions});if(sourceLoaderOptions)throw new Error(dedent`
|
|
2
2
|
Addon-docs no longer uses source-loader in 7.0.
|
|
3
3
|
|
|
4
4
|
To update your configuration, please see migration instructions here:
|
|
5
5
|
|
|
6
6
|
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
|
|
7
|
-
`);
|
|
7
|
+
`);if(mdxBabelOptions||configureJsx)throw new Error(dedent`
|
|
8
|
+
Addon-docs no longer uses configureJsx or mdxBabelOptions in 7.0.
|
|
9
|
+
|
|
10
|
+
To update your configuration, please see migration instructions here:
|
|
11
|
+
|
|
12
|
+
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-addon-docs-manual-babel-configuration
|
|
13
|
+
`);let mdxLoader=__require.resolve("@storybook/mdx2-csf/loader"),rules=module.rules||[];return transcludeMarkdown&&(rules=[...rules.filter(rule=>rule.test?.toString()!=="/\\.md$/"),{test:/\.md$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]),{...webpackConfig,plugins:[...webpackConfig.plugins||[],...csfPluginOptions?[__require("@storybook/csf-plugin").webpack(csfPluginOptions)]:[]],module:{...module,rules:[...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}=await import("@storybook/mdx2-csf");return code=await compile(code,{}),loadCsf(code,{...opts,fileName}).parse()}},...indexers||[]],docs=docsOptions=>({...docsOptions,disable:!1,defaultName:"Docs",autodocs:"tag"}),webpackX=webpack,storyIndexersX=storyIndexers,docsX=docs;export{docsX as docs,storyIndexersX as storyIndexers,webpackX as webpack};
|
package/dist/preview.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
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,import_blocks,defaultComponents,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){import_react=__toESM(require("react")),import_react_dom=__toESM(require("react-dom")),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},DocsRenderer=class{constructor(){this.render=(context,docsParameter,element,callback)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};import("@mdx-js/react").then(({MDXProvider})=>{import_react_dom.default.render(import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{key:Math.random(),context,docsParameter})),element,callback)})},this.unmount=element=>{import_react_dom.default.unmountComponentAtNode(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 @@
|
|
|
1
|
-
import"./chunk-
|
|
1
|
+
import"./chunk-R4NKYYJA.mjs";var parameters={docs:{renderer:async()=>{let{DocsRenderer}=await import("./DocsRenderer-QMFTTPNP.mjs");return new DocsRenderer}}};export{parameters};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
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);
|
package/ember/README.md
CHANGED
|
@@ -125,9 +125,7 @@ Storybook Docs renders all Ember stories inside `iframe`s, with a default height
|
|
|
125
125
|
To update the global default, modify `.storybook/preview.js`:
|
|
126
126
|
|
|
127
127
|
```ts
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
addParameters({ docs: { iframeHeight: 400 } });
|
|
128
|
+
export const parameters = { docs: { iframeHeight: 400 } };
|
|
131
129
|
```
|
|
132
130
|
|
|
133
131
|
For `DocsPage`, you need to update the parameter locally in a story:
|
package/ember/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-docs",
|
|
3
|
-
"version": "7.0.0-beta.
|
|
3
|
+
"version": "7.0.0-beta.21",
|
|
4
4
|
"description": "Document component usage and properties in Markdown",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"addon",
|
|
@@ -41,6 +41,11 @@
|
|
|
41
41
|
"import": "./dist/preset.mjs",
|
|
42
42
|
"types": "./dist/preset.d.ts"
|
|
43
43
|
},
|
|
44
|
+
"./blocks": {
|
|
45
|
+
"require": "./dist/blocks.js",
|
|
46
|
+
"import": "./dist/blocks.mjs",
|
|
47
|
+
"types": "./dist/blocks.d.ts"
|
|
48
|
+
},
|
|
44
49
|
"./dist/preview": {
|
|
45
50
|
"require": "./dist/preview.js",
|
|
46
51
|
"import": "./dist/preview.mjs",
|
|
@@ -87,8 +92,7 @@
|
|
|
87
92
|
"lit/**/*",
|
|
88
93
|
"README.md",
|
|
89
94
|
"*.js",
|
|
90
|
-
"*.d.ts"
|
|
91
|
-
"!__testfixtures__"
|
|
95
|
+
"*.d.ts"
|
|
92
96
|
],
|
|
93
97
|
"scripts": {
|
|
94
98
|
"check": "../../../scripts/node_modules/.bin/tsc --noEmit",
|
|
@@ -99,18 +103,19 @@
|
|
|
99
103
|
"@babel/plugin-transform-react-jsx": "^7.19.0",
|
|
100
104
|
"@jest/transform": "^29.3.1",
|
|
101
105
|
"@mdx-js/react": "^2.1.5",
|
|
102
|
-
"@storybook/blocks": "7.0.0-beta.
|
|
103
|
-
"@storybook/
|
|
104
|
-
"@storybook/
|
|
105
|
-
"@storybook/csf-
|
|
106
|
+
"@storybook/blocks": "7.0.0-beta.21",
|
|
107
|
+
"@storybook/client-logger": "7.0.0-beta.21",
|
|
108
|
+
"@storybook/components": "7.0.0-beta.21",
|
|
109
|
+
"@storybook/csf-plugin": "7.0.0-beta.21",
|
|
110
|
+
"@storybook/csf-tools": "7.0.0-beta.21",
|
|
111
|
+
"@storybook/global": "^5.0.0",
|
|
106
112
|
"@storybook/mdx2-csf": "next",
|
|
107
|
-
"@storybook/node-logger": "7.0.0-beta.
|
|
108
|
-
"@storybook/postinstall": "7.0.0-beta.
|
|
109
|
-
"@storybook/preview-api": "7.0.0-beta.
|
|
110
|
-
"@storybook/theming": "7.0.0-beta.
|
|
111
|
-
"@storybook/types": "7.0.0-beta.
|
|
113
|
+
"@storybook/node-logger": "7.0.0-beta.21",
|
|
114
|
+
"@storybook/postinstall": "7.0.0-beta.21",
|
|
115
|
+
"@storybook/preview-api": "7.0.0-beta.21",
|
|
116
|
+
"@storybook/theming": "7.0.0-beta.21",
|
|
117
|
+
"@storybook/types": "7.0.0-beta.21",
|
|
112
118
|
"fs-extra": "^9.0.1",
|
|
113
|
-
"global": "^4.4.0",
|
|
114
119
|
"remark-external-links": "^8.0.0",
|
|
115
120
|
"remark-slug": "^6.0.0",
|
|
116
121
|
"ts-dedent": "^2.0.0"
|
|
@@ -132,10 +137,11 @@
|
|
|
132
137
|
"./src/index.ts",
|
|
133
138
|
"./src/preset.ts",
|
|
134
139
|
"./src/preview.ts",
|
|
140
|
+
"./src/blocks.ts",
|
|
135
141
|
"./src/shims/mdx-react-shim.ts"
|
|
136
142
|
]
|
|
137
143
|
},
|
|
138
|
-
"gitHead": "
|
|
144
|
+
"gitHead": "fb45d854842e10fa119a65c628333e3a5d495e77",
|
|
139
145
|
"storybook": {
|
|
140
146
|
"displayName": "Docs",
|
|
141
147
|
"icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
|
package/postinstall/presets.js
CHANGED
|
@@ -24,9 +24,7 @@ export default function transformer(file, api) {
|
|
|
24
24
|
((dependencies && dependencies['react-scripts']) ||
|
|
25
25
|
(devDependencies && devDependencies['react-scripts']))
|
|
26
26
|
) {
|
|
27
|
-
presetOptions = {
|
|
28
|
-
configureJSX: true,
|
|
29
|
-
};
|
|
27
|
+
presetOptions = {};
|
|
30
28
|
}
|
|
31
29
|
|
|
32
30
|
const j = api.jscodeshift;
|
package/react/README.md
CHANGED
|
@@ -98,14 +98,14 @@ Some **markdown** description, or whatever you want.
|
|
|
98
98
|
|
|
99
99
|
## Inline stories
|
|
100
100
|
|
|
101
|
-
Storybook Docs renders all React stories inline
|
|
101
|
+
Storybook Docs renders all React stories inline by default.
|
|
102
|
+
|
|
103
|
+
However, you can render stories in an iframe, with a default height of `60px` (configurable using the `docs.iframeHeight` story parameter), by using the `docs.inlineStories` parameter.
|
|
104
|
+
|
|
105
|
+
To do so for all stories, update `.storybook/preview.js`:
|
|
102
106
|
|
|
103
107
|
```js
|
|
104
|
-
export const parameters = {
|
|
105
|
-
docs: {
|
|
106
|
-
inlineStories: false,
|
|
107
|
-
},
|
|
108
|
-
};
|
|
108
|
+
export const parameters = { docs: { inlineStories: false } };
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
## TypeScript props with `react-docgen`
|
package/vue/README.md
CHANGED
|
@@ -133,18 +133,14 @@ Yes, it's redundant to declare `component` twice. [Coming soon](https://github.c
|
|
|
133
133
|
|
|
134
134
|
## Inline Stories
|
|
135
135
|
|
|
136
|
-
Storybook Docs renders all Vue stories
|
|
136
|
+
Storybook Docs renders all Vue stories inline by default.
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
However, you can render stories in an iframe, with a default height of `60px` (configurable using the `docs.iframeHeight` story parameter), by using the `docs.inlineStories` parameter.
|
|
139
139
|
|
|
140
|
-
|
|
141
|
-
import { addParameters } from '@storybook/vue';
|
|
140
|
+
To do so for all stories, update `.storybook/preview.js`:
|
|
142
141
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
inlineStories: true,
|
|
146
|
-
},
|
|
147
|
-
});
|
|
142
|
+
```js
|
|
143
|
+
export const parameters = { docs: { inlineStories: false } };
|
|
148
144
|
```
|
|
149
145
|
|
|
150
146
|
## More resources
|
package/web-components/README.md
CHANGED
|
@@ -112,24 +112,14 @@ For a full example see the [web-components-kitchen-sink/custom-elements.json](..
|
|
|
112
112
|
|
|
113
113
|
## Stories not inline
|
|
114
114
|
|
|
115
|
-
|
|
116
|
-
For web components that is usually fine as they are style encapsulated via shadow dom.
|
|
117
|
-
However when you have a style tag in you template it might be best to show them in an iframe.
|
|
115
|
+
Storybook Docs renders all web components stories inline by default.
|
|
118
116
|
|
|
119
|
-
|
|
117
|
+
However, you can render stories in an iframe, with a default height of `60px` (configurable using the `docs.iframeHeight` story parameter), by using the `docs.inlineStories` parameter.
|
|
120
118
|
|
|
121
|
-
|
|
122
|
-
addParameters({
|
|
123
|
-
docs: {
|
|
124
|
-
inlineStories: false,
|
|
125
|
-
},
|
|
126
|
-
});
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
or add it to individual stories.
|
|
119
|
+
To do so for all stories, update `.storybook/preview.js`:
|
|
130
120
|
|
|
131
121
|
```js
|
|
132
|
-
|
|
122
|
+
export const parameters = { docs: { inlineStories: false } };
|
|
133
123
|
```
|
|
134
124
|
|
|
135
125
|
## More resources
|
package/dist/chunk-HXSBEJGO.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
var __require=(x=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(x,{get:(a,b)=>(typeof require!="undefined"?require:a)[b]}):x)(function(x){if(typeof require!="undefined")return require.apply(this,arguments);throw new Error('Dynamic require of "'+x+'" is not supported')});export{__require};
|