@dxos/plugin-help 0.8.4-main.9735255 → 0.8.4-main.9be5663bfe

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.
Files changed (142) hide show
  1. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  2. package/dist/lib/browser/chunk-J5LGTIGS.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-K4LQ2TR7.mjs +34 -0
  4. package/dist/lib/browser/chunk-K4LQ2TR7.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-KUUIRJG5.mjs +31 -0
  6. package/dist/lib/browser/chunk-KUUIRJG5.mjs.map +7 -0
  7. package/dist/lib/browser/{chunk-IM2QVQOH.mjs → chunk-TEXIV2IJ.mjs} +2 -2
  8. package/dist/lib/browser/{chunk-IM2QVQOH.mjs.map → chunk-TEXIV2IJ.mjs.map} +1 -1
  9. package/dist/lib/browser/index.mjs +351 -67
  10. package/dist/lib/browser/index.mjs.map +4 -4
  11. package/dist/lib/browser/meta.json +1 -1
  12. package/dist/lib/browser/meta.mjs +2 -1
  13. package/dist/lib/browser/operations/index.mjs +13 -0
  14. package/dist/lib/browser/operations/index.mjs.map +7 -0
  15. package/dist/lib/browser/start-YZBO346C.mjs +23 -0
  16. package/dist/lib/browser/start-YZBO346C.mjs.map +7 -0
  17. package/dist/lib/browser/types/index.mjs +4 -6
  18. package/dist/types/src/HelpPlugin.d.ts +1 -1
  19. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  20. package/dist/types/src/capabilities/app-graph-builder.d.ts +6 -0
  21. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -0
  22. package/dist/types/src/capabilities/index.d.ts +18 -5
  23. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  24. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  25. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  26. package/dist/types/src/capabilities/{react-root/react-root.d.ts → react-root.d.ts} +2 -2
  27. package/dist/types/src/capabilities/react-root.d.ts.map +1 -0
  28. package/dist/types/src/capabilities/react-surface.d.ts +5 -0
  29. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -0
  30. package/dist/types/src/capabilities/{state/state.d.ts → state.d.ts} +1 -1
  31. package/dist/types/src/capabilities/state.d.ts.map +1 -0
  32. package/dist/types/src/components/Shortcuts/ShortcutsSection.d.ts.map +1 -1
  33. package/dist/types/src/components/Shortcuts/index.d.ts +0 -1
  34. package/dist/types/src/components/Shortcuts/index.d.ts.map +1 -1
  35. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts +1 -1
  36. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  37. package/dist/types/src/constants.d.ts +2 -0
  38. package/dist/types/src/constants.d.ts.map +1 -0
  39. package/dist/types/src/{components/Shortcuts/ShortcutsDialog.d.ts → containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts} +1 -2
  40. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts.map +1 -0
  41. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +25 -0
  42. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -0
  43. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts +2 -0
  44. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts.map +1 -0
  45. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts +2 -0
  46. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts.map +1 -0
  47. package/dist/types/src/containers/ShortcutsHints/index.d.ts +2 -0
  48. package/dist/types/src/containers/ShortcutsHints/index.d.ts.map +1 -0
  49. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts +2 -0
  50. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts.map +1 -0
  51. package/dist/types/src/containers/ShortcutsList/index.d.ts +2 -0
  52. package/dist/types/src/containers/ShortcutsList/index.d.ts.map +1 -0
  53. package/dist/types/src/containers/index.d.ts +5 -0
  54. package/dist/types/src/containers/index.d.ts.map +1 -0
  55. package/dist/types/src/hooks/useHelp.d.ts +1 -1
  56. package/dist/types/src/hooks/useHelp.d.ts.map +1 -1
  57. package/dist/types/src/index.d.ts +1 -0
  58. package/dist/types/src/index.d.ts.map +1 -1
  59. package/dist/types/src/operations/definitions.d.ts +4 -0
  60. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  61. package/dist/types/src/operations/index.d.ts +4 -0
  62. package/dist/types/src/operations/index.d.ts.map +1 -0
  63. package/dist/types/src/operations/start.d.ts +5 -0
  64. package/dist/types/src/operations/start.d.ts.map +1 -0
  65. package/dist/types/src/translations.d.ts +5 -5
  66. package/dist/types/src/translations.d.ts.map +1 -1
  67. package/dist/types/src/types/schema.d.ts +1 -17
  68. package/dist/types/src/types/schema.d.ts.map +1 -1
  69. package/dist/types/tsconfig.tsbuildinfo +1 -1
  70. package/package.json +46 -28
  71. package/src/HelpPlugin.tsx +12 -10
  72. package/src/capabilities/{app-graph-builder/app-graph-builder.ts → app-graph-builder.ts} +20 -18
  73. package/src/capabilities/index.ts +11 -5
  74. package/src/capabilities/operation-handler.ts +16 -0
  75. package/src/capabilities/{react-root/react-root.tsx → react-root.tsx} +6 -6
  76. package/src/capabilities/react-surface.tsx +37 -0
  77. package/src/capabilities/{state/state.ts → state.ts} +2 -2
  78. package/src/components/Shortcuts/ShortcutsHints.tsx +1 -1
  79. package/src/components/Shortcuts/ShortcutsList.tsx +3 -3
  80. package/src/components/Shortcuts/ShortcutsSection.tsx +1 -3
  81. package/src/components/Shortcuts/index.ts +0 -1
  82. package/src/components/Shortcuts/styles.ts +2 -2
  83. package/src/components/Tooltip/Tooltip.tsx +4 -4
  84. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +14 -14
  85. package/src/components/WelcomeTour/WelcomeTour.tsx +4 -2
  86. package/src/constants.ts +7 -0
  87. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +38 -0
  88. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +28 -0
  89. package/src/containers/ShortcutsDialogContent/index.ts +5 -0
  90. package/src/containers/ShortcutsHints/ShortcutsHints.tsx +5 -0
  91. package/src/containers/ShortcutsHints/index.ts +5 -0
  92. package/src/containers/ShortcutsList/ShortcutsList.tsx +5 -0
  93. package/src/containers/ShortcutsList/index.ts +5 -0
  94. package/src/containers/index.ts +9 -0
  95. package/src/hooks/useHelp.tsx +1 -1
  96. package/src/index.ts +1 -0
  97. package/src/meta.ts +1 -1
  98. package/src/operations/definitions.ts +19 -0
  99. package/src/operations/index.ts +9 -0
  100. package/src/operations/start.ts +21 -0
  101. package/src/translations.ts +5 -5
  102. package/src/types/capabilities.ts +2 -2
  103. package/src/types/schema.ts +1 -15
  104. package/dist/lib/browser/app-graph-builder-DX3VXARQ.mjs +0 -79
  105. package/dist/lib/browser/app-graph-builder-DX3VXARQ.mjs.map +0 -7
  106. package/dist/lib/browser/chunk-TS66J4C6.mjs +0 -58
  107. package/dist/lib/browser/chunk-TS66J4C6.mjs.map +0 -7
  108. package/dist/lib/browser/chunk-W5XAZM46.mjs +0 -360
  109. package/dist/lib/browser/chunk-W5XAZM46.mjs.map +0 -7
  110. package/dist/lib/browser/react-root-SZRF6EXG.mjs +0 -43
  111. package/dist/lib/browser/react-root-SZRF6EXG.mjs.map +0 -7
  112. package/dist/lib/browser/react-surface-DWNTJBVM.mjs +0 -37
  113. package/dist/lib/browser/react-surface-DWNTJBVM.mjs.map +0 -7
  114. package/dist/lib/browser/state-VRPLKT3F.mjs +0 -27
  115. package/dist/lib/browser/state-VRPLKT3F.mjs.map +0 -7
  116. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts +0 -6
  117. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +0 -1
  118. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +0 -3
  119. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +0 -1
  120. package/dist/types/src/capabilities/operation-resolver/index.d.ts +0 -2
  121. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +0 -1
  122. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +0 -5
  123. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +0 -1
  124. package/dist/types/src/capabilities/react-root/index.d.ts +0 -6
  125. package/dist/types/src/capabilities/react-root/index.d.ts.map +0 -1
  126. package/dist/types/src/capabilities/react-root/react-root.d.ts.map +0 -1
  127. package/dist/types/src/capabilities/react-surface/index.d.ts +0 -3
  128. package/dist/types/src/capabilities/react-surface/index.d.ts.map +0 -1
  129. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +0 -5
  130. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +0 -1
  131. package/dist/types/src/capabilities/state/index.d.ts +0 -11
  132. package/dist/types/src/capabilities/state/index.d.ts.map +0 -1
  133. package/dist/types/src/capabilities/state/state.d.ts.map +0 -1
  134. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +0 -1
  135. package/src/capabilities/app-graph-builder/index.ts +0 -7
  136. package/src/capabilities/operation-resolver/index.ts +0 -5
  137. package/src/capabilities/operation-resolver/operation-resolver.ts +0 -23
  138. package/src/capabilities/react-root/index.ts +0 -7
  139. package/src/capabilities/react-surface/index.ts +0 -7
  140. package/src/capabilities/react-surface/react-surface.tsx +0 -34
  141. package/src/capabilities/state/index.ts +0 -7
  142. package/src/components/Shortcuts/ShortcutsDialog.tsx +0 -32
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/plugin-help",
3
- "version": "0.8.4-main.9735255",
3
+ "version": "0.8.4-main.9be5663bfe",
4
4
  "description": "Help plugin.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -12,6 +12,15 @@
