@dxos/plugin-help 0.7.5-labs.e27f9b9 → 0.7.5-main.2567c87
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/dist/lib/browser/{app-graph-builder-X4XWALX3.mjs → app-graph-builder-G3FCDRBG.mjs} +5 -8
- package/dist/lib/browser/{app-graph-builder-X4XWALX3.mjs.map → app-graph-builder-G3FCDRBG.mjs.map} +3 -3
- package/dist/lib/browser/{chunk-C7PCVS5K.mjs → chunk-VNAN5GRY.mjs} +151 -151
- package/dist/lib/browser/chunk-VNAN5GRY.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +12 -15
- package/dist/lib/browser/index.mjs.map +3 -3
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/{react-root-4AV22UGT.mjs → react-context-SIW6XKOC.mjs} +9 -9
- package/dist/lib/browser/react-context-SIW6XKOC.mjs.map +7 -0
- package/dist/lib/browser/{react-surface-7S3NUVZH.mjs → react-surface-TZZUXIVX.mjs} +2 -2
- package/dist/types/src/HelpPlugin.d.ts.map +1 -1
- package/dist/types/src/capabilities/app-graph-builder.d.ts +22 -22
- package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
- package/dist/types/src/capabilities/index.d.ts +30 -29
- package/dist/types/src/capabilities/index.d.ts.map +1 -1
- package/dist/types/src/capabilities/{react-root.d.ts → react-context.d.ts} +3 -2
- package/dist/types/src/capabilities/react-context.d.ts.map +1 -0
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.d.ts +9 -0
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.d.ts.map +1 -0
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.stories.d.ts +10 -0
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.stories.d.ts.map +1 -0
- package/dist/types/src/components/HelpContextProvider/index.d.ts +2 -0
- package/dist/types/src/components/HelpContextProvider/index.d.ts.map +1 -0
- package/dist/types/src/components/index.d.ts +1 -1
- package/dist/types/src/components/index.d.ts.map +1 -1
- package/package.json +19 -19
- package/src/HelpPlugin.tsx +7 -10
- package/src/capabilities/app-graph-builder.ts +1 -9
- package/src/capabilities/index.ts +1 -1
- package/src/capabilities/{react-root.tsx → react-context.tsx} +7 -5
- package/src/components/{WelcomeTour/WelcomeTour.stories.tsx → HelpContextProvider/HelpContextProvider.stories.tsx} +8 -9
- package/src/components/{WelcomeTour/WelcomeTour.tsx → HelpContextProvider/HelpContextProvider.tsx} +13 -7
- package/src/components/HelpContextProvider/index.ts +5 -0
- package/src/components/index.ts +1 -1
- package/dist/lib/browser/chunk-C7PCVS5K.mjs.map +0 -7
- package/dist/lib/browser/react-root-4AV22UGT.mjs.map +0 -7
- package/dist/types/src/capabilities/react-root.d.ts.map +0 -1
- package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts +0 -9
- package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +0 -1
- package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts +0 -10
- package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +0 -1
- package/dist/types/src/components/WelcomeTour/index.d.ts +0 -2
- package/dist/types/src/components/WelcomeTour/index.d.ts.map +0 -1
- package/src/components/WelcomeTour/index.ts +0 -5
- /package/dist/lib/browser/{react-surface-7S3NUVZH.mjs.map → react-surface-TZZUXIVX.mjs.map} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").PluginsContext | undefined) => Promise<
|
|
1
|
+
export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").PluginsContext | undefined) => Promise<import("@dxos/app-framework").Capability<Readonly<{
|
|
2
2
|
id: string;
|
|
3
|
-
|
|
3
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
4
4
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
5
5
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
6
6
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -8,7 +8,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
8
8
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
9
9
|
}> | Readonly<{
|
|
10
10
|
id: string;
|
|
11
|
-
|
|
11
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
12
12
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
13
13
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
14
14
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -16,7 +16,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
16
16
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
17
17
|
}>[] | (Readonly<{
|
|
18
18
|
id: string;
|
|
19
|
-
|
|
19
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
20
20
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
21
21
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
22
22
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -24,7 +24,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
24
24
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
25
25
|
}> | Readonly<{
|
|
26
26
|
id: string;
|
|
27
|
-
|
|
27
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
28
28
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
29
29
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
30
30
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -32,7 +32,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
32
32
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
33
33
|
}>[] | (Readonly<{
|
|
34
34
|
id: string;
|
|
35
|
-
|
|
35
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
36
36
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
37
37
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
38
38
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -40,7 +40,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
40
40
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
41
41
|
}> | Readonly<{
|
|
42
42
|
id: string;
|
|
43
|
-
|
|
43
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
44
44
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
45
45
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
46
46
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -48,7 +48,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
48
48
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
49
49
|
}>[] | (Readonly<{
|
|
50
50
|
id: string;
|
|
51
|
-
|
|
51
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
52
52
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
53
53
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
54
54
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -56,7 +56,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
56
56
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
57
57
|
}> | Readonly<{
|
|
58
58
|
id: string;
|
|
59
|
-
|
|
59
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
60
60
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
61
61
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
62
62
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -64,7 +64,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
64
64
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
65
65
|
}>[] | (Readonly<{
|
|
66
66
|
id: string;
|
|
67
|
-
|
|
67
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
68
68
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
69
69
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
70
70
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -72,7 +72,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
72
72
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
73
73
|
}> | Readonly<{
|
|
74
74
|
id: string;
|
|
75
|
-
|
|
75
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
76
76
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
77
77
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
78
78
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -80,7 +80,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
80
80
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
81
81
|
}>[] | (Readonly<{
|
|
82
82
|
id: string;
|
|
83
|
-
|
|
83
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
84
84
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
85
85
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
86
86
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -88,7 +88,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
88
88
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
89
89
|
}> | Readonly<{
|
|
90
90
|
id: string;
|
|
91
|
-
|
|
91
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
92
92
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
93
93
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
94
94
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -96,7 +96,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
96
96
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
97
97
|
}>[] | (Readonly<{
|
|
98
98
|
id: string;
|
|
99
|
-
|
|
99
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
100
100
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
101
101
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
102
102
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -104,7 +104,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
104
104
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
105
105
|
}> | Readonly<{
|
|
106
106
|
id: string;
|
|
107
|
-
|
|
107
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
108
108
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
109
109
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
110
110
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -112,7 +112,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
112
112
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
113
113
|
}>[] | (Readonly<{
|
|
114
114
|
id: string;
|
|
115
|
-
|
|
115
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
116
116
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
117
117
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
118
118
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -120,7 +120,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
120
120
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
121
121
|
}> | Readonly<{
|
|
122
122
|
id: string;
|
|
123
|
-
|
|
123
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
124
124
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
125
125
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
126
126
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -128,7 +128,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
128
128
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
129
129
|
}>[] | (Readonly<{
|
|
130
130
|
id: string;
|
|
131
|
-
|
|
131
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
132
132
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
133
133
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
134
134
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -136,7 +136,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
136
136
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
137
137
|
}> | Readonly<{
|
|
138
138
|
id: string;
|
|
139
|
-
|
|
139
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
140
140
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
141
141
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
142
142
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -144,7 +144,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
144
144
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
145
145
|
}>[] | (Readonly<{
|
|
146
146
|
id: string;
|
|
147
|
-
|
|
147
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
148
148
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
149
149
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
150
150
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -152,7 +152,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
152
152
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
153
153
|
}> | Readonly<{
|
|
154
154
|
id: string;
|
|
155
|
-
|
|
155
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
156
156
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
157
157
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
158
158
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -160,7 +160,7 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
160
160
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
161
161
|
}>[] | (any[] | Readonly<{
|
|
162
162
|
id: string;
|
|
163
|
-
|
|
163
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
164
164
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
165
165
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
166
166
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
@@ -168,18 +168,19 @@ export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").Plu
|
|
|
168
168
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
169
169
|
}> | Readonly<{
|
|
170
170
|
id: string;
|
|
171
|
-
|
|
171
|
+
disposition: import("packages/common/util/dist/types/src").Disposition;
|
|
172
172
|
resolver?: import("packages/sdk/app-graph/dist/types/src").ResolverExtension;
|
|
173
173
|
connector?: import("packages/sdk/app-graph/dist/types/src").ConnectorExtension;
|
|
174
174
|
relation?: import("packages/sdk/app-graph/dist/types/src").Relation;
|
|
175
175
|
type?: string;
|
|
176
176
|
filter?: (node: import("packages/sdk/app-graph/dist/types/src").Node) => boolean;
|
|
177
|
-
}>[])[])[])[])[])[])[])[])[])[])[]
|
|
178
|
-
export declare const
|
|
177
|
+
}>[])[])[])[])[])[])[])[])[])[])[]>>;
|
|
178
|
+
export declare const ReactContext: (props?: import("..").Step[] | undefined) => Promise<import("@dxos/app-framework").Capability<Readonly<{
|
|
179
179
|
id: string;
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
export declare const
|
|
180
|
+
dependsOn?: string[];
|
|
181
|
+
context: import("react").FC<import("react").PropsWithChildren>;
|
|
182
|
+
}>>>;
|
|
183
|
+
export declare const ReactSurface: (props?: unknown) => Promise<import("@dxos/app-framework").Capability<import("@dxos/app-framework").Capabilities.ReactSurface>>;
|
|
184
|
+
export declare const HelpState: (props?: unknown) => Promise<import("@dxos/app-framework").Capability<import("packages/core/echo/live-object/dist/types/src").ReactiveObject<import("./capabilities").HelpCapabilities.State>>>;
|
|
184
185
|
export * from './capabilities';
|
|
185
186
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/index.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,eAAe;;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/index.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,eAAe;;wBAMu3J,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAA2F,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;;;wBAAwF,qCAAY;sBAAyC,uCAAiB;uBAAgD,uCAAiB;sBAAgD,uCAAiB;;2BAAkE,uCAAiB;oCANnvZ,CAAC;AACzE,eAAO,MAAM,YAAY;;;;IAAwC,CAAC;AAClE,eAAO,MAAM,YAAY,iIAAwC,CAAC;AAClE,eAAO,MAAM,SAAS,iMAAgC,CAAC;AAEvD,cAAc,gBAAgB,CAAC"}
|
|
@@ -2,7 +2,8 @@ import React from 'react';
|
|
|
2
2
|
import { type Step } from '../types';
|
|
3
3
|
declare const _default: (steps: Step[]) => import("@dxos/app-framework").Capability<Readonly<{
|
|
4
4
|
id: string;
|
|
5
|
-
|
|
5
|
+
dependsOn?: string[];
|
|
6
|
+
context: React.FC<React.PropsWithChildren>;
|
|
6
7
|
}>>;
|
|
7
8
|
export default _default;
|
|
8
|
-
//# sourceMappingURL=react-
|
|
9
|
+
//# sourceMappingURL=react-context.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"react-context.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/react-context.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,UAAU,CAAC;gCAEd,IAAI,EAAE;;;;;AAA7B,wBAoBK"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import React, { type PropsWithChildren } from 'react';
|
|
2
|
+
import { type Step } from '../../types';
|
|
3
|
+
export type HelpContextProviderProps = PropsWithChildren<{
|
|
4
|
+
steps: Step[];
|
|
5
|
+
running?: boolean;
|
|
6
|
+
onRunningChanged?: (state: boolean) => any;
|
|
7
|
+
}>;
|
|
8
|
+
export declare const HelpContextProvider: ({ children, steps: initialSteps, running: runningProp, onRunningChanged, }: HelpContextProviderProps) => React.JSX.Element;
|
|
9
|
+
//# sourceMappingURL=HelpContextProvider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"HelpContextProvider.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/HelpContextProvider.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAE,KAAK,iBAAiB,EAAuB,MAAM,OAAO,CAAC;AAK3E,OAAO,EAAE,KAAK,IAAI,EAAe,MAAM,aAAa,CAAC;AAkDrD,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACvD,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC;CAC5C,CAAC,CAAC;AAEH,eAAO,MAAM,mBAAmB,+EAK7B,wBAAwB,sBAyG1B,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import '@dxos-theme';
|
|
2
|
+
import { type Meta, type StoryObj } from '@storybook/react';
|
|
3
|
+
import { HelpContextProvider } from './HelpContextProvider';
|
|
4
|
+
export declare const Default: StoryObj<typeof HelpContextProvider>;
|
|
5
|
+
/**
|
|
6
|
+
* IMPORTANT: Run in separate tab.
|
|
7
|
+
*/
|
|
8
|
+
declare const meta: Meta<typeof HelpContextProvider>;
|
|
9
|
+
export default meta;
|
|
10
|
+
//# sourceMappingURL=HelpContextProvider.stories.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"HelpContextProvider.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/HelpContextProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAGrB,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAO5D,OAAO,EAAE,mBAAmB,EAAiC,MAAM,uBAAuB,CAAC;AAwD3F,eAAO,MAAM,OAAO,EAAE,QAAQ,CAAC,OAAO,mBAAmB,CA8BxD,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,mBAAmB,CAK1C,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/index.ts"],"names":[],"mappings":"AAIA,cAAc,uBAAuB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.ts"],"names":[],"mappings":"AAIA,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.ts"],"names":[],"mappings":"AAIA,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/plugin-help",
|
|
3
|
-
"version": "0.7.5-
|
|
3
|
+
"version": "0.7.5-main.2567c87",
|
|
4
4
|
"description": "Help plugin.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -30,20 +30,20 @@
|
|
|
30
30
|
"src"
|
|
31
31
|
],
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@fluentui/react-tabster": "9.
|
|
33
|
+
"@fluentui/react-tabster": "^9.19.0",
|
|
34
34
|
"lodash.get": "^4.4.2",
|
|
35
35
|
"react-joyride": "^2.7.2",
|
|
36
|
-
"@dxos/app-
|
|
37
|
-
"@dxos/app-
|
|
38
|
-
"@dxos/debug": "0.7.5-
|
|
39
|
-
"@dxos/keyboard": "0.7.5-
|
|
40
|
-
"@dxos/
|
|
41
|
-
"@dxos/
|
|
42
|
-
"@dxos/plugin-
|
|
43
|
-
"@dxos/echo-schema": "0.7.5-
|
|
44
|
-
"@dxos/plugin-
|
|
45
|
-
"@dxos/
|
|
46
|
-
"@dxos/
|
|
36
|
+
"@dxos/app-framework": "0.7.5-main.2567c87",
|
|
37
|
+
"@dxos/app-graph": "0.7.5-main.2567c87",
|
|
38
|
+
"@dxos/debug": "0.7.5-main.2567c87",
|
|
39
|
+
"@dxos/keyboard": "0.7.5-main.2567c87",
|
|
40
|
+
"@dxos/local-storage": "0.7.5-main.2567c87",
|
|
41
|
+
"@dxos/plugin-client": "0.7.5-main.2567c87",
|
|
42
|
+
"@dxos/plugin-graph": "0.7.5-main.2567c87",
|
|
43
|
+
"@dxos/echo-schema": "0.7.5-main.2567c87",
|
|
44
|
+
"@dxos/plugin-space": "0.7.5-main.2567c87",
|
|
45
|
+
"@dxos/react-client": "0.7.5-main.2567c87",
|
|
46
|
+
"@dxos/live-object": "0.7.5-main.2567c87"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@phosphor-icons/react": "^2.1.5",
|
|
@@ -55,17 +55,17 @@
|
|
|
55
55
|
"react-floater": "0.7.9",
|
|
56
56
|
"type-fest": "4.10.1",
|
|
57
57
|
"vite": "5.4.7",
|
|
58
|
-
"@dxos/
|
|
59
|
-
"@dxos/
|
|
60
|
-
"@dxos/react-ui": "0.7.5-
|
|
61
|
-
"@dxos/
|
|
58
|
+
"@dxos/react-ui": "0.7.5-main.2567c87",
|
|
59
|
+
"@dxos/random": "0.7.5-main.2567c87",
|
|
60
|
+
"@dxos/react-ui-theme": "0.7.5-main.2567c87",
|
|
61
|
+
"@dxos/storybook-utils": "0.7.5-main.2567c87"
|
|
62
62
|
},
|
|
63
63
|
"peerDependencies": {
|
|
64
64
|
"@phosphor-icons/react": "^2.1.5",
|
|
65
65
|
"react": "~18.2.0",
|
|
66
66
|
"react-dom": "~18.2.0",
|
|
67
|
-
"@dxos/react-ui": "0.7.5-
|
|
68
|
-
"@dxos/react-ui-theme": "0.7.5-
|
|
67
|
+
"@dxos/react-ui": "0.7.5-main.2567c87",
|
|
68
|
+
"@dxos/react-ui-theme": "0.7.5-main.2567c87"
|
|
69
69
|
},
|
|
70
70
|
"publishConfig": {
|
|
71
71
|
"access": "public"
|
package/src/HelpPlugin.tsx
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
import { createResolver, defineModule, definePlugin, Events, contributes, Capabilities } from '@dxos/app-framework';
|
|
6
6
|
|
|
7
|
-
import { AppGraphBuilder, HelpState,
|
|
7
|
+
import { AppGraphBuilder, HelpState, ReactContext, ReactSurface } from './capabilities';
|
|
8
8
|
import { HelpCapabilities } from './capabilities/capabilities';
|
|
9
9
|
import { meta } from './meta';
|
|
10
10
|
import translations from './translations';
|
|
@@ -25,13 +25,13 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions) =>
|
|
|
25
25
|
activate: () => contributes(Capabilities.Translations, translations),
|
|
26
26
|
}),
|
|
27
27
|
defineModule({
|
|
28
|
-
id: `${meta.id}/module/react-
|
|
28
|
+
id: `${meta.id}/module/react-context`,
|
|
29
29
|
activatesOn: Events.Startup,
|
|
30
|
-
activate: () =>
|
|
30
|
+
activate: () => ReactContext(steps),
|
|
31
31
|
}),
|
|
32
32
|
defineModule({
|
|
33
33
|
id: `${meta.id}/module/react-surface`,
|
|
34
|
-
activatesOn: Events.
|
|
34
|
+
activatesOn: Events.Startup,
|
|
35
35
|
activate: ReactSurface,
|
|
36
36
|
}),
|
|
37
37
|
defineModule({
|
|
@@ -40,12 +40,9 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions) =>
|
|
|
40
40
|
activate: (context) =>
|
|
41
41
|
contributes(
|
|
42
42
|
Capabilities.IntentResolver,
|
|
43
|
-
createResolver({
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
const state = context.requestCapability(HelpCapabilities.MutableState);
|
|
47
|
-
state.running = true;
|
|
48
|
-
},
|
|
43
|
+
createResolver(HelpAction.Start, () => {
|
|
44
|
+
const state = context.requestCapability(HelpCapabilities.MutableState);
|
|
45
|
+
state.running = true;
|
|
49
46
|
}),
|
|
50
47
|
),
|
|
51
48
|
}),
|
|
@@ -43,15 +43,7 @@ export default (context: PluginsContext) =>
|
|
|
43
43
|
const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);
|
|
44
44
|
const state = context.requestCapability(HelpCapabilities.MutableState);
|
|
45
45
|
state.showHints = true;
|
|
46
|
-
await dispatch(
|
|
47
|
-
createIntent(LayoutAction.UpdateDialog, {
|
|
48
|
-
part: 'dialog',
|
|
49
|
-
subject: SHORTCUTS_DIALOG,
|
|
50
|
-
options: {
|
|
51
|
-
blockAlign: 'center',
|
|
52
|
-
},
|
|
53
|
-
}),
|
|
54
|
-
);
|
|
46
|
+
await dispatch?.(createIntent(LayoutAction.SetLayout, { element: 'dialog', component: SHORTCUTS_DIALOG }));
|
|
55
47
|
},
|
|
56
48
|
properties: {
|
|
57
49
|
label: ['open shortcuts label', { ns: HELP_PLUGIN }],
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import { lazy } from '@dxos/app-framework';
|
|
6
6
|
|
|
7
7
|
export const AppGraphBuilder = lazy(() => import('./app-graph-builder'));
|
|
8
|
-
export const
|
|
8
|
+
export const ReactContext = lazy(() => import('./react-context'));
|
|
9
9
|
export const ReactSurface = lazy(() => import('./react-surface'));
|
|
10
10
|
export const HelpState = lazy(() => import('./state'));
|
|
11
11
|
|
|
@@ -7,17 +7,17 @@ import React from 'react';
|
|
|
7
7
|
import { Capabilities, contributes, useCapability } from '@dxos/app-framework';
|
|
8
8
|
|
|
9
9
|
import { HelpCapabilities } from './capabilities';
|
|
10
|
-
import {
|
|
10
|
+
import { HelpContextProvider } from '../components';
|
|
11
11
|
import { HELP_PLUGIN } from '../meta';
|
|
12
12
|
import { type Step } from '../types';
|
|
13
13
|
|
|
14
14
|
export default (steps: Step[]) =>
|
|
15
|
-
contributes(Capabilities.
|
|
15
|
+
contributes(Capabilities.ReactContext, {
|
|
16
16
|
id: HELP_PLUGIN,
|
|
17
|
-
|
|
17
|
+
context: ({ children }) => {
|
|
18
18
|
const state = useCapability(HelpCapabilities.MutableState);
|
|
19
19
|
return (
|
|
20
|
-
<
|
|
20
|
+
<HelpContextProvider
|
|
21
21
|
steps={steps}
|
|
22
22
|
running={state.running}
|
|
23
23
|
onRunningChanged={(newState) => {
|
|
@@ -26,7 +26,9 @@ export default (steps: Step[]) =>
|
|
|
26
26
|
state.showHints = false;
|
|
27
27
|
}
|
|
28
28
|
}}
|
|
29
|
-
|
|
29
|
+
>
|
|
30
|
+
{children}
|
|
31
|
+
</HelpContextProvider>
|
|
30
32
|
);
|
|
31
33
|
},
|
|
32
34
|
});
|
|
@@ -12,7 +12,7 @@ import { faker } from '@dxos/random';
|
|
|
12
12
|
import { Button } from '@dxos/react-ui';
|
|
13
13
|
import { withTheme } from '@dxos/storybook-utils';
|
|
14
14
|
|
|
15
|
-
import {
|
|
15
|
+
import { HelpContextProvider, type HelpContextProviderProps } from './HelpContextProvider';
|
|
16
16
|
import { useHelp } from '../../hooks';
|
|
17
17
|
|
|
18
18
|
const App = () => {
|
|
@@ -57,19 +57,18 @@ const App = () => {
|
|
|
57
57
|
);
|
|
58
58
|
};
|
|
59
59
|
|
|
60
|
-
const DefaultStory = ({ steps = [] }:
|
|
61
|
-
|
|
62
|
-
<WelcomeTour steps={steps} />
|
|
60
|
+
const DefaultStory = ({ steps = [] }: HelpContextProviderProps) => (
|
|
61
|
+
<HelpContextProvider steps={steps}>
|
|
63
62
|
<div className='fixed inset-0 overflow-hidden'>
|
|
64
63
|
<App />
|
|
65
64
|
</div>
|
|
66
|
-
|
|
65
|
+
</HelpContextProvider>
|
|
67
66
|
);
|
|
68
67
|
|
|
69
68
|
// TODO(burdon): Tour should prompt user to create a Stack -- and respond to it being created.
|
|
70
69
|
// Use beacon to simulate click.
|
|
71
70
|
|
|
72
|
-
export const Default: StoryObj<typeof
|
|
71
|
+
export const Default: StoryObj<typeof HelpContextProvider> = {
|
|
73
72
|
args: {
|
|
74
73
|
// https://docs.react-joyride.com/step#options
|
|
75
74
|
steps: [
|
|
@@ -104,9 +103,9 @@ export const Default: StoryObj<typeof WelcomeTour> = {
|
|
|
104
103
|
/**
|
|
105
104
|
* IMPORTANT: Run in separate tab.
|
|
106
105
|
*/
|
|
107
|
-
const meta: Meta<typeof
|
|
108
|
-
title: 'plugins/plugin-help/
|
|
109
|
-
component:
|
|
106
|
+
const meta: Meta<typeof HelpContextProvider> = {
|
|
107
|
+
title: 'plugins/plugin-help/Joyride',
|
|
108
|
+
component: HelpContextProvider,
|
|
110
109
|
render: DefaultStory,
|
|
111
110
|
decorators: [withTheme],
|
|
112
111
|
};
|
package/src/components/{WelcomeTour/WelcomeTour.tsx → HelpContextProvider/HelpContextProvider.tsx}
RENAMED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
// Copyright 2023 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import React, { useState, useEffect } from 'react';
|
|
5
|
+
import React, { type PropsWithChildren, useState, useEffect } from 'react';
|
|
6
6
|
import Joyride, { ACTIONS, EVENTS } from 'react-joyride';
|
|
7
7
|
|
|
8
|
-
import { usePluginManager,
|
|
8
|
+
import { usePluginManager, useCapability, Capabilities } from '@dxos/app-framework';
|
|
9
9
|
|
|
10
10
|
import { type Step, HelpContext } from '../../types';
|
|
11
11
|
import { floaterProps, Tooltip } from '../Tooltip';
|
|
@@ -57,15 +57,20 @@ const waitForTarget = async (step: Step) => {
|
|
|
57
57
|
}
|
|
58
58
|
};
|
|
59
59
|
|
|
60
|
-
export type
|
|
60
|
+
export type HelpContextProviderProps = PropsWithChildren<{
|
|
61
61
|
steps: Step[];
|
|
62
62
|
running?: boolean;
|
|
63
63
|
onRunningChanged?: (state: boolean) => any;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export const
|
|
64
|
+
}>;
|
|
65
|
+
|
|
66
|
+
export const HelpContextProvider = ({
|
|
67
|
+
children,
|
|
68
|
+
steps: initialSteps,
|
|
69
|
+
running: runningProp,
|
|
70
|
+
onRunningChanged,
|
|
71
|
+
}: HelpContextProviderProps) => {
|
|
67
72
|
const manager = usePluginManager();
|
|
68
|
-
const layout =
|
|
73
|
+
const layout = useCapability(Capabilities.Layout);
|
|
69
74
|
const [running, setRunning] = useState(!!runningProp && !!getTarget(initialSteps[0]));
|
|
70
75
|
const [stepIndex, _setStepIndex] = useState(0);
|
|
71
76
|
const [steps, setSteps] = useState(initialSteps);
|
|
@@ -165,6 +170,7 @@ export const WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunni
|
|
|
165
170
|
floaterProps={floaterProps}
|
|
166
171
|
tooltipComponent={Tooltip}
|
|
167
172
|
/>
|
|
173
|
+
{children}
|
|
168
174
|
</HelpContext.Provider>
|
|
169
175
|
);
|
|
170
176
|
};
|