@storybook/addon-onboarding 9.2.0-alpha.3 → 10.0.0-beta.1
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 +2 -0
- package/dist/_browser-chunks/Onboarding-LYWP3ZXX.js +8278 -0
- package/dist/_browser-chunks/chunk-B266DSPW.js +8 -0
- package/dist/_browser-chunks/chunk-CBI7MY27.js +32 -0
- package/dist/index.js +6 -4
- package/dist/manager.js +36 -6
- package/dist/preset.js +38 -5
- package/manager.js +1 -0
- package/package.json +20 -25
- package/preset.js +1 -8
- package/dist/Onboarding-64RGZKLB.js +0 -137
- package/dist/index.mjs +0 -3
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
var __create = Object.create;
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
6
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
7
|
+
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
8
|
+
var __commonJS = (cb, mod) => function __require() {
|
|
9
|
+
return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
|
|
10
|
+
};
|
|
11
|
+
var __copyProps = (to, from, except, desc) => {
|
|
12
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
13
|
+
for (let key of __getOwnPropNames(from))
|
|
14
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
15
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
16
|
+
}
|
|
17
|
+
return to;
|
|
18
|
+
};
|
|
19
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
20
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
21
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
22
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
23
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
24
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
25
|
+
mod
|
|
26
|
+
));
|
|
27
|
+
|
|
28
|
+
export {
|
|
29
|
+
__name,
|
|
30
|
+
__commonJS,
|
|
31
|
+
__toESM
|
|
32
|
+
};
|
package/dist/index.js
CHANGED
package/dist/manager.js
CHANGED
|
@@ -1,7 +1,37 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
import
|
|
5
|
-
import { addons } from 'storybook/manager-api';
|
|
1
|
+
import {
|
|
2
|
+
ADDON_CONTROLS_ID
|
|
3
|
+
} from "./_browser-chunks/chunk-B266DSPW.js";
|
|
4
|
+
import "./_browser-chunks/chunk-CBI7MY27.js";
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
// src/manager.tsx
|
|
7
|
+
import React, { Suspense, lazy } from "react";
|
|
8
|
+
import ReactDOM from "react-dom";
|
|
9
|
+
import { STORY_SPECIFIED } from "storybook/internal/core-events";
|
|
10
|
+
import { addons } from "storybook/manager-api";
|
|
11
|
+
var Onboarding = lazy(() => import("./_browser-chunks/Onboarding-LYWP3ZXX.js"));
|
|
12
|
+
addons.register("@storybook/addon-onboarding", async (api) => {
|
|
13
|
+
const urlState = api.getUrlState();
|
|
14
|
+
const isOnboarding = urlState.path === "/onboarding" || urlState.queryParams.onboarding === "true";
|
|
15
|
+
api.once(STORY_SPECIFIED, () => {
|
|
16
|
+
const hasButtonStories = !!api.getData("example-button--primary") || !!document.getElementById("example-button--primary");
|
|
17
|
+
if (!hasButtonStories) {
|
|
18
|
+
console.warn(
|
|
19
|
+
`[@storybook/addon-onboarding] It seems like you have finished the onboarding experience in Storybook! Therefore this addon is not necessary anymore and will not be loaded. You are free to remove it from your project. More info: https://github.com/storybookjs/storybook/tree/next/code/addons/onboarding#uninstalling`
|
|
20
|
+
);
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
if (!isOnboarding || window.innerWidth < 730) {
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
api.togglePanel(true);
|
|
27
|
+
api.togglePanelPosition("bottom");
|
|
28
|
+
api.setSelectedPanel(ADDON_CONTROLS_ID);
|
|
29
|
+
const domNode = document.createElement("div");
|
|
30
|
+
domNode.id = "storybook-addon-onboarding";
|
|
31
|
+
document.body.appendChild(domNode);
|
|
32
|
+
ReactDOM.render(
|
|
33
|
+
React.createElement(Suspense, { fallback: React.createElement("div", null) }, React.createElement(Onboarding, { api })),
|
|
34
|
+
domNode
|
|
35
|
+
);
|
|
36
|
+
});
|
|
37
|
+
});
|
package/dist/preset.js
CHANGED
|
@@ -1,8 +1,41 @@
|
|
|
1
|
-
|
|
1
|
+
import CJS_COMPAT_NODE_URL_tki919fka69 from 'node:url';
|
|
2
|
+
import CJS_COMPAT_NODE_PATH_tki919fka69 from 'node:path';
|
|
3
|
+
import CJS_COMPAT_NODE_MODULE_tki919fka69 from "node:module";
|
|
2
4
|
|
|
3
|
-
var
|
|
4
|
-
var
|
|
5
|
+
var __filename = CJS_COMPAT_NODE_URL_tki919fka69.fileURLToPath(import.meta.url);
|
|
6
|
+
var __dirname = CJS_COMPAT_NODE_PATH_tki919fka69.dirname(__filename);
|
|
7
|
+
var require = CJS_COMPAT_NODE_MODULE_tki919fka69.createRequire(import.meta.url);
|
|
5
8
|
|
|
6
|
-
|
|
9
|
+
// ------------------------------------------------------------
|
|
10
|
+
// end of CJS compatibility banner, injected by Storybook's esbuild configuration
|
|
11
|
+
// ------------------------------------------------------------
|
|
12
|
+
var __defProp = Object.defineProperty;
|
|
13
|
+
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
7
14
|
|
|
8
|
-
|
|
15
|
+
// src/preset.ts
|
|
16
|
+
import { telemetry } from "storybook/internal/telemetry";
|
|
17
|
+
|
|
18
|
+
// package.json
|
|
19
|
+
var version = "10.0.0-beta.1";
|
|
20
|
+
|
|
21
|
+
// src/constants.ts
|
|
22
|
+
var STORYBOOK_ADDON_ONBOARDING_CHANNEL = "STORYBOOK_ADDON_ONBOARDING_CHANNEL";
|
|
23
|
+
|
|
24
|
+
// src/preset.ts
|
|
25
|
+
var experimental_serverChannel = /* @__PURE__ */ __name(async (channel, options) => {
|
|
26
|
+
const { disableTelemetry } = await options.presets.apply("core", {});
|
|
27
|
+
if (disableTelemetry) {
|
|
28
|
+
return channel;
|
|
29
|
+
}
|
|
30
|
+
channel.on(STORYBOOK_ADDON_ONBOARDING_CHANNEL, ({ type, ...event }) => {
|
|
31
|
+
if (type === "telemetry") {
|
|
32
|
+
telemetry("addon-onboarding", { ...event, addonVersion: version });
|
|
33
|
+
} else if (type === "survey") {
|
|
34
|
+
telemetry("onboarding-survey", { ...event, addonVersion: version });
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
return channel;
|
|
38
|
+
}, "experimental_serverChannel");
|
|
39
|
+
export {
|
|
40
|
+
experimental_serverChannel
|
|
41
|
+
};
|
package/manager.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './dist/manager.js';
|
package/package.json
CHANGED
|
@@ -1,10 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-onboarding",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "Storybook
|
|
3
|
+
"version": "10.0.0-beta.1",
|
|
4
|
+
"description": "Storybook Onboarding: Help new users learn how to write stories",
|
|
5
5
|
"keywords": [
|
|
6
|
-
"storybook
|
|
7
|
-
"addon
|
|
6
|
+
"storybook",
|
|
7
|
+
"storybook-addon",
|
|
8
|
+
"onboarding",
|
|
9
|
+
"getting started",
|
|
10
|
+
"component",
|
|
11
|
+
"components",
|
|
12
|
+
"react",
|
|
13
|
+
"vue",
|
|
14
|
+
"angular",
|
|
15
|
+
"svelte",
|
|
16
|
+
"web-components"
|
|
8
17
|
],
|
|
9
18
|
"homepage": "https://github.com/storybookjs/storybook/tree/next/code/addons/onboarding",
|
|
10
19
|
"bugs": {
|
|
@@ -20,19 +29,16 @@
|
|
|
20
29
|
"url": "https://opencollective.com/storybook"
|
|
21
30
|
},
|
|
22
31
|
"license": "MIT",
|
|
32
|
+
"type": "module",
|
|
23
33
|
"exports": {
|
|
24
34
|
".": {
|
|
25
35
|
"types": "./dist/index.d.ts",
|
|
26
|
-
"
|
|
27
|
-
"require": "./dist/index.js"
|
|
36
|
+
"default": "./dist/index.js"
|
|
28
37
|
},
|
|
29
38
|
"./manager": "./dist/manager.js",
|
|
30
|
-
"./
|
|
31
|
-
"./
|
|
39
|
+
"./package.json": "./package.json",
|
|
40
|
+
"./preset": "./dist/preset.js"
|
|
32
41
|
},
|
|
33
|
-
"main": "dist/index.js",
|
|
34
|
-
"module": "dist/index.mjs",
|
|
35
|
-
"types": "dist/index.d.ts",
|
|
36
42
|
"files": [
|
|
37
43
|
"dist/**/*",
|
|
38
44
|
"README.md",
|
|
@@ -41,8 +47,8 @@
|
|
|
41
47
|
"!src/**/*"
|
|
42
48
|
],
|
|
43
49
|
"scripts": {
|
|
44
|
-
"check": "jiti ../../../scripts/
|
|
45
|
-
"prep": "jiti ../../../scripts/
|
|
50
|
+
"check": "jiti ../../../scripts/check/check-package.ts",
|
|
51
|
+
"prep": "jiti ../../../scripts/build/build-package.ts"
|
|
46
52
|
},
|
|
47
53
|
"devDependencies": {
|
|
48
54
|
"@neoconfetti/react": "^1.0.0",
|
|
@@ -53,20 +59,9 @@
|
|
|
53
59
|
"typescript": "^5.8.3"
|
|
54
60
|
},
|
|
55
61
|
"peerDependencies": {
|
|
56
|
-
"storybook": "^
|
|
62
|
+
"storybook": "^10.0.0-beta.1"
|
|
57
63
|
},
|
|
58
64
|
"publishConfig": {
|
|
59
65
|
"access": "public"
|
|
60
|
-
},
|
|
61
|
-
"bundler": {
|
|
62
|
-
"exportEntries": [
|
|
63
|
-
"./src/index.ts"
|
|
64
|
-
],
|
|
65
|
-
"managerEntries": [
|
|
66
|
-
"./src/manager.tsx"
|
|
67
|
-
],
|
|
68
|
-
"nodeEntries": [
|
|
69
|
-
"./src/preset.ts"
|
|
70
|
-
]
|
|
71
66
|
}
|
|
72
67
|
}
|