12
12
  "author": "DXOS.org",
13
13
  "sideEffects": true,
14
14
  "type": "module",
15
+ "imports": {
16
+ "#capabilities": "./src/capabilities/index.ts",
17
+ "#components": "./src/components/index.ts",
18
+ "#containers": "./src/containers/index.ts",
19
+ "#hooks": "./src/hooks/index.ts",
20
+ "#meta": "./src/meta.ts",
21
+ "#operations": "./src/operations/index.ts",
22
+ "#types": "./src/types/index.ts"
23
+ },
15
24
  "exports": {
16
25
  ".": {
17
26
  "source": "./src/index.ts",
@@ -23,6 +32,11 @@
23
32
  "types": "./dist/types/src/meta.d.ts",
24
33
  "browser": "./dist/lib/browser/meta.mjs"
25
34
  },
35
+ "./operations": {
36
+ "source": "./src/operations/index.ts",
37
+ "types": "./dist/types/src/operations/index.d.ts",
38
+ "browser": "./dist/lib/browser/operations/index.mjs"
39
+ },
26
40
  "./types": {
27
41
  "source": "./src/types/index.ts",
28
42
  "types": "./dist/types/src/types/index.d.ts",
@@ -37,6 +51,9 @@
37
51
  ],
38
52
  "types": [
39
53
  "dist/types/src/types/index.d.ts"
54
+ ],
55
+ "operations": [
56
+ "dist/types/src/operations/index.d.ts"
40
57
  ]
41
58
  }
