Merge branch 'next' into chore_add_api_section_snippets

storybookjs · Aug 11, 2020 · fe3b3e0 · fe3b3e0
2 parents 2581f63 + 7a34522
commit fe3b3e0
Show file tree

Hide file tree

Showing 112 changed files with 551 additions and 513 deletions.
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -728,7 +728,7 @@ addons.setConfig({
 
 The `addParameters` and `addDecorator` APIs to add global decorators and parameters, exported by the various frameworks (e.g. `@storybook/react`) and `@storybook/client` are now deprecated.
 
-Instead, use `export const parameters = {};` and `export const decorators = [];` in your `.storybook/preview.js`. Addon authors similarly should use such an export in a `previewEntry` file.
+Instead, use `export const parameters = {};` and `export const decorators = [];` in your `.storybook/preview.js`. Addon authors similarly should use such an export in a preview entry file (see [Preview entries](https://github.com/storybookjs/storybook/blob/next/docs/api/writing-presets.md#preview-entries)).
 
 #### Deprecated clearDecorators
 

diff --git a/addons/a11y/package.json b/addons/a11y/package.json
@@ -63,7 +63,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/actions/package.json b/addons/actions/package.json
@@ -58,7 +58,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/backgrounds/package.json b/addons/backgrounds/package.json
@@ -52,7 +52,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/controls/package.json b/addons/controls/package.json
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/addons/cssresources/package.json b/addons/cssresources/package.json
@@ -55,7 +55,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/design-assets/package.json b/addons/design-assets/package.json
@@ -53,7 +53,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/docs/package.json b/addons/docs/package.json
@@ -144,7 +144,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/essentials/package.json b/addons/essentials/package.json
@@ -53,7 +53,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/events/package.json b/addons/events/package.json
@@ -55,7 +55,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/google-analytics/package.json b/addons/google-analytics/package.json
@@ -35,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/addons/graphql/package.json b/addons/graphql/package.json
@@ -50,7 +50,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/jest/package.json b/addons/jest/package.json
@@ -57,7 +57,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/knobs/package.json b/addons/knobs/package.json
@@ -65,7 +65,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/links/package.json b/addons/links/package.json
@@ -53,7 +53,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/queryparams/package.json b/addons/queryparams/package.json
@@ -52,7 +52,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/storyshots/storyshots-core/package.json b/addons/storyshots/storyshots-core/package.json
@@ -64,7 +64,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/storyshots/storyshots-puppeteer/package.json b/addons/storyshots/storyshots-puppeteer/package.json
@@ -53,7 +53,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/addons/storysource/package.json b/addons/storysource/package.json
@@ -57,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/addons/toolbars/package.json b/addons/toolbars/package.json
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/addons/viewport/package.json b/addons/viewport/package.json
@@ -48,7 +48,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/angular/package.json b/app/angular/package.json
@@ -75,7 +75,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/aurelia/package.json b/app/aurelia/package.json
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/ember/package.json b/app/ember/package.json
@@ -52,5 +52,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/html/package.json b/app/html/package.json
@@ -54,7 +54,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/marionette/package.json b/app/marionette/package.json
@@ -49,5 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/marko/package.json b/app/marko/package.json
@@ -54,5 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/mithril/package.json b/app/mithril/package.json
@@ -60,7 +60,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/preact/package.json b/app/preact/package.json
@@ -58,7 +58,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/rax/package.json b/app/rax/package.json
@@ -54,5 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/react/package.json b/app/react/package.json
@@ -71,7 +71,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/riot/package.json b/app/riot/package.json
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/server/package.json b/app/server/package.json
@@ -54,5 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b"
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b"
 }
diff --git a/app/svelte/package.json b/app/svelte/package.json
@@ -59,7 +59,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/vue/package.json b/app/vue/package.json
@@ -70,7 +70,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/app/web-components/package.json b/app/web-components/package.json
@@ -63,7 +63,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/dev-kits/addon-decorator/package.json b/dev-kits/addon-decorator/package.json
@@ -32,7 +32,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/dev-kits/addon-parameter/package.json b/dev-kits/addon-parameter/package.json
@@ -38,7 +38,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/dev-kits/addon-preview-wrapper/package.json b/dev-kits/addon-preview-wrapper/package.json
@@ -30,7 +30,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/dev-kits/addon-roundtrip/package.json b/dev-kits/addon-roundtrip/package.json
@@ -39,7 +39,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d31e743fc15970ad5722abf4678e03be82bf8b8b",
+  "gitHead": "46bf85714342208cf612aee130f8876ce56ba46b",
   "typesVersions": {
     "<=3.5": {
       "*": [

diff --git a/docs/api/writing-presets.md b/docs/api/writing-presets.md
@@ -2,7 +2,6 @@
 title: 'Writing your own Storybook Preset'
 ---
 
-
 [Storybook presets](./presets.md) are grouped collections of `babel`, `webpack`, and `addons` configurations that support specific use cases in Storybook, such as typescript or MDX support.
 
 This doc covers the [presets API](#presets-api) and how to use the presets mechanism for [advanced configuration](#advanced-configuration).
@@ -95,6 +94,35 @@ This is equivalent to [registering the addon manually](../get-started/browse-sto
 
 <!-- prettier-ignore-end -->
 
+### Preview entries
+
+The addon config `config` allows you to add extra preview configuration from within a preset, for example to add parameters or decorators from an addon.
+
+For example, the Backgrounds preset contains the following code:
+
+```js
+// preset.js
+export function config(entry = []) {
+  return [...entry, require.resolve('./defaultParameters')];
+}
+```
+
+Which in turn invokes:
+
+```js
+// defaultParameters.js
+export const parameters = {
+  backgrounds: {
+    values: [
+      { name: 'light', value: '#F8F8F8' },
+      { name: 'dark', value: '#333333' },
+    ],
+  },
+};
+```
+
+This is equivalent to exporting the `backgrounds` parameter manually in `main.js`.
+
 ### Addons
 
 For users, the name `managerEntries` might be a bit too technical, so instead both users and preset-authors can simply use the property: `addons`:
@@ -175,4 +203,5 @@ and extract the configuration to a new file `./storybook/my-preset.js`:
 
 <!-- prettier-ignore-end -->
 
-Place your `my-preset.js` file wherever you want, if you want to share it far and wide you'll want to make it its own package.
+
+Place your `my-preset.js` file wherever you want, if you want to share it far and wide you'll want to make it its own package.