@storybook/addon-essentials 9.0.0-alpha.0 → 9.0.0-alpha.10

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 CHANGED
@@ -8,12 +8,7 @@ Each addon is documented and maintained by the core team and will be upgraded al
8
8
 
9
9
  Storybook essentials includes the following addons. Addons can be disabled and re-configured as [described below](#configuration):
10
10
 
11
- - [Actions](https://github.com/storybookjs/storybook/tree/next/code/addons/actions)
12
11
  - [Backgrounds](https://github.com/storybookjs/storybook/tree/next/code/addons/backgrounds)
13
- - [Controls](https://github.com/storybookjs/storybook/tree/next/code/addons/controls)
14
- - [Docs](https://github.com/storybookjs/storybook/tree/next/code/addons/docs)
15
- - [Viewport](https://github.com/storybookjs/storybook/tree/next/code/addons/viewport)
16
- - [Toolbars](https://github.com/storybookjs/storybook/tree/next/code/addons/toolbars)
17
12
  - [Measure](https://github.com/storybookjs/storybook/tree/next/code/addons/measure)
18
13
  - [Outline](https://github.com/storybookjs/storybook/tree/next/code/addons/outline)
19
14
 
@@ -25,7 +20,7 @@ You can add Essentials to your project with:
25
20
  npm install --save-dev @storybook/addon-essentials
26
21
  ```
27
22
 
28
- And then add the following line to your `.storybook/main.js`:
23
+ And then add the following line to your `.storybook/main.ts`:
29
24
 
30
25
  ```js
31
26
  export default {
@@ -37,11 +32,11 @@ export default {
37
32
 
38
33
  Essentials is "zero config." That means that comes with a recommended configuration out of the box.
39
34
 
40
- If you want to reconfigure an addon, simply install that addon per that addon's installation instructions and configure it as normal. Essentials scans your project's `main.js` on startup and if detects one of its addons is already configured in the `addons` field, it will skip that addon's configuration entirely.
35
+ If you want to reconfigure an addon, simply install that addon per that addon's installation instructions and configure it as normal. Essentials scans your project's `main.ts` on startup and if detects one of its addons is already configured in the `addons` field, it will skip that addon's configuration entirely.
41
36
 
42
37
  ## Disabling addons
43
38
 
44
- You can disable any of Essential's addons using the following configuration scheme in `.storybook/main.js`:
39
+ You can disable any of Essential's addons using the following configuration scheme in `.storybook/main.ts`:
45
40
 
46
41
  ```js
47
42
  export default {
@@ -54,4 +49,6 @@ export default {
54
49
  };
55
50
  ```
56
51
 
57
- Valid addon keys include: `actions`, `backgrounds`, `controls`, `docs`, `viewport`, `toolbars`.
52
+ Valid addon keys include: `backgrounds`, `measure`, `outline`.
53
+
54
+ Note: The `docs` addon was previously part of essentials but is now a separate package. If you need documentation features, please install `@storybook/addon-docs` separately; see [MIGRATION.md](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#docs-addon-moved-out-of-addon-essentials)
@@ -1 +1,4 @@
1
1
  export * from '@storybook/addon-backgrounds/preview';
2
+ import '@storybook/addon-highlight/preview';
3
+ import '@storybook/addon-measure/preview';
4
+ import '@storybook/addon-outline/preview';
package/dist/index.js CHANGED
@@ -1,42 +1,18 @@
1
1
  'use strict';
2
2
 
3
- var previewApi = require('storybook/internal/preview-api');
4
- var actionsAddon = require('@storybook/addon-actions');
3
+ var previewApi = require('storybook/preview-api');
5
4
  var backgroundsAddon = require('@storybook/addon-backgrounds');
6
- var docsAddon = require('@storybook/addon-docs/preview');
7
5
  var highlightAddon = require('@storybook/addon-highlight');
8
6
  var measureAddon = require('@storybook/addon-measure');
9
7
  var outlineAddon = require('@storybook/addon-outline');
10
- var viewportAddon = require('@storybook/addon-viewport');
11
8
 
12
9
  function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
13
10
 
14
- function _interopNamespace(e) {
15
- if (e && e.__esModule) return e;
16
- var n = Object.create(null);
17
- if (e) {
18
- Object.keys(e).forEach(function (k) {
19
- if (k !== 'default') {
20
- var d = Object.getOwnPropertyDescriptor(e, k);
21
- Object.defineProperty(n, k, d.get ? d : {
22
- enumerable: true,
23
- get: function () { return e[k]; }
24
- });
25
- }
26
- });
27
- }
28
- n.default = e;
29
- return Object.freeze(n);
30
- }
31
-
32
- var actionsAddon__default = /*#__PURE__*/_interopDefault(actionsAddon);
33
11
  var backgroundsAddon__default = /*#__PURE__*/_interopDefault(backgroundsAddon);
34
- var docsAddon__namespace = /*#__PURE__*/_interopNamespace(docsAddon);
35
12
  var highlightAddon__default = /*#__PURE__*/_interopDefault(highlightAddon);
36
13
  var measureAddon__default = /*#__PURE__*/_interopDefault(measureAddon);
37
14
  var outlineAddon__default = /*#__PURE__*/_interopDefault(outlineAddon);
38
- var viewportAddon__default = /*#__PURE__*/_interopDefault(viewportAddon);
39
15
 
40
- var preview_default=previewApi.composeConfigs([actionsAddon__default.default(),docsAddon__namespace,backgroundsAddon__default.default(),viewportAddon__default.default(),measureAddon__default.default(),outlineAddon__default.default(),highlightAddon__default.default()]);var index_default=()=>previewApi.definePreview(preview_default);
16
+ var preview_default=previewApi.composeConfigs([backgroundsAddon__default.default(),measureAddon__default.default(),outlineAddon__default.default(),highlightAddon__default.default()]);var index_default=()=>previewApi.definePreview(preview_default);
41
17
 
42
18
  module.exports = index_default;
package/dist/index.mjs CHANGED
@@ -1,12 +1,9 @@
1
- import { composeConfigs, definePreview } from 'storybook/internal/preview-api';
2
- import actionsAddon from '@storybook/addon-actions';
1
+ import { composeConfigs, definePreview } from 'storybook/preview-api';
3
2
  import backgroundsAddon from '@storybook/addon-backgrounds';
4
- import * as docsAddon from '@storybook/addon-docs/preview';
5
3
  import highlightAddon from '@storybook/addon-highlight';
6
4
  import measureAddon from '@storybook/addon-measure';
7
5
  import outlineAddon from '@storybook/addon-outline';
8
- import viewportAddon from '@storybook/addon-viewport';
9
6
 
10
- var preview_default=composeConfigs([actionsAddon(),docsAddon,backgroundsAddon(),viewportAddon(),measureAddon(),outlineAddon(),highlightAddon()]);var index_default=()=>definePreview(preview_default);
7
+ var preview_default=composeConfigs([backgroundsAddon(),measureAddon(),outlineAddon(),highlightAddon()]);var index_default=()=>definePreview(preview_default);
11
8
 
12
9
  export { index_default as default };
package/dist/preset.js CHANGED
@@ -4,6 +4,6 @@ var path = require('path');
4
4
  var common = require('storybook/internal/common');
5
5
  var nodeLogger = require('storybook/internal/node-logger');
6
6
 
7
- var requireMain=configDir=>{let absoluteConfigDir=path.isAbsolute(configDir)?configDir:path.join(process.cwd(),configDir),mainFile=path.join(absoluteConfigDir,"main");return common.serverRequire(mainFile)??{}};function addons(options){let checkInstalled=(addonName,main2)=>{let addon=`@storybook/addon-${addonName}`,existingAddon=main2.addons?.find(entry=>(typeof entry=="string"?entry:entry.name)?.startsWith(addon));return existingAddon&&nodeLogger.logger.info(`Found existing addon ${JSON.stringify(existingAddon)}, skipping.`),!!existingAddon},main=requireMain(options.configDir);return ["controls","actions","docs","backgrounds","viewport","toolbars","measure","outline","highlight"].filter(key=>options[key]!==!1).filter(addon=>!checkInstalled(addon,main)).map(addon=>`@storybook/addon-essentials/${addon}`)}
7
+ var requireMain=configDir=>{let absoluteConfigDir=path.isAbsolute(configDir)?configDir:path.join(process.cwd(),configDir),mainFile=path.join(absoluteConfigDir,"main");return common.serverRequire(mainFile)??{}};function addons(options){let checkInstalled=(addonName,main2)=>{let addon=`@storybook/addon-${addonName}`,existingAddon=main2.addons?.find(entry=>(typeof entry=="string"?entry:entry.name)?.startsWith(addon));return existingAddon&&nodeLogger.logger.info(`Found existing addon ${JSON.stringify(existingAddon)}, skipping.`),!!existingAddon},main=requireMain(options.configDir);return ["backgrounds","measure","outline","highlight"].filter(key=>options[key]!==!1).filter(addon=>!checkInstalled(addon,main)).map(addon=>`@storybook/addon-essentials/${addon}`)}
8
8
 
9
9
  exports.addons = addons;
package/dist/preview.js CHANGED
@@ -1,42 +1,18 @@
1
1
  'use strict';
2
2
 
3
- var previewApi = require('storybook/internal/preview-api');
4
- var actionsAddon = require('@storybook/addon-actions');
5
3
  var backgroundsAddon = require('@storybook/addon-backgrounds');
6
- var docsAddon = require('@storybook/addon-docs/preview');
7
4
  var highlightAddon = require('@storybook/addon-highlight');
8
5
  var measureAddon = require('@storybook/addon-measure');
9
6
  var outlineAddon = require('@storybook/addon-outline');
10
- var viewportAddon = require('@storybook/addon-viewport');
7
+ var previewApi = require('storybook/preview-api');
11
8
 
12
9
  function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
13
10
 
14
- function _interopNamespace(e) {
15
- if (e && e.__esModule) return e;
16
- var n = Object.create(null);
17
- if (e) {
18
- Object.keys(e).forEach(function (k) {
19
- if (k !== 'default') {
20
- var d = Object.getOwnPropertyDescriptor(e, k);
21
- Object.defineProperty(n, k, d.get ? d : {
22
- enumerable: true,
23
- get: function () { return e[k]; }
24
- });
25
- }
26
- });
27
- }
28
- n.default = e;
29
- return Object.freeze(n);
30
- }
31
-
32
- var actionsAddon__default = /*#__PURE__*/_interopDefault(actionsAddon);
33
11
  var backgroundsAddon__default = /*#__PURE__*/_interopDefault(backgroundsAddon);
34
- var docsAddon__namespace = /*#__PURE__*/_interopNamespace(docsAddon);
35
12
  var highlightAddon__default = /*#__PURE__*/_interopDefault(highlightAddon);
36
13
  var measureAddon__default = /*#__PURE__*/_interopDefault(measureAddon);
37
14
  var outlineAddon__default = /*#__PURE__*/_interopDefault(outlineAddon);
38
- var viewportAddon__default = /*#__PURE__*/_interopDefault(viewportAddon);
39
15
 
40
- var preview_default=previewApi.composeConfigs([actionsAddon__default.default(),docsAddon__namespace,backgroundsAddon__default.default(),viewportAddon__default.default(),measureAddon__default.default(),outlineAddon__default.default(),highlightAddon__default.default()]);
16
+ var preview_default=previewApi.composeConfigs([backgroundsAddon__default.default(),measureAddon__default.default(),outlineAddon__default.default(),highlightAddon__default.default()]);
41
17
 
42
18
  module.exports = preview_default;
package/dist/preview.mjs CHANGED
@@ -1,12 +1,9 @@
1
- import { composeConfigs } from 'storybook/internal/preview-api';
2
- import actionsAddon from '@storybook/addon-actions';
3
1
  import backgroundsAddon from '@storybook/addon-backgrounds';
4
- import * as docsAddon from '@storybook/addon-docs/preview';
5
2
  import highlightAddon from '@storybook/addon-highlight';
6
3
  import measureAddon from '@storybook/addon-measure';
7
4
  import outlineAddon from '@storybook/addon-outline';
8
- import viewportAddon from '@storybook/addon-viewport';
5
+ import { composeConfigs } from 'storybook/preview-api';
9
6
 
10
- var preview_default=composeConfigs([actionsAddon(),docsAddon,backgroundsAddon(),viewportAddon(),measureAddon(),outlineAddon(),highlightAddon()]);
7
+ var preview_default=composeConfigs([backgroundsAddon(),measureAddon(),outlineAddon(),highlightAddon()]);
11
8
 
12
9
  export { preview_default as default };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/addon-essentials",
3
- "version": "9.0.0-alpha.0",
3
+ "version": "9.0.0-alpha.10",
4
4
  "description": "Curated addons to bring out the best of Storybook",
5
5
  "keywords": [
6
6
  "addon",
@@ -32,27 +32,12 @@
32
32
  "import": "./dist/preview.mjs",
33
33
  "require": "./dist/preview.js"
34
34
  },
35
- "./actions/preview": {
36
- "types": "./dist/actions/preview.d.ts",
37
- "import": "./dist/actions/preview.mjs",
38
- "require": "./dist/actions/preview.js"
39
- },
40
- "./actions/manager": "./dist/actions/manager.js",
41
35
  "./backgrounds/preview": {
42
36
  "types": "./dist/backgrounds/preview.d.ts",
43
37
  "import": "./dist/backgrounds/preview.mjs",
44
38
  "require": "./dist/backgrounds/preview.js"
45
39
  },
46
40
  "./backgrounds/manager": "./dist/backgrounds/manager.js",
47
- "./controls/manager": "./dist/controls/manager.js",
48
- "./docs/manager": "./dist/docs/manager.js",
49
- "./docs/preview": {
50
- "types": "./dist/docs/preview.d.ts",
51
- "import": "./dist/docs/preview.mjs",
52
- "require": "./dist/docs/preview.js"
53
- },
54
- "./docs/preset": "./dist/docs/preset.js",
55
- "./docs/mdx-react-shim": "./dist/docs/mdx-react-shim.js",
56
41
  "./highlight/preview": {
57
42
  "types": "./dist/highlight/preview.d.ts",
58
43
  "import": "./dist/highlight/preview.mjs",
@@ -70,13 +55,6 @@
70
55
  "require": "./dist/outline/preview.js"
71
56
  },
72
57
  "./outline/manager": "./dist/outline/manager.js",
73
- "./toolbars/manager": "./dist/toolbars/manager.js",
74
- "./viewport/manager": "./dist/viewport/manager.js",
75
- "./viewport/preview": {
76
- "types": "./dist/viewport/preview.d.ts",
77
- "import": "./dist/viewport/preview.mjs",
78
- "require": "./dist/viewport/preview.js"
79
- },
80
58
  "./preset": "./dist/preset.js",
81
59
  "./package.json": "./package.json"
82
60
  },
@@ -105,57 +83,40 @@
105
83
  "prep": "jiti ../../../scripts/prepare/addon-bundle.ts"
106
84
  },
107
85
  "dependencies": {
108
- "@storybook/addon-actions": "9.0.0-alpha.0",
109
- "@storybook/addon-backgrounds": "9.0.0-alpha.0",
110
- "@storybook/addon-controls": "9.0.0-alpha.0",
111
- "@storybook/addon-docs": "9.0.0-alpha.0",
112
- "@storybook/addon-highlight": "9.0.0-alpha.0",
113
- "@storybook/addon-measure": "9.0.0-alpha.0",
114
- "@storybook/addon-outline": "9.0.0-alpha.0",
115
- "@storybook/addon-toolbars": "9.0.0-alpha.0",
116
- "@storybook/addon-viewport": "9.0.0-alpha.0",
86
+ "@storybook/addon-backgrounds": "9.0.0-alpha.10",
87
+ "@storybook/addon-highlight": "9.0.0-alpha.10",
88
+ "@storybook/addon-measure": "9.0.0-alpha.10",
89
+ "@storybook/addon-outline": "9.0.0-alpha.10",
117
90
  "ts-dedent": "^2.0.0"
118
91
  },
119
92
  "devDependencies": {
120
93
  "typescript": "^5.7.3"
121
94
  },
122
95
  "peerDependencies": {
123
- "storybook": "^9.0.0-alpha.0"
96
+ "storybook": "^9.0.0-alpha.10"
124
97
  },
125
98
  "publishConfig": {
126
99
  "access": "public"
127
100
  },
128
101
  "bundler": {
129
102
  "nodeEntries": [
130
- "./src/preset.ts",
131
- "./src/docs/preset.ts",
132
- "./src/docs/mdx-react-shim.ts"
103
+ "./src/preset.ts"
133
104
  ],
134
105
  "exportEntries": [
135
106
  "./src/index.ts"
136
107
  ],
137
- "entries": [
138
- "./src/docs/manager.ts"
139
- ],
108
+ "entries": [],
140
109
  "managerEntries": [
141
- "./src/actions/manager.ts",
142
110
  "./src/backgrounds/manager.ts",
143
- "./src/controls/manager.ts",
144
- "./src/docs/manager.ts",
145
111
  "./src/measure/manager.ts",
146
- "./src/outline/manager.ts",
147
- "./src/toolbars/manager.ts",
148
- "./src/viewport/manager.ts"
112
+ "./src/outline/manager.ts"
149
113
  ],
150
114
  "previewEntries": [
151
115
  "./src/preview.ts",
152
- "./src/actions/preview.ts",
153
116
  "./src/backgrounds/preview.ts",
154
- "./src/docs/preview.ts",
155
117
  "./src/highlight/preview.ts",
156
118
  "./src/measure/preview.ts",
157
- "./src/outline/preview.ts",
158
- "./src/viewport/preview.ts"
119
+ "./src/outline/preview.ts"
159
120
  ]
160
121
  },
161
122
  "gitHead": "e6a7fd8a655c69780bc20b9749c2699e44beae16"
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-actions/manager';
@@ -1,7 +0,0 @@
1
- export * from '@storybook/addon-actions/preview';
2
- import '@storybook/addon-backgrounds/preview';
3
- import '@storybook/addon-docs/dist/preview';
4
- import '@storybook/addon-highlight/preview';
5
- import '@storybook/addon-measure/preview';
6
- import '@storybook/addon-outline/preview';
7
- import '@storybook/addon-viewport/preview';
@@ -1,12 +0,0 @@
1
- 'use strict';
2
-
3
- var preview = require('@storybook/addon-actions/preview');
4
-
5
-
6
-
7
- Object.keys(preview).forEach(function (k) {
8
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
- enumerable: true,
10
- get: function () { return preview[k]; }
11
- });
12
- });
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-actions/preview';
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-controls/manager';
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-docs/manager';
@@ -1,12 +0,0 @@
1
- 'use strict';
2
-
3
- var mdxReactShim = require('@storybook/addon-docs/dist/shims/mdx-react-shim');
4
-
5
-
6
-
7
- Object.keys(mdxReactShim).forEach(function (k) {
8
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
- enumerable: true,
10
- get: function () { return mdxReactShim[k]; }
11
- });
12
- });
@@ -1,14 +0,0 @@
1
- 'use strict';
2
-
3
- var path = require('path');
4
- var preset = require('@storybook/addon-docs/dist/preset');
5
-
6
- 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 Error('Dynamic require of "'+x+'" is not supported')});var mdxLoaderOptions=async config=>(config.mdxCompileOptions.providerImportSource=path.join(path.dirname(__require.resolve("@storybook/addon-docs/package.json")),"/dist/shims/mdx-react-shim.mjs"),config);
7
-
8
- exports.mdxLoaderOptions = mdxLoaderOptions;
9
- Object.keys(preset).forEach(function (k) {
10
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
11
- enumerable: true,
12
- get: function () { return preset[k]; }
13
- });
14
- });
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-docs/dist/preview';
@@ -1,12 +0,0 @@
1
- 'use strict';
2
-
3
- var preview = require('@storybook/addon-docs/dist/preview');
4
-
5
-
6
-
7
- Object.keys(preview).forEach(function (k) {
8
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
- enumerable: true,
10
- get: function () { return preview[k]; }
11
- });
12
- });
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-docs/dist/preview';
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-toolbars/manager';
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-viewport/manager';
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-viewport/preview';
@@ -1,12 +0,0 @@
1
- 'use strict';
2
-
3
- var preview = require('@storybook/addon-viewport/preview');
4
-
5
-
6
-
7
- Object.keys(preview).forEach(function (k) {
8
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
- enumerable: true,
10
- get: function () { return preview[k]; }
11
- });
12
- });
@@ -1 +0,0 @@
1
- export * from '@storybook/addon-viewport/preview';