42
59
  },
@@ -45,47 +62,48 @@
45
62
  "src"
46
63
  ],
47
64
  "dependencies": {
48
- "@effect-atom/atom": "^0.4.13",
65
+ "@effect-atom/atom": "^0.5.1",
49
66
  "@fluentui/react-tabster": "9.26.11",
50
67
  "react-joyride": "^2.7.2",
51
- "@dxos/app-framework": "0.8.4-main.9735255",
52
- "@dxos/debug": "0.8.4-main.9735255",
53
- "@dxos/app-graph": "0.8.4-main.9735255",
54
- "@dxos/echo": "0.8.4-main.9735255",
55
- "@dxos/effect": "0.8.4-main.9735255",
56
- "@dxos/keyboard": "0.8.4-main.9735255",
57
- "@dxos/operation": "0.8.4-main.9735255",
58
- "@dxos/plugin-client": "0.8.4-main.9735255",
59
- "@dxos/plugin-graph": "0.8.4-main.9735255",
60
- "@dxos/plugin-space": "0.8.4-main.9735255",
61
- "@dxos/util": "0.8.4-main.9735255",
62
- "@dxos/react-client": "0.8.4-main.9735255"
68
+ "@dxos/app-framework": "0.8.4-main.9be5663bfe",
69
+ "@dxos/app-toolkit": "0.8.4-main.9be5663bfe",
70
+ "@dxos/app-graph": "0.8.4-main.9be5663bfe",
71
+ "@dxos/debug": "0.8.4-main.9be5663bfe",
72
+ "@dxos/effect": "0.8.4-main.9be5663bfe",
73
+ "@dxos/echo": "0.8.4-main.9be5663bfe",
74
+ "@dxos/operation": "0.8.4-main.9be5663bfe",
75
+ "@dxos/keyboard": "0.8.4-main.9be5663bfe",
76
+ "@dxos/plugin-client": "0.8.4-main.9be5663bfe",
77
+ "@dxos/react-client": "0.8.4-main.9be5663bfe",
78
+ "@dxos/plugin-space": "0.8.4-main.9be5663bfe",
79
+ "@dxos/util": "0.8.4-main.9be5663bfe",
80
+ "@dxos/plugin-graph": "0.8.4-main.9be5663bfe"
63
81
  },
64
82
  "devDependencies": {
65
- "@effect-atom/atom-react": "^0.4.6",
66
- "@effect/platform": "0.93.6",
83
+ "@effect-atom/atom-react": "^0.5.0",
84
+ "@effect/platform": "0.94.4",
67
85
  "@types/react": "~19.2.7",
68
86
  "@types/react-dom": "~19.2.3",
69
- "effect": "3.19.11",
87
+ "effect": "3.20.0",
70
88
  "react": "~19.2.3",
71
89
  "react-dom": "~19.2.3",
72
90
  "react-floater": "0.7.9",
73
91
  "type-fest": "4.10.1",
74
- "vite": "7.1.9",
75
- "@dxos/random": "0.8.4-main.9735255",
76
- "@dxos/react-ui": "0.8.4-main.9735255",
77
- "@dxos/plugin-testing": "0.8.4-main.9735255",
78
- "@dxos/storybook-utils": "0.8.4-main.9735255",
79
- "@dxos/ui-theme": "0.8.4-main.9735255"
92
+ "vite": "^7.1.11",
93
+ "@dxos/plugin-testing": "0.8.4-main.9be5663bfe",
94
+ "@dxos/react-ui": "0.8.4-main.9be5663bfe",
95
+ "@dxos/random": "0.8.4-main.9be5663bfe",
96
+ "@dxos/ui-theme": "0.8.4-main.9be5663bfe",
97
+ "@dxos/storybook-utils": "0.8.4-main.9be5663bfe"
80
98
  },
81
99
  "peerDependencies": {
82
- "@effect-atom/atom-react": "^0.4.6",
83
- "@effect/platform": "0.93.6",
84
- "effect": "3.19.11",
100
+ "@effect-atom/atom-react": "^0.5.0",
101
+ "@effect/platform": "0.94.4",
102
+ "effect": "3.20.0",
85
103
  "react": "~19.2.3",
86
104
  "react-dom": "~19.2.3",
87
- "@dxos/react-ui": "0.8.4-main.9735255",
88
- "@dxos/ui-theme": "0.8.4-main.9735255"
105
+ "@dxos/react-ui": "0.8.4-main.9be5663bfe",
106
+ "@dxos/ui-theme": "0.8.4-main.9be5663bfe"
89
107
  },
90
108
  "publishConfig": {
91
109
  "access": "public"
@@ -2,28 +2,30 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { Common, Plugin } from '@dxos/app-framework';
5
+ import { ActivationEvents, Plugin } from '@dxos/app-framework';
6
+ import { AppPlugin } from '@dxos/app-toolkit';
7
+
8
+ import { AppGraphBuilder, HelpState, OperationHandler, ReactRoot, ReactSurface } from '#capabilities';
9
+ import { meta } from '#meta';
10
+ import { type Step } from '#types';
6
11
 
7
- import { AppGraphBuilder, HelpState, OperationResolver, ReactRoot, ReactSurface } from './capabilities';
8
- import { meta } from './meta';
9
12
  import { translations } from './translations';
10
- import { type Step } from './types';
11
13
 
12
14
  export type HelpPluginOptions = { steps?: Step[] };
13
15
 
14
16
  export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
17
+ AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
18
+ AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
19
+ AppPlugin.addSurfaceModule({ activate: ReactSurface }),
20
+ AppPlugin.addTranslationsModule({ translations }),
15
21
  Plugin.addModule({
16
- activatesOn: Common.ActivationEvent.Startup,
22
+ activatesOn: ActivationEvents.Startup,
17
23
  activate: HelpState,
18
24
  }),
19
- Common.Plugin.addTranslationsModule({ translations }),
20
25
  Plugin.addModule(({ steps = [] }) => ({
21
26
  id: 'react-root',
22
- activatesOn: Common.ActivationEvent.Startup,
27
+ activatesOn: ActivationEvents.Startup,
23
28
  activate: () => ReactRoot(steps),
24
29
  })),
25
- Common.Plugin.addSurfaceModule({ activate: ReactSurface }),
26
- Common.Plugin.addOperationResolverModule({ activate: OperationResolver }),
27
- Common.Plugin.addAppGraphModule({ activate: AppGraphBuilder }),
28
30
  Plugin.make,
29
31
  );
@@ -4,29 +4,32 @@
4
4
 
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
- import { Capability, Common } from '@dxos/app-framework';
8
- import { GraphBuilder, NodeMatcher } from '@dxos/app-graph';
7
+ import { Capabilities, Capability } from '@dxos/app-framework';
8
+ import { GraphBuilder, Node, NodeMatcher } from '@dxos/app-graph';
9
+ import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
9
10
  import { Operation } from '@dxos/operation';
10
11
 
11
- import { SHORTCUTS_DIALOG } from '../../components';
12
- import { meta } from '../../meta';
13
- import { HelpCapabilities, HelpOperation } from '../../types';
12
+ import { meta } from '#meta';
13
+ import { HelpOperation } from '#operations';
14
+ import { HelpCapabilities } from '#types';
15
+
16
+ import { SHORTCUTS_DIALOG } from '../constants';
14
17
 
15
18
  export default Capability.makeModule(
16
19
  Effect.fnUntraced(function* () {
17
20
  const extensions = yield* GraphBuilder.createExtension({
18
- id: meta.id,
21
+ id: 'root',
19
22
  match: NodeMatcher.whenRoot,
20
23
  actions: () =>
21
24
  Effect.succeed([
22
- {
25
+ Node.makeAction({
23
26
  id: HelpOperation.Start.meta.key,
24
27
  data: Effect.fnUntraced(function* () {
25
- yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
28
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
26
29
  yield* Operation.invoke(HelpOperation.Start);
27
30
  }),
28
31
  properties: {
29
- label: ['open help tour', { ns: meta.id }],
32
+ label: ['open-help-tour.message', { ns: meta.id }],
30
33
  icon: 'ph--info--regular',
31
34
  keyBinding: {
32
35
  macos: 'shift+meta+/',
@@ -35,27 +38,26 @@ export default Capability.makeModule(
35
38
  },
36
39
  testId: 'helpPlugin.openHelp',
37
40
  },
38
- },
39
- {
40
- id: `${meta.id}/open-shortcuts`,
41
+ }),
42
+ Node.makeAction({
43
+ id: 'open-shortcuts',
41
44
  data: Effect.fnUntraced(function* () {
42
- yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
43
- yield* Operation.invoke(Common.LayoutOperation.UpdateDialog, {
45
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
46
+ yield* Operation.invoke(LayoutOperation.UpdateDialog, {
44
47
  subject: SHORTCUTS_DIALOG,
45
- blockAlign: 'center',
46
48
  });
47
49
  }),
48
50
  properties: {
49
- label: ['open shortcuts label', { ns: meta.id }],
51
+ label: ['open-shortcuts.label', { ns: meta.id }],
50
52
  icon: 'ph--keyboard--regular',
51
53
  keyBinding: {
52
54
  macos: 'meta+ctrl+/',
53
55
  },
54
56
  },
55
- },
57
+ }),
56
58
  ]),
57
59
  });
58
60
 
59
- return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);
61
+ return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
60
62
  }),
61
63
  );
@@ -2,8 +2,14 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- export * from './app-graph-builder';
6
- export * from './operation-resolver';
7
- export * from './react-root';
8
- export * from './react-surface';
9
- export * from './state';
5
+ import { Capability } from '@dxos/app-framework';
6
+ import { OperationHandlerSet } from '@dxos/operation';
7
+
8
+ export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
9
+ export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
10
+ 'OperationHandler',
11
+ () => import('./operation-handler'),
12
+ );
13
+ export const ReactRoot = Capability.lazy('ReactRoot', () => import('./react-root'));
14
+ export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));
15
+ export const HelpState = Capability.lazy('HelpState', () => import('./state'));
@@ -0,0 +1,16 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capabilities, Capability } from '@dxos/app-framework';
8
+ import type { OperationHandlerSet } from '@dxos/operation';
9
+
10
+ import { HelpOperationHandlerSet } from '#operations';
11
+
12
+ export default Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
13
+ Effect.fnUntraced(function* () {
14
+ return Capability.contributes(Capabilities.OperationHandler, HelpOperationHandlerSet);
15
+ }),
16
+ );
@@ -5,16 +5,16 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
  import React from 'react';
7
7
 
8
- import { Capability, Common } from '@dxos/app-framework';
9
- import { useAtomCapabilityState } from '@dxos/app-framework/react';
8
+ import { Capabilities, Capability } from '@dxos/app-framework';
9
+ import { useAtomCapabilityState } from '@dxos/app-framework/ui';
10
10
 
11
- import { WelcomeTour } from '../../components';
12
- import { meta } from '../../meta';
13
- import { HelpCapabilities, type Step } from '../../types';
11
+ import { WelcomeTour } from '#components';
12
+ import { meta } from '#meta';
13
+ import { HelpCapabilities, type Step } from '#types';
14
14
 
15
15
  export default Capability.makeModule(
16
16
  Effect.fnUntraced(function* (steps?: Step[]) {
17
- return Capability.contributes(Common.Capability.ReactRoot, {
17
+ return Capability.contributes(Capabilities.ReactRoot, {
18
18
  id: meta.id,
19
19
  root: () => {
20
20
  const [state, updateState] = useAtomCapabilityState(HelpCapabilities.State);
@@ -0,0 +1,37 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+ import React from 'react';
7
+
8
+ import { Capabilities, Capability } from '@dxos/app-framework';
9
+ import { Surface } from '@dxos/app-framework/ui';
10
+ import { AppSurface } from '@dxos/app-toolkit/ui';
11
+
12
+ import { ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '#containers';
13
+
14
+ import { SHORTCUTS_DIALOG } from '../constants';
15
+
16
+ export default Capability.makeModule(() =>
17
+ Effect.succeed(
18
+ Capability.contributes(Capabilities.ReactSurface, [
19
+ Surface.create({
20
+ id: 'hints',
21
+ role: 'hints',
22
+ component: () => <ShortcutsHints />,
23
+ }),
24
+ Surface.create({
25
+ id: 'keyshortcuts',
26
+ role: 'keyshortcuts',
27
+ component: () => <ShortcutsList />,
28
+ }),
29
+ Surface.create({
30
+ id: SHORTCUTS_DIALOG,
31
+ role: 'dialog',
32
+ filter: AppSurface.componentDialog(SHORTCUTS_DIALOG),
33
+ component: () => <ShortcutsDialogContent />,
34
+ }),
35
+ ]),
36
+ ),
37
+ );
@@ -7,8 +7,8 @@ import * as Effect from 'effect/Effect';
7
7
  import { Capability } from '@dxos/app-framework';
8
8
  import { createKvsStore } from '@dxos/effect';
9
9
 
10
- import { meta } from '../../meta';
11
- import { HelpCapabilities } from '../../types';
10
+ import { meta } from '#meta';
11
+ import { HelpCapabilities } from '#types';
12
12
 
13
13
  export default Capability.makeModule(() =>
14
14
  Effect.sync(() => {
@@ -27,7 +27,7 @@ export const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {
27
27
  const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));
28
28
 
29
29
  return (
30
- <div role='none' className='flex overflow-hidden pli-2 gap-4'>
30
+ <div role='none' className='flex overflow-hidden px-2 gap-4'>
31
31
  {hints.map((binding) => (
32
32
  <Shortcut key={binding.shortcut} binding={binding} />
33
33
  ))}
@@ -8,7 +8,7 @@ import { Keyboard } from '@dxos/keyboard';
8
8
  import { toLocalizedString, useTranslation } from '@dxos/react-ui';
9
9
  import { mx } from '@dxos/ui-theme';
10
10
 
11
- import { meta } from '../../meta';
11
+ import { meta } from '#meta';
12
12
 
13
13
  import { Key } from './Key';
14
14
 
@@ -22,11 +22,11 @@ export const ShortcutsList = () => {
22
22
  });
23
23
 
24
24
  return (
25
- <dl className={mx('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued select-none')}>
25
+ <dl className={mx('w-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 my-4 text-subdued select-none')}>
26
26
  {bindings.map((binding, i) => (
27
27
  <Fragment key={i}>
28
28
  <Key binding={binding.shortcut} />
29
- <span role='definition' className='mis-4' aria-labelledby={binding.shortcut}>
29
+ <span role='definition' className='ms-4' aria-labelledby={binding.shortcut}>
30
30
  {toLocalizedString(binding.data, t)}
31
31
  </span>
32
32
  </Fragment>
@@ -4,13 +4,11 @@
4
4
 
5
5
  import React from 'react';
6
6
 
7
- import { descriptionText } from '@dxos/ui-theme';
8
-
9
7
  import { ShortcutsList } from './ShortcutsList';
10
8
 
11
9
  export const ShortcutsSection = () => {
12
10
  return (
13
- <section className={descriptionText}>
11
+ <section className='text-description'>
14
12
  <ShortcutsList />
15
13
  </section>
16
14
  );
@@ -2,7 +2,6 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- export * from './ShortcutsDialog';
6
5
  export * from './ShortcutsHints';
7
6
  export * from './ShortcutsList';
8
7
  export * from './ShortcutsSection';
@@ -5,6 +5,6 @@
5
5
  import { mx } from '@dxos/ui-theme';
6
6
 
7
7
  export const shortcutKey = mx(
8
- 'inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs',
9
- 'rounded bg-neutral-100 dark:bg-neutral-900',
8
+ 'inline-flex min-w-[24px] h-[24px] px-0.5 justify-center items-center text-xs',
9
+ 'rounded-sm bg-neutral-100 dark:bg-neutral-900',
10
10
  );
@@ -38,7 +38,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
38
38
 
39
39
  return (
40
40
  <div
41
- className='flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-accentSurfaceText'
41
+ className='flex flex-col w-[15rem] min-h-[10rem] overflow-hidden rounded-md shadow-xl bg-accent-surface text-accent-surface-text'
42
42
  role='tooltip'
43
43
  data-testid='helpPlugin.tooltip'
44
44
  data-step={index + 1}
@@ -46,7 +46,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
46
46
  ref={forwardedRef}
47
47
  >
48
48
  <div className='flex p-2'>
49
- <h2 className='grow pli-2 plb-1 text-lg font-medium text-accentSurfaceText'>{title}</h2>
49
+ <h2 className='grow px-2 py-1 text-lg font-medium text-accent-surface-text'>{title}</h2>
50
50
  <IconButton
51
51
  density='fine'
52
52
  icon='ph--x--bold'
@@ -58,7 +58,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
58
58
  data-testid='helpPlugin.tooltip.close'
59
59
  />
60
60
  </div>
61
- <div className='flex grow pli-4 mlb-2'>{content}</div>
61
+ <div className='flex grow px-4 my-2'>{content}</div>
62
62
  <div className='flex p-2 items-center justify-between' {...arrowNavigationAttrs}>
63
63
  {
64
64
  <IconButton
@@ -78,7 +78,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
78
78
  key={i}
79
79
  icon={index === i ? 'ph--circle--fill' : 'ph--circle--regular'}
80
80
  size={2}
81
- classNames='mli-1 cursor-pointer'
81
+ classNames='mx-1 cursor-pointer'
82
82
  />
83
83
  ))}
84
84
  </div>
@@ -7,24 +7,24 @@ import React, { useState } from 'react';
7
7
 
8
8
  import { withPluginManager } from '@dxos/app-framework/testing';
9
9
  import { StorybookPlugin } from '@dxos/plugin-testing';
10
- import { faker } from '@dxos/random';
10
+ import { random } from '@dxos/random';
11
11
  import { Button, Icon } from '@dxos/react-ui';
12
12
  import { withTheme } from '@dxos/react-ui/testing';
13
13
 
14
- import { useHelp } from '../../hooks';
14
+ import { useHelp } from '#hooks';
15
15
 
16
16
  import { WelcomeTour, type WelcomeTourProps } from './WelcomeTour';
17
17
 
18
18
  const App = () => {
19
19
  const { running, start } = useHelp();
20
- const [items, setItems] = useState(() => Array.from({ length: 5 }).map(() => faker.lorem.sentence()));
20
+ const [items, setItems] = useState(() => Array.from({ length: 5 }).map(() => random.lorem.sentence()));
21
21
  const handleAdd = () => {
22
- setItems((items) => [...items, faker.lorem.sentence()]);
22
+ setItems((items) => [...items, random.lorem.sentence()]);
23
23
  };
24
24
 
25
25
  return (
26
- <div className='flex flex-col bs-full p-4 space-y-8'>
27
- <div className='flex items-center gap-2 plb-2'>
26
+ <div className='flex flex-col h-full p-4 space-y-8'>
27
+ <div className='flex items-center gap-2 py-2'>
28
28
  <Button data-joyride='basic/1' onClick={() => start()}>
29
29
  Start
30
30
  </Button>
@@ -41,13 +41,13 @@ const App = () => {
41
41
  ))}
42
42
  </ul>
43
43
  </div>
44
- <div className='flex items-center gap-2 plb-2'>
44
+ <div className='flex items-center gap-2 py-2'>
45
45
  <Button data-joyride='basic/3' onClick={handleAdd}>
46
46
  Add
47
47
  </Button>
48
48
  </div>
49
49
  <div className='flex grow' />
50
- <div className='flex items-center plb-2'>
50
+ <div className='flex items-center py-2'>
51
51
  <div className='grow' />
52
52
  <Icon icon='ph--circle--regular' data-joyride='basic/4' />
53
53
  <Icon icon='ph--circle--regular' />
@@ -76,25 +76,25 @@ export const Default: StoryObj<typeof WelcomeTour> = {
76
76
  {
77
77
  target: '[data-joyride="basic/1"]',
78
78
  title: 'plugins/Step 1',
79
- content: faker.lorem.paragraph(),
79
+ content: random.lorem.paragraph(),
80
80
  disableBeacon: true,
81
81
  placement: 'right',
82
82
  },
83
83
  {
84
84
  target: '[data-joyride="basic/2"]',
85
85
  title: 'plugins/Step 2',
86
- content: faker.lorem.paragraph(),
86
+ content: random.lorem.paragraph(),
87
87
  },
88
88
  {
89
89
  target: '[data-joyride="basic/3"]',
90
90
  title: 'plugins/Step 3',
91
- content: faker.lorem.paragraph(),
91
+ content: random.lorem.paragraph(),
92
92
  placement: 'right',
93
93
  },
94
94
  {
95
95
  target: '[data-joyride="basic/4"]',
96
96
  title: 'plugins/Step 4',
97
- content: faker.lorem.paragraph(),
97
+ content: random.lorem.paragraph(),
98
98
  placement: 'top-end',
99
99
  },
100
100
  ],
@@ -105,11 +105,11 @@ export const Default: StoryObj<typeof WelcomeTour> = {
105
105
  * IMPORTANT: Run in separate tab.
106
106
  */
107
107
  const meta = {
108
- title: 'plugins/plugin-help/WelcomeTour',
108
+ title: 'plugins/plugin-help/components/WelcomeTour',
109
109
  component: WelcomeTour,
110
110
  render: DefaultStory,
111
111
  decorators: [
112
- withTheme,
112
+ withTheme(),
113
113
  withPluginManager({
114
114
  plugins: [StorybookPlugin({})],
115
115
  }),
@@ -5,10 +5,12 @@
5
5
  import React, { useState } from 'react';
6
6
  import Joyride, { ACTIONS, EVENTS } from 'react-joyride';
7
7
 
8
- import { useLayout, usePluginManager } from '@dxos/app-framework/react';
8
+ import { usePluginManager } from '@dxos/app-framework/ui';
9
+ import { useLayout } from '@dxos/app-toolkit/ui';
9
10
  import { useAsyncEffect } from '@dxos/react-ui';
10
11
 
11
- import { HelpContext, type Step } from '../../types';
12
+ import { HelpContext, type Step } from '#types';
13
+
12
14
  import { Tooltip, floaterProps } from '../Tooltip';
13
15
 
14
16
  const addStepClass = (target: string | HTMLElement) => {
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { meta } from '#meta';
6
+
7
+ export const SHORTCUTS_DIALOG = `${meta.id}.ShortcutsDialog`;
@@ -0,0 +1,38 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
6
+ import React from 'react';
7
+
8
+ import { withPluginManager } from '@dxos/app-framework/testing';
9
+ import { Dialog } from '@dxos/react-ui';
10
+ import { withTheme } from '@dxos/react-ui/testing';
11
+
12
+ import { translations } from '../../translations';
13
+ import { ShortcutsDialogContent } from './ShortcutsDialogContent';
14
+
15
+ const DefaultStory = () => (
16
+ <Dialog.Root defaultOpen>
17
+ <Dialog.Overlay>
18
+ <ShortcutsDialogContent />
19
+ </Dialog.Overlay>
20
+ </Dialog.Root>
21
+ );
22
+
23
+ const meta = {
24
+ title: 'plugins/plugin-help/containers/ShortcutsDialogContent',
25
+ component: ShortcutsDialogContent,
26
+ render: DefaultStory,
27
+ decorators: [withTheme(), withPluginManager()],
28
+ parameters: {
29
+ layout: 'fullscreen',
30
+ translations,
31
+ },
32
+ } satisfies Meta<typeof ShortcutsDialogContent>;
33
+
34
+ export default meta;
35
+
36
+ type Story = StoryObj<typeof meta>;
37
+
38
+ export const Default: Story = {};
@@ -0,0 +1,28 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import React from 'react';
6
+
7
+ import { Dialog, useTranslation } from '@dxos/react-ui';
8
+
9
+ import { ShortcutsList } from '#components';
10
+ import { meta } from '#meta';
11
+
12
+ export const ShortcutsDialogContent = () => {
13
+ const { t } = useTranslation(meta.id);
14
+
15
+ return (
16
+ <Dialog.Content>
17
+ <Dialog.Header>
18
+ <Dialog.Title>{t('shortcuts-dialog.title')}</Dialog.Title>
19
+ <Dialog.Close asChild>
20
+ <Dialog.CloseIconButton />
21
+ </Dialog.Close>
22
+ </Dialog.Header>
23
+ <Dialog.Body>
24
+ <ShortcutsList />
25
+ </Dialog.Body>
26
+ </Dialog.Content>
27
+ );
28
+ };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ export { ShortcutsDialogContent as default } from './ShortcutsDialogContent';