@dxos/plugin-help 0.7.4 → 0.7.5-main.9d26e3a
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/chunk-RHSC3EWO.mjs +36 -0
- package/dist/lib/browser/chunk-RHSC3EWO.mjs.map +7 -0
- package/dist/lib/browser/chunk-STC3ORFI.mjs +13 -0
- package/dist/lib/browser/{chunk-2EMBCGD5.mjs.map → chunk-STC3ORFI.mjs.map} +3 -3
- package/dist/lib/browser/index.mjs +36 -51
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/meta.mjs +1 -3
- package/dist/lib/browser/types.mjs +12 -0
- package/dist/lib/browser/types.mjs.map +7 -0
- package/dist/types/src/HelpPlugin.d.ts.map +1 -1
- package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts +1 -0
- package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +1 -1
- package/dist/types/src/meta.d.ts +0 -3
- package/dist/types/src/meta.d.ts.map +1 -1
- package/dist/types/src/types.d.ts +13 -0
- package/dist/types/src/types.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -0
- package/package.json +25 -18
- package/src/HelpPlugin.tsx +46 -39
- package/src/components/Shortcuts/ShortcutsDialog.tsx +2 -0
- package/src/meta.ts +0 -5
- package/src/types.ts +11 -0
- package/dist/lib/browser/chunk-2EMBCGD5.mjs +0 -19
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import {
|
|
2
|
+
HELP_PLUGIN
|
|
3
|
+
} from "./chunk-STC3ORFI.mjs";
|
|
4
|
+
|
|
5
|
+
// packages/plugins/plugin-help/src/types.ts
|
|
6
|
+
import { createContext } from "react";
|
|
7
|
+
import { S } from "@dxos/echo-schema";
|
|
8
|
+
var HelpContext = createContext({
|
|
9
|
+
running: false,
|
|
10
|
+
steps: [],
|
|
11
|
+
setSteps: () => {
|
|
12
|
+
},
|
|
13
|
+
setIndex: () => {
|
|
14
|
+
},
|
|
15
|
+
start: () => {
|
|
16
|
+
},
|
|
17
|
+
stop: () => {
|
|
18
|
+
}
|
|
19
|
+
});
|
|
20
|
+
var HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
21
|
+
var HelpAction;
|
|
22
|
+
(function(HelpAction2) {
|
|
23
|
+
class Start extends S.TaggedClass()(`${HELP_ACTION}/start`, {
|
|
24
|
+
input: S.Void,
|
|
25
|
+
output: S.Void
|
|
26
|
+
}) {
|
|
27
|
+
}
|
|
28
|
+
HelpAction2.Start = Start;
|
|
29
|
+
})(HelpAction || (HelpAction = {}));
|
|
30
|
+
|
|
31
|
+
export {
|
|
32
|
+
HelpContext,
|
|
33
|
+
HELP_ACTION,
|
|
34
|
+
HelpAction
|
|
35
|
+
};
|
|
36
|
+
//# sourceMappingURL=chunk-RHSC3EWO.mjs.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../src/types.ts"],
|
|
4
|
+
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport {\n type Plugin,\n type GraphBuilderProvides,\n type IntentResolverProvides,\n type SurfaceProvides,\n type TranslationsProvides,\n} from '@dxos/app-framework';\nimport { S } from '@dxos/echo-schema';\n\nimport { HELP_PLUGIN } from './meta';\n\nexport type Step = BaseStep & {\n before?: (context: { plugins: Plugin[]; step: Step }) => void;\n};\n\nexport type HelpContextType = {\n running: boolean;\n steps: Step[];\n setSteps: (steps: Step[]) => void;\n setIndex: (index: number) => void;\n start: () => void;\n stop: () => void;\n};\n\nexport const HelpContext: Context<HelpContextType> = createContext<HelpContextType>({\n running: false,\n steps: [],\n setSteps: () => {},\n setIndex: () => {},\n start: () => {},\n stop: () => {},\n});\n\nexport type HelpPluginProvides = GraphBuilderProvides & IntentResolverProvides & SurfaceProvides & TranslationsProvides;\n\nexport const HELP_ACTION = `${HELP_PLUGIN}/action`;\nexport namespace HelpAction {\n export class Start extends S.TaggedClass<Start>()(`${HELP_ACTION}/start`, {\n input: S.Void,\n output: S.Void,\n }) {}\n}\n"],
|
|
5
|
+
"mappings": ";;;;;AAIA,SAAuBA,qBAAqB;AAU5C,SAASC,SAAS;AAiBX,IAAMC,cAAwCC,cAA+B;EAClFC,SAAS;EACTC,OAAO,CAAA;EACPC,UAAU,MAAA;EAAO;EACjBC,UAAU,MAAA;EAAO;EACjBC,OAAO,MAAA;EAAO;EACdC,MAAM,MAAA;EAAO;AACf,CAAA;AAIO,IAAMC,cAAc,GAAGC,WAAAA;;UACbC,aAAAA;EACR,MAAMC,cAAcC,EAAEC,YAAW,EAAU,GAAGL,WAAAA,UAAqB;IACxEM,OAAOF,EAAEG;IACTC,QAAQJ,EAAEG;EACZ,CAAA,EAAA;EAAI;cAHSJ,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;",
|
|
6
|
+
"names": ["createContext", "S", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_ACTION", "HELP_PLUGIN", "HelpAction", "Start", "S", "TaggedClass", "input", "Void", "output"]
|
|
7
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// packages/plugins/plugin-help/src/meta.ts
|
|
2
|
+
var HELP_PLUGIN = "dxos.org/plugin/help";
|
|
3
|
+
var meta_default = {
|
|
4
|
+
id: HELP_PLUGIN,
|
|
5
|
+
name: "Help",
|
|
6
|
+
icon: "ph--info--regular"
|
|
7
|
+
};
|
|
8
|
+
|
|
9
|
+
export {
|
|
10
|
+
HELP_PLUGIN,
|
|
11
|
+
meta_default
|
|
12
|
+
};
|
|
13
|
+
//# sourceMappingURL=chunk-STC3ORFI.mjs.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/meta.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\n// TODO(burdon): Rename Guide? Help?\nexport const HELP_PLUGIN = 'dxos.org/plugin/help';\n\nexport default {\n id: HELP_PLUGIN,\n name: 'Help',\n icon: 'ph--info--regular',\n} satisfies PluginMeta;\n
|
|
5
|
-
"mappings": ";AAOO,IAAMA,cAAc;AAE3B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;EACNC,MAAM;AACR;
|
|
6
|
-
"names": ["HELP_PLUGIN", "id", "name", "icon"
|
|
4
|
+
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\n// TODO(burdon): Rename Guide? Help?\nexport const HELP_PLUGIN = 'dxos.org/plugin/help';\n\nexport default {\n id: HELP_PLUGIN,\n name: 'Help',\n icon: 'ph--info--regular',\n} satisfies PluginMeta;\n"],
|
|
5
|
+
"mappings": ";AAOO,IAAMA,cAAc;AAE3B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;EACNC,MAAM;AACR;",
|
|
6
|
+
"names": ["HELP_PLUGIN", "id", "name", "icon"]
|
|
7
7
|
}
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import {
|
|
2
|
-
HELP_PLUGIN,
|
|
3
2
|
HelpAction,
|
|
3
|
+
HelpContext
|
|
4
|
+
} from "./chunk-RHSC3EWO.mjs";
|
|
5
|
+
import {
|
|
6
|
+
HELP_PLUGIN,
|
|
4
7
|
meta_default
|
|
5
|
-
} from "./chunk-
|
|
8
|
+
} from "./chunk-STC3ORFI.mjs";
|
|
6
9
|
|
|
7
10
|
// packages/plugins/plugin-help/src/HelpPlugin.tsx
|
|
8
11
|
import React8 from "react";
|
|
9
|
-
import { resolvePlugin as resolvePlugin2, parseIntentPlugin, LayoutAction } from "@dxos/app-framework";
|
|
12
|
+
import { resolvePlugin as resolvePlugin2, parseIntentPlugin, LayoutAction, createSurface, createResolver, createIntent } from "@dxos/app-framework";
|
|
10
13
|
import { createExtension } from "@dxos/app-graph";
|
|
11
14
|
import { create } from "@dxos/live-object";
|
|
12
15
|
import { LocalStorageStore } from "@dxos/local-storage";
|
|
@@ -16,21 +19,6 @@ import React2, { useState, useEffect } from "react";
|
|
|
16
19
|
import Joyride, { ACTIONS, EVENTS } from "react-joyride";
|
|
17
20
|
import { usePlugins, resolvePlugin, parseLayoutPlugin } from "@dxos/app-framework";
|
|
18
21
|
|
|
19
|
-
// packages/plugins/plugin-help/src/types.ts
|
|
20
|
-
import { createContext } from "react";
|
|
21
|
-
var HelpContext = createContext({
|
|
22
|
-
running: false,
|
|
23
|
-
steps: [],
|
|
24
|
-
setSteps: () => {
|
|
25
|
-
},
|
|
26
|
-
setIndex: () => {
|
|
27
|
-
},
|
|
28
|
-
start: () => {
|
|
29
|
-
},
|
|
30
|
-
stop: () => {
|
|
31
|
-
}
|
|
32
|
-
});
|
|
33
|
-
|
|
34
22
|
// packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx
|
|
35
23
|
import { useArrowNavigationGroup, useFocusableGroup } from "@fluentui/react-tabster";
|
|
36
24
|
import { CaretLeft, CaretRight, Circle, X } from "@phosphor-icons/react";
|
|
@@ -307,6 +295,7 @@ var ShortcutsList = () => {
|
|
|
307
295
|
};
|
|
308
296
|
|
|
309
297
|
// packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx
|
|
298
|
+
var SHORTCUTS_DIALOG = `${HELP_PLUGIN}/ShortcutsDialog`;
|
|
310
299
|
var ShortcutsDialogContent = () => {
|
|
311
300
|
const { t } = useTranslation2(HELP_PLUGIN);
|
|
312
301
|
return /* @__PURE__ */ React5.createElement(Dialog.Content, {
|
|
@@ -430,19 +419,16 @@ var HelpPlugin = ({ steps = [] }) => {
|
|
|
430
419
|
translations: translations_default,
|
|
431
420
|
graph: {
|
|
432
421
|
builder: (plugins) => {
|
|
433
|
-
const
|
|
422
|
+
const dispatch = resolvePlugin2(plugins, parseIntentPlugin)?.provides.intent.dispatchPromise;
|
|
434
423
|
return createExtension({
|
|
435
424
|
id: HELP_PLUGIN,
|
|
436
425
|
filter: (node) => node.id === "root",
|
|
437
426
|
actions: () => [
|
|
438
427
|
{
|
|
439
|
-
id: HelpAction.
|
|
428
|
+
id: HelpAction.Start._tag,
|
|
440
429
|
data: async () => {
|
|
441
430
|
settings.values.showHints = true;
|
|
442
|
-
await
|
|
443
|
-
plugin: HELP_PLUGIN,
|
|
444
|
-
action: HelpAction.START
|
|
445
|
-
});
|
|
431
|
+
await dispatch?.(createIntent(HelpAction.Start));
|
|
446
432
|
},
|
|
447
433
|
properties: {
|
|
448
434
|
label: [
|
|
@@ -465,13 +451,10 @@ var HelpPlugin = ({ steps = [] }) => {
|
|
|
465
451
|
id: "dxos.org/plugin/help/open-shortcuts",
|
|
466
452
|
data: async () => {
|
|
467
453
|
settings.values.showHints = true;
|
|
468
|
-
await
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
component: `${HELP_PLUGIN}/Shortcuts`
|
|
473
|
-
}
|
|
474
|
-
});
|
|
454
|
+
await dispatch?.(createIntent(LayoutAction.SetLayout, {
|
|
455
|
+
element: "dialog",
|
|
456
|
+
component: SHORTCUTS_DIALOG
|
|
457
|
+
}));
|
|
475
458
|
},
|
|
476
459
|
properties: {
|
|
477
460
|
label: [
|
|
@@ -491,28 +474,29 @@ var HelpPlugin = ({ steps = [] }) => {
|
|
|
491
474
|
}
|
|
492
475
|
},
|
|
493
476
|
surface: {
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
}
|
|
505
|
-
|
|
506
|
-
|
|
477
|
+
definitions: () => [
|
|
478
|
+
createSurface({
|
|
479
|
+
id: `${HELP_PLUGIN}/hints`,
|
|
480
|
+
role: "hints",
|
|
481
|
+
component: () => /* @__PURE__ */ React8.createElement(ShortcutsHints, null)
|
|
482
|
+
}),
|
|
483
|
+
createSurface({
|
|
484
|
+
id: `${HELP_PLUGIN}/keyshortcuts`,
|
|
485
|
+
role: "keyshortcuts",
|
|
486
|
+
component: () => /* @__PURE__ */ React8.createElement(ShortcutsList, null)
|
|
487
|
+
}),
|
|
488
|
+
createSurface({
|
|
489
|
+
id: SHORTCUTS_DIALOG,
|
|
490
|
+
role: "dialog",
|
|
491
|
+
filter: (data) => data.component === SHORTCUTS_DIALOG,
|
|
492
|
+
component: () => /* @__PURE__ */ React8.createElement(ShortcutsDialogContent, null)
|
|
493
|
+
})
|
|
494
|
+
]
|
|
507
495
|
},
|
|
508
496
|
intent: {
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
state.running = true;
|
|
513
|
-
break;
|
|
514
|
-
}
|
|
515
|
-
}
|
|
497
|
+
resolvers: () => createResolver(HelpAction.Start, () => {
|
|
498
|
+
state.running = true;
|
|
499
|
+
})
|
|
516
500
|
}
|
|
517
501
|
}
|
|
518
502
|
};
|
|
@@ -531,6 +515,7 @@ export {
|
|
|
531
515
|
HelpContextProvider,
|
|
532
516
|
HelpPlugin,
|
|
533
517
|
Key,
|
|
518
|
+
SHORTCUTS_DIALOG,
|
|
534
519
|
ShortcutsDialogContent,
|
|
535
520
|
ShortcutsHints,
|
|
536
521
|
ShortcutsList,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
|
-
"sources": ["../../../src/HelpPlugin.tsx", "../../../src/components/HelpContextProvider/HelpContextProvider.tsx", "../../../src/
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { resolvePlugin, type PluginDefinition, parseIntentPlugin, LayoutAction } from '@dxos/app-framework';\nimport { createExtension, type Node } from '@dxos/app-graph';\nimport { create } from '@dxos/live-object';\nimport { LocalStorageStore } from '@dxos/local-storage';\n\nimport { HelpContextProvider, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from './components';\nimport meta, { HelpAction, HELP_PLUGIN } from './meta';\nimport translations from './translations';\nimport { type Step, type HelpPluginProvides } from './types';\n\nexport type HelpSettingsProps = { showHints?: boolean; showWelcome?: boolean };\n\nexport type HelpPluginOptions = { steps?: Step[] };\n\nexport const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<HelpPluginProvides> => {\n const settings = new LocalStorageStore<HelpSettingsProps>(HELP_PLUGIN, { showHints: true, showWelcome: true });\n const state = create<{ running: boolean }>({ running: false });\n return {\n meta,\n ready: async () => {\n settings\n .prop({ key: 'showHints', type: LocalStorageStore.bool({ allowUndefined: true }) })\n .prop({ key: 'showWelcome', type: LocalStorageStore.bool({ allowUndefined: true }) });\n },\n provides: {\n context: ({ children }) => {\n return (\n <HelpContextProvider\n steps={steps}\n running={state.running}\n onRunningChanged={(newState) => {\n state.running = newState;\n if (!newState) {\n settings.values.showHints = false;\n }\n }}\n >\n {children}\n </HelpContextProvider>\n );\n },\n translations,\n graph: {\n builder: (plugins) => {\n const intentPlugin = resolvePlugin(plugins, parseIntentPlugin)!;\n\n return createExtension({\n id: HELP_PLUGIN,\n filter: (node): node is Node<null> => node.id === 'root',\n actions: () => [\n {\n id: HelpAction.START,\n data: async () => {\n settings.values.showHints = true;\n await intentPlugin?.provides.intent.dispatch({\n plugin: HELP_PLUGIN,\n action: HelpAction.START,\n });\n },\n properties: {\n label: ['open help tour', { ns: HELP_PLUGIN }],\n icon: 'ph--info--regular',\n keyBinding: {\n macos: 'shift+meta+/',\n // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n windows: 'shift+ctrl+/',\n linux: 'shift+ctrl+?',\n },\n testId: 'helpPlugin.openHelp',\n },\n },\n {\n id: 'dxos.org/plugin/help/open-shortcuts',\n data: async () => {\n settings.values.showHints = true;\n await intentPlugin?.provides.intent.dispatch({\n action: LayoutAction.SET_LAYOUT,\n data: {\n element: 'dialog',\n component: `${HELP_PLUGIN}/Shortcuts`,\n },\n });\n },\n properties: {\n label: ['open shortcuts label', { ns: HELP_PLUGIN }],\n icon: 'ph--keyboard--regular',\n keyBinding: {\n macos: 'meta+ctrl+/',\n },\n },\n },\n ],\n });\n },\n },\n surface: {\n component: ({ data, role }) => {\n switch (role) {\n case 'hints':\n return <ShortcutsHints />;\n case 'keyshortcuts':\n return <ShortcutsList />;\n }\n\n switch (data.component) {\n case `${HELP_PLUGIN}/Shortcuts`:\n return <ShortcutsDialogContent />;\n }\n\n return null;\n },\n },\n intent: {\n resolver: async (intent) => {\n switch (intent.action) {\n case HelpAction.START:\n state.running = true;\n break;\n }\n },\n },\n },\n };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { type PropsWithChildren, useState, useEffect } from 'react';\nimport Joyride, { ACTIONS, EVENTS } from 'react-joyride';\n\nimport { usePlugins, resolvePlugin, parseLayoutPlugin } from '@dxos/app-framework';\n\nimport { type Step, HelpContext } from '../../types';\nimport { floaterProps, Tooltip } from '../Tooltip';\n\nconst addStepClass = (target: string | HTMLElement) => {\n const element = typeof target === 'string' ? document.querySelector(target) : target;\n if (element) {\n element.classList.add('joyride-target');\n }\n};\n\nconst removeTargetClass = (target: string | HTMLElement) => {\n const element = typeof target === 'string' ? document.querySelector(target) : target;\n if (element) {\n element.classList.remove('joyride-target');\n }\n};\n\nconst getTarget = (step: Step) => {\n return typeof step.target === 'string' ? document.querySelector(step.target) : step.target;\n};\n\n/**\n * Wait for the target element to be in the document.\n */\nconst waitForTarget = async (step: Step) => {\n if (typeof step.target === 'string') {\n const target = step.target;\n const element = document.querySelector(target);\n if (element) {\n return;\n }\n\n await new Promise<void>((resolve) => {\n const observer = new MutationObserver((mutations) => {\n mutations.forEach((mutation) => {\n if (mutation.addedNodes.length > 0) {\n const element = document.querySelector(target);\n if (element) {\n observer.disconnect();\n resolve();\n }\n }\n });\n });\n\n observer.observe(document.body, { childList: true, subtree: true });\n });\n }\n};\n\nexport type HelpContextProviderProps = PropsWithChildren<{\n steps: Step[];\n running?: boolean;\n onRunningChanged?: (state: boolean) => any;\n}>;\n\nexport const HelpContextProvider = ({\n children,\n steps: initialSteps,\n running: runningProp,\n onRunningChanged,\n}: HelpContextProviderProps) => {\n const { plugins } = usePlugins();\n const layoutPlugin = resolvePlugin(plugins, parseLayoutPlugin);\n const [running, setRunning] = useState(!!runningProp && !!getTarget(initialSteps[0]));\n const [stepIndex, _setStepIndex] = useState(0);\n const [steps, setSteps] = useState(initialSteps);\n\n const paused = layoutPlugin?.provides.layout.dialogOpen;\n\n const setStepIndex = (index: number) => {\n if (runningProp) {\n const step = steps[index];\n step?.before?.({ plugins, step });\n }\n _setStepIndex(index);\n };\n\n const setRunningChanged = (state: boolean) => {\n if (typeof runningProp !== 'undefined') {\n onRunningChanged?.(state);\n } else {\n if (state) {\n setStepIndex(0);\n setRunning(true);\n } else {\n setRunning(false);\n }\n }\n };\n\n useEffect(() => {\n const timeout = setTimeout(async () => {\n if (runningProp) {\n // This handles the case when the target is not yet in the document.\n // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.\n await waitForTarget(steps[stepIndex]);\n setStepIndex(0);\n setRunning(true);\n } else if (typeof runningProp !== 'undefined') {\n setRunning(false);\n }\n });\n\n return () => clearTimeout(timeout);\n }, [runningProp]);\n\n // https://docs.react-joyride.com/callback\n const callback: Joyride['callback'] = async (options) => {\n const { type, action, index, size } = options;\n switch (type) {\n case EVENTS.STEP_BEFORE:\n addStepClass(options.step.target);\n break;\n case EVENTS.TOUR_END:\n break;\n case EVENTS.STEP_AFTER:\n removeTargetClass(options.step.target);\n switch (action) {\n case ACTIONS.NEXT:\n if (index < size - 1) {\n setStepIndex(index + 1);\n }\n break;\n case ACTIONS.PREV:\n if (index > 0) {\n setStepIndex(index - 1);\n }\n break;\n case ACTIONS.CLOSE:\n setRunningChanged(false);\n setStepIndex(0);\n break;\n }\n break;\n }\n };\n\n return (\n <HelpContext.Provider\n value={{\n running: running && !paused,\n steps,\n setSteps,\n setIndex: setStepIndex,\n start: () => setRunningChanged(true),\n stop: () => setRunningChanged(false),\n }}\n >\n <style>\n {`.joyride-target {\n --controls-opacity: 1;\n }`}\n </style>\n <Joyride\n continuous={true}\n steps={steps}\n stepIndex={stepIndex}\n run={running && !paused}\n callback={callback}\n floaterProps={floaterProps}\n tooltipComponent={Tooltip}\n />\n {children}\n </HelpContext.Provider>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport {\n type Plugin,\n type GraphBuilderProvides,\n type IntentResolverProvides,\n type SurfaceProvides,\n type TranslationsProvides,\n} from '@dxos/app-framework';\n\nexport type Step = BaseStep & {\n before?: (context: { plugins: Plugin[]; step: Step }) => void;\n};\n\nexport type HelpContextType = {\n running: boolean;\n steps: Step[];\n setSteps: (steps: Step[]) => void;\n setIndex: (index: number) => void;\n start: () => void;\n stop: () => void;\n};\n\nexport const HelpContext: Context<HelpContextType> = createContext<HelpContextType>({\n running: false,\n steps: [],\n setSteps: () => {},\n setIndex: () => {},\n start: () => {},\n stop: () => {},\n});\n\nexport type HelpPluginProvides = GraphBuilderProvides & IntentResolverProvides & SurfaceProvides & TranslationsProvides;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useArrowNavigationGroup, useFocusableGroup } from '@fluentui/react-tabster';\nimport { CaretLeft, CaretRight, Circle, X } from '@phosphor-icons/react';\nimport React, { forwardRef } from 'react';\n// TODO(thure): This needed to be imported in the package.json specifically to pacify TS2742. See if this is resolved with typescript@5.5.x.\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport _floater from 'react-floater';\nimport { type TooltipRenderProps, type Props } from 'react-joyride';\n// TODO(thure): This needed to be imported in the package.json specifically to pacify TS2742. See if this is resolved with typescript@5.5.x.\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport _typefest from 'type-fest';\n\nimport { Button } from '@dxos/react-ui';\nimport { getSize, mx } from '@dxos/react-ui-theme';\n\n// https://docs.react-joyride.com/styling\n// https://github.com/gilbarbara/react-floater\nexport const floaterProps: Props['floaterProps'] = {\n styles: {\n // Arrow color is set by joyride.\n arrow: {\n length: 8,\n spread: 16,\n },\n floater: {\n // TODO(burdon): Get tokens from theme.\n filter: 'drop-shadow(0 0 0.75rem rgba(0, 0, 0, 0.2))',\n },\n },\n};\n\n// TODO(burdon): Add info link to docs.\nexport const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(\n ({ step: { title, content }, index, size, isLastStep, backProps, closeProps, primaryProps }, forwardedRef) => {\n const arrowGroup = useArrowNavigationGroup({ axis: 'horizontal' });\n const trapFocus = useFocusableGroup({ tabBehavior: 'limited-trap-focus' });\n\n return (\n <div\n className='flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-inverse'\n role='tooltip'\n data-testid='helpPlugin.tooltip'\n data-step={index + 1}\n {...trapFocus}\n ref={forwardedRef}\n >\n <div className='flex p-2'>\n <h2 className='grow pli-2 plb-1 text-lg font-medium text-inverse'>{title}</h2>\n <Button\n density='fine'\n variant='primary'\n onClick={closeProps.onClick}\n title={closeProps['aria-label']}\n data-testid='helpPlugin.tooltip.close'\n >\n <X weight='bold' className={getSize(4)} />\n </Button>\n </div>\n <div className='flex grow pli-4 mlb-2'>{content}</div>\n <div className='flex p-2 items-center justify-between' {...arrowGroup}>\n {\n <Button\n variant='primary'\n onClick={backProps.onClick}\n title={backProps['aria-label']}\n classNames={[!(index > 0 && backProps) && 'invisible']}\n data-testid='helpPlugin.tooltip.back'\n >\n <CaretLeft className={getSize(5)} />\n </Button>\n }\n <div className='flex grow gap-2 justify-center'>\n <div className='flex'>\n {Array.from({ length: size }).map((_, i) => (\n <Circle\n key={i}\n weight={index === i ? 'fill' : 'regular'}\n className={mx(getSize(2), 'mli-1 cursor-pointer')}\n />\n ))}\n </div>\n </div>\n {isLastStep ? (\n <Button\n variant='primary'\n onClick={closeProps.onClick}\n title={closeProps['aria-label']}\n autoFocus\n data-testid='helpPlugin.tooltip.finish'\n >\n Done\n </Button>\n ) : (\n <Button\n variant='primary'\n onClick={primaryProps.onClick}\n title={primaryProps['aria-label']}\n autoFocus\n data-testid='helpPlugin.tooltip.next'\n >\n <CaretRight className={getSize(6)} />\n </Button>\n )}\n </div>\n </div>\n );\n },\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';\n\nimport { ShortcutsList } from './ShortcutsList';\nimport { HELP_PLUGIN } from '../../meta';\n\nexport const ShortcutsDialogContent = () => {\n const { t } = useTranslation(HELP_PLUGIN);\n\n return (\n <Dialog.Content classNames='p-0 bs-content max-bs-full md:max-is-[25rem] overflow-hidden'>\n <div role='none' className='flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5'>\n <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>\n\n <Dialog.Close asChild>\n <Button density='fine' variant='ghost' autoFocus>\n <Icon icon='ph--x--regular' size={3} />\n </Button>\n </Dialog.Close>\n </div>\n\n <div className='flex items-center justify-center'>\n <ShortcutsList />\n </div>\n </Dialog.Content>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React, { Fragment } from 'react';\n\nimport { Keyboard } from '@dxos/keyboard';\nimport { toLocalizedString, useTranslation } from '@dxos/react-ui';\nimport { mx } from '@dxos/react-ui-theme';\n\nimport { Key } from './Key';\nimport { HELP_PLUGIN } from '../../meta';\n\nexport const ShortcutsList = () => {\n const { t } = useTranslation(HELP_PLUGIN);\n const bindings = Keyboard.singleton.getBindings();\n\n // TODO(burdon): Get shortcuts from TextEditor.\n bindings.sort((a, b) => {\n return toLocalizedString(a.data, t)?.toLowerCase().localeCompare(toLocalizedString(b.data, t)?.toLowerCase());\n });\n\n return (\n <dl className={mx('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued')}>\n {bindings.map((binding, i) => (\n <Fragment key={i}>\n <Key binding={binding.shortcut} />\n <span role='definition' className='mis-4' aria-labelledby={binding.shortcut}>\n {toLocalizedString(binding.data, t)}\n </span>\n </Fragment>\n ))}\n </dl>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { keySymbols } from '@dxos/keyboard';\n\nimport { shortcutKey } from './styles';\n\nexport const Key = ({ binding }: { binding: string }) => {\n return (\n <span role='term' className='inline-flex gap-1' aria-label={binding} id={binding}>\n {keySymbols(binding).map((c, i) => (\n <span key={i} className={shortcutKey}>\n {c}\n </span>\n ))}\n </span>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { mx } from '@dxos/react-ui-theme';\n\nexport const shortcutKey = mx(\n 'inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs',\n 'rounded bg-neutral-100 dark:bg-neutral-900',\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type KeyBinding, Keyboard } from '@dxos/keyboard';\nimport { Button, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';\n\nimport { Key } from './Key';\n\nconst Shortcut = ({ binding }: { binding: KeyBinding }) => {\n const { t } = useTranslation('os');\n return (\n <div role='none' className='flex items-center gap-2 whitespace-nowrap'>\n <Key binding={binding.shortcut} />\n <span className='text-sm'>{toLocalizedString(binding.data, t)}</span>\n </div>\n );\n};\n\nexport const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {\n // TODO(burdon): Display by context/weight/cycle.\n const defaults = ['meta+k', 'meta+/', 'meta+,'];\n const bindings = Keyboard.singleton.getBindings();\n const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));\n\n return (\n <div role='none' className='flex overflow-hidden px-2 gap-4'>\n {hints.map((binding) => (\n <Shortcut key={binding.shortcut} binding={binding} />\n ))}\n {onClose && (\n <Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>\n <Icon icon='ph--x--regular' size={4} />\n </Button>\n )}\n </div>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { descriptionText } from '@dxos/react-ui-theme';\n\nimport { ShortcutsList } from './ShortcutsList';\n\nexport const ShortcutsSection = () => {\n return (\n <section className={descriptionText}>\n <ShortcutsList />\n </section>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { HELP_PLUGIN } from './meta';\n\nexport default [\n {\n 'en-US': {\n [HELP_PLUGIN]: {\n 'plugin name': 'Help',\n 'open help tour': 'Show welcome tour',\n 'open shortcuts label': 'Show shortcuts',\n 'shortcuts dialog title': 'Shortcuts',\n },\n },\n },\n];\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useContext } from 'react';\n\nimport { raise } from '@dxos/debug';\n\nimport { HelpContext } from '../types';\n\nexport const useHelp = () => {\n return useContext(HelpContext) ?? raise(new Error('Missing HelpContext'));\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { HelpPlugin } from './HelpPlugin';\nimport { type Step } from './types';\n\nexport type { Step };\n\nexport * from './components';\nexport * from './hooks';\n\nexport * from './HelpPlugin';\n\nexport default HelpPlugin;\n"],
|
|
5
|
-
"mappings": "
|
|
6
|
-
"names": ["React", "resolvePlugin", "parseIntentPlugin", "LayoutAction", "createExtension", "create", "LocalStorageStore", "React", "useState", "useEffect", "Joyride", "ACTIONS", "EVENTS", "usePlugins", "resolvePlugin", "parseLayoutPlugin", "
|
|
3
|
+
"sources": ["../../../src/HelpPlugin.tsx", "../../../src/components/HelpContextProvider/HelpContextProvider.tsx", "../../../src/components/Tooltip/Tooltip.tsx", "../../../src/components/Shortcuts/ShortcutsDialog.tsx", "../../../src/components/Shortcuts/ShortcutsList.tsx", "../../../src/components/Shortcuts/Key.tsx", "../../../src/components/Shortcuts/styles.ts", "../../../src/components/Shortcuts/ShortcutsHints.tsx", "../../../src/components/Shortcuts/ShortcutsSection.tsx", "../../../src/translations.ts", "../../../src/hooks/useHelp.tsx", "../../../src/index.ts"],
|
|
4
|
+
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport {\n resolvePlugin,\n type PluginDefinition,\n parseIntentPlugin,\n LayoutAction,\n createSurface,\n createResolver,\n createIntent,\n} from '@dxos/app-framework';\nimport { createExtension, type Node } from '@dxos/app-graph';\nimport { create } from '@dxos/live-object';\nimport { LocalStorageStore } from '@dxos/local-storage';\n\nimport {\n HelpContextProvider,\n SHORTCUTS_DIALOG,\n ShortcutsDialogContent,\n ShortcutsHints,\n ShortcutsList,\n} from './components';\nimport meta, { HELP_PLUGIN } from './meta';\nimport translations from './translations';\nimport { type Step, type HelpPluginProvides, HelpAction } from './types';\n\nexport type HelpSettingsProps = { showHints?: boolean; showWelcome?: boolean };\n\nexport type HelpPluginOptions = { steps?: Step[] };\n\nexport const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<HelpPluginProvides> => {\n const settings = new LocalStorageStore<HelpSettingsProps>(HELP_PLUGIN, { showHints: true, showWelcome: true });\n const state = create<{ running: boolean }>({ running: false });\n return {\n meta,\n ready: async () => {\n settings\n .prop({ key: 'showHints', type: LocalStorageStore.bool({ allowUndefined: true }) })\n .prop({ key: 'showWelcome', type: LocalStorageStore.bool({ allowUndefined: true }) });\n },\n provides: {\n context: ({ children }) => {\n return (\n <HelpContextProvider\n steps={steps}\n running={state.running}\n onRunningChanged={(newState) => {\n state.running = newState;\n if (!newState) {\n settings.values.showHints = false;\n }\n }}\n >\n {children}\n </HelpContextProvider>\n );\n },\n translations,\n graph: {\n builder: (plugins) => {\n const dispatch = resolvePlugin(plugins, parseIntentPlugin)?.provides.intent.dispatchPromise;\n\n return createExtension({\n id: HELP_PLUGIN,\n filter: (node): node is Node<null> => node.id === 'root',\n actions: () => [\n {\n id: HelpAction.Start._tag,\n data: async () => {\n settings.values.showHints = true;\n await dispatch?.(createIntent(HelpAction.Start));\n },\n properties: {\n label: ['open help tour', { ns: HELP_PLUGIN }],\n icon: 'ph--info--regular',\n keyBinding: {\n macos: 'shift+meta+/',\n // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n windows: 'shift+ctrl+/',\n linux: 'shift+ctrl+?',\n },\n testId: 'helpPlugin.openHelp',\n },\n },\n {\n id: 'dxos.org/plugin/help/open-shortcuts',\n data: async () => {\n settings.values.showHints = true;\n await dispatch?.(\n createIntent(LayoutAction.SetLayout, { element: 'dialog', component: SHORTCUTS_DIALOG }),\n );\n },\n properties: {\n label: ['open shortcuts label', { ns: HELP_PLUGIN }],\n icon: 'ph--keyboard--regular',\n keyBinding: {\n macos: 'meta+ctrl+/',\n },\n },\n },\n ],\n });\n },\n },\n surface: {\n definitions: () => [\n createSurface({\n id: `${HELP_PLUGIN}/hints`,\n role: 'hints',\n component: () => <ShortcutsHints />,\n }),\n createSurface({\n id: `${HELP_PLUGIN}/keyshortcuts`,\n role: 'keyshortcuts',\n component: () => <ShortcutsList />,\n }),\n createSurface({\n id: SHORTCUTS_DIALOG,\n role: 'dialog',\n filter: (data): data is any => data.component === SHORTCUTS_DIALOG,\n component: () => <ShortcutsDialogContent />,\n }),\n ],\n },\n intent: {\n resolvers: () =>\n createResolver(HelpAction.Start, () => {\n state.running = true;\n }),\n },\n },\n };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { type PropsWithChildren, useState, useEffect } from 'react';\nimport Joyride, { ACTIONS, EVENTS } from 'react-joyride';\n\nimport { usePlugins, resolvePlugin, parseLayoutPlugin } from '@dxos/app-framework';\n\nimport { type Step, HelpContext } from '../../types';\nimport { floaterProps, Tooltip } from '../Tooltip';\n\nconst addStepClass = (target: string | HTMLElement) => {\n const element = typeof target === 'string' ? document.querySelector(target) : target;\n if (element) {\n element.classList.add('joyride-target');\n }\n};\n\nconst removeTargetClass = (target: string | HTMLElement) => {\n const element = typeof target === 'string' ? document.querySelector(target) : target;\n if (element) {\n element.classList.remove('joyride-target');\n }\n};\n\nconst getTarget = (step: Step) => {\n return typeof step.target === 'string' ? document.querySelector(step.target) : step.target;\n};\n\n/**\n * Wait for the target element to be in the document.\n */\nconst waitForTarget = async (step: Step) => {\n if (typeof step.target === 'string') {\n const target = step.target;\n const element = document.querySelector(target);\n if (element) {\n return;\n }\n\n await new Promise<void>((resolve) => {\n const observer = new MutationObserver((mutations) => {\n mutations.forEach((mutation) => {\n if (mutation.addedNodes.length > 0) {\n const element = document.querySelector(target);\n if (element) {\n observer.disconnect();\n resolve();\n }\n }\n });\n });\n\n observer.observe(document.body, { childList: true, subtree: true });\n });\n }\n};\n\nexport type HelpContextProviderProps = PropsWithChildren<{\n steps: Step[];\n running?: boolean;\n onRunningChanged?: (state: boolean) => any;\n}>;\n\nexport const HelpContextProvider = ({\n children,\n steps: initialSteps,\n running: runningProp,\n onRunningChanged,\n}: HelpContextProviderProps) => {\n const { plugins } = usePlugins();\n const layoutPlugin = resolvePlugin(plugins, parseLayoutPlugin);\n const [running, setRunning] = useState(!!runningProp && !!getTarget(initialSteps[0]));\n const [stepIndex, _setStepIndex] = useState(0);\n const [steps, setSteps] = useState(initialSteps);\n\n const paused = layoutPlugin?.provides.layout.dialogOpen;\n\n const setStepIndex = (index: number) => {\n if (runningProp) {\n const step = steps[index];\n step?.before?.({ plugins, step });\n }\n _setStepIndex(index);\n };\n\n const setRunningChanged = (state: boolean) => {\n if (typeof runningProp !== 'undefined') {\n onRunningChanged?.(state);\n } else {\n if (state) {\n setStepIndex(0);\n setRunning(true);\n } else {\n setRunning(false);\n }\n }\n };\n\n useEffect(() => {\n const timeout = setTimeout(async () => {\n if (runningProp) {\n // This handles the case when the target is not yet in the document.\n // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.\n await waitForTarget(steps[stepIndex]);\n setStepIndex(0);\n setRunning(true);\n } else if (typeof runningProp !== 'undefined') {\n setRunning(false);\n }\n });\n\n return () => clearTimeout(timeout);\n }, [runningProp]);\n\n // https://docs.react-joyride.com/callback\n const callback: Joyride['callback'] = async (options) => {\n const { type, action, index, size } = options;\n switch (type) {\n case EVENTS.STEP_BEFORE:\n addStepClass(options.step.target);\n break;\n case EVENTS.TOUR_END:\n break;\n case EVENTS.STEP_AFTER:\n removeTargetClass(options.step.target);\n switch (action) {\n case ACTIONS.NEXT:\n if (index < size - 1) {\n setStepIndex(index + 1);\n }\n break;\n case ACTIONS.PREV:\n if (index > 0) {\n setStepIndex(index - 1);\n }\n break;\n case ACTIONS.CLOSE:\n setRunningChanged(false);\n setStepIndex(0);\n break;\n }\n break;\n }\n };\n\n return (\n <HelpContext.Provider\n value={{\n running: running && !paused,\n steps,\n setSteps,\n setIndex: setStepIndex,\n start: () => setRunningChanged(true),\n stop: () => setRunningChanged(false),\n }}\n >\n <style>\n {`.joyride-target {\n --controls-opacity: 1;\n }`}\n </style>\n <Joyride\n continuous={true}\n steps={steps}\n stepIndex={stepIndex}\n run={running && !paused}\n callback={callback}\n floaterProps={floaterProps}\n tooltipComponent={Tooltip}\n />\n {children}\n </HelpContext.Provider>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useArrowNavigationGroup, useFocusableGroup } from '@fluentui/react-tabster';\nimport { CaretLeft, CaretRight, Circle, X } from '@phosphor-icons/react';\nimport React, { forwardRef } from 'react';\n// TODO(thure): This needed to be imported in the package.json specifically to pacify TS2742. See if this is resolved with typescript@5.5.x.\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport _floater from 'react-floater';\nimport { type TooltipRenderProps, type Props } from 'react-joyride';\n// TODO(thure): This needed to be imported in the package.json specifically to pacify TS2742. See if this is resolved with typescript@5.5.x.\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport _typefest from 'type-fest';\n\nimport { Button } from '@dxos/react-ui';\nimport { getSize, mx } from '@dxos/react-ui-theme';\n\n// https://docs.react-joyride.com/styling\n// https://github.com/gilbarbara/react-floater\nexport const floaterProps: Props['floaterProps'] = {\n styles: {\n // Arrow color is set by joyride.\n arrow: {\n length: 8,\n spread: 16,\n },\n floater: {\n // TODO(burdon): Get tokens from theme.\n filter: 'drop-shadow(0 0 0.75rem rgba(0, 0, 0, 0.2))',\n },\n },\n};\n\n// TODO(burdon): Add info link to docs.\nexport const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(\n ({ step: { title, content }, index, size, isLastStep, backProps, closeProps, primaryProps }, forwardedRef) => {\n const arrowGroup = useArrowNavigationGroup({ axis: 'horizontal' });\n const trapFocus = useFocusableGroup({ tabBehavior: 'limited-trap-focus' });\n\n return (\n <div\n className='flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-inverse'\n role='tooltip'\n data-testid='helpPlugin.tooltip'\n data-step={index + 1}\n {...trapFocus}\n ref={forwardedRef}\n >\n <div className='flex p-2'>\n <h2 className='grow pli-2 plb-1 text-lg font-medium text-inverse'>{title}</h2>\n <Button\n density='fine'\n variant='primary'\n onClick={closeProps.onClick}\n title={closeProps['aria-label']}\n data-testid='helpPlugin.tooltip.close'\n >\n <X weight='bold' className={getSize(4)} />\n </Button>\n </div>\n <div className='flex grow pli-4 mlb-2'>{content}</div>\n <div className='flex p-2 items-center justify-between' {...arrowGroup}>\n {\n <Button\n variant='primary'\n onClick={backProps.onClick}\n title={backProps['aria-label']}\n classNames={[!(index > 0 && backProps) && 'invisible']}\n data-testid='helpPlugin.tooltip.back'\n >\n <CaretLeft className={getSize(5)} />\n </Button>\n }\n <div className='flex grow gap-2 justify-center'>\n <div className='flex'>\n {Array.from({ length: size }).map((_, i) => (\n <Circle\n key={i}\n weight={index === i ? 'fill' : 'regular'}\n className={mx(getSize(2), 'mli-1 cursor-pointer')}\n />\n ))}\n </div>\n </div>\n {isLastStep ? (\n <Button\n variant='primary'\n onClick={closeProps.onClick}\n title={closeProps['aria-label']}\n autoFocus\n data-testid='helpPlugin.tooltip.finish'\n >\n Done\n </Button>\n ) : (\n <Button\n variant='primary'\n onClick={primaryProps.onClick}\n title={primaryProps['aria-label']}\n autoFocus\n data-testid='helpPlugin.tooltip.next'\n >\n <CaretRight className={getSize(6)} />\n </Button>\n )}\n </div>\n </div>\n );\n },\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';\n\nimport { ShortcutsList } from './ShortcutsList';\nimport { HELP_PLUGIN } from '../../meta';\n\nexport const SHORTCUTS_DIALOG = `${HELP_PLUGIN}/ShortcutsDialog`;\n\nexport const ShortcutsDialogContent = () => {\n const { t } = useTranslation(HELP_PLUGIN);\n\n return (\n <Dialog.Content classNames='p-0 bs-content max-bs-full md:max-is-[25rem] overflow-hidden'>\n <div role='none' className='flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5'>\n <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>\n\n <Dialog.Close asChild>\n <Button density='fine' variant='ghost' autoFocus>\n <Icon icon='ph--x--regular' size={3} />\n </Button>\n </Dialog.Close>\n </div>\n\n <div className='flex items-center justify-center'>\n <ShortcutsList />\n </div>\n </Dialog.Content>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React, { Fragment } from 'react';\n\nimport { Keyboard } from '@dxos/keyboard';\nimport { toLocalizedString, useTranslation } from '@dxos/react-ui';\nimport { mx } from '@dxos/react-ui-theme';\n\nimport { Key } from './Key';\nimport { HELP_PLUGIN } from '../../meta';\n\nexport const ShortcutsList = () => {\n const { t } = useTranslation(HELP_PLUGIN);\n const bindings = Keyboard.singleton.getBindings();\n\n // TODO(burdon): Get shortcuts from TextEditor.\n bindings.sort((a, b) => {\n return toLocalizedString(a.data, t)?.toLowerCase().localeCompare(toLocalizedString(b.data, t)?.toLowerCase());\n });\n\n return (\n <dl className={mx('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued')}>\n {bindings.map((binding, i) => (\n <Fragment key={i}>\n <Key binding={binding.shortcut} />\n <span role='definition' className='mis-4' aria-labelledby={binding.shortcut}>\n {toLocalizedString(binding.data, t)}\n </span>\n </Fragment>\n ))}\n </dl>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { keySymbols } from '@dxos/keyboard';\n\nimport { shortcutKey } from './styles';\n\nexport const Key = ({ binding }: { binding: string }) => {\n return (\n <span role='term' className='inline-flex gap-1' aria-label={binding} id={binding}>\n {keySymbols(binding).map((c, i) => (\n <span key={i} className={shortcutKey}>\n {c}\n </span>\n ))}\n </span>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { mx } from '@dxos/react-ui-theme';\n\nexport const shortcutKey = mx(\n 'inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs',\n 'rounded bg-neutral-100 dark:bg-neutral-900',\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type KeyBinding, Keyboard } from '@dxos/keyboard';\nimport { Button, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';\n\nimport { Key } from './Key';\n\nconst Shortcut = ({ binding }: { binding: KeyBinding }) => {\n const { t } = useTranslation('os');\n return (\n <div role='none' className='flex items-center gap-2 whitespace-nowrap'>\n <Key binding={binding.shortcut} />\n <span className='text-sm'>{toLocalizedString(binding.data, t)}</span>\n </div>\n );\n};\n\nexport const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {\n // TODO(burdon): Display by context/weight/cycle.\n const defaults = ['meta+k', 'meta+/', 'meta+,'];\n const bindings = Keyboard.singleton.getBindings();\n const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));\n\n return (\n <div role='none' className='flex overflow-hidden px-2 gap-4'>\n {hints.map((binding) => (\n <Shortcut key={binding.shortcut} binding={binding} />\n ))}\n {onClose && (\n <Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>\n <Icon icon='ph--x--regular' size={4} />\n </Button>\n )}\n </div>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { descriptionText } from '@dxos/react-ui-theme';\n\nimport { ShortcutsList } from './ShortcutsList';\n\nexport const ShortcutsSection = () => {\n return (\n <section className={descriptionText}>\n <ShortcutsList />\n </section>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { HELP_PLUGIN } from './meta';\n\nexport default [\n {\n 'en-US': {\n [HELP_PLUGIN]: {\n 'plugin name': 'Help',\n 'open help tour': 'Show welcome tour',\n 'open shortcuts label': 'Show shortcuts',\n 'shortcuts dialog title': 'Shortcuts',\n },\n },\n },\n];\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useContext } from 'react';\n\nimport { raise } from '@dxos/debug';\n\nimport { HelpContext } from '../types';\n\nexport const useHelp = () => {\n return useContext(HelpContext) ?? raise(new Error('Missing HelpContext'));\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { HelpPlugin } from './HelpPlugin';\nimport { type Step } from './types';\n\nexport type { Step };\n\nexport * from './components';\nexport * from './hooks';\n\nexport * from './HelpPlugin';\n\nexport default HelpPlugin;\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;AAIA,OAAOA,YAAW;AAElB,SACEC,iBAAAA,gBAEAC,mBACAC,cACAC,eACAC,gBACAC,oBACK;AACP,SAASC,uBAAkC;AAC3C,SAASC,cAAc;AACvB,SAASC,yBAAyB;;;ACblC,OAAOC,UAAiCC,UAAUC,iBAAiB;AACnE,OAAOC,WAAWC,SAASC,cAAc;AAEzC,SAASC,YAAYC,eAAeC,yBAAyB;;;ACH7D,SAASC,yBAAyBC,yBAAyB;AAC3D,SAASC,WAAWC,YAAYC,QAAQC,SAAS;AACjD,OAAOC,SAASC,kBAAkB;AASlC,SAASC,cAAc;AACvB,SAASC,SAASC,UAAU;AAIrB,IAAMC,eAAsC;EACjDC,QAAQ;;IAENC,OAAO;MACLC,QAAQ;MACRC,QAAQ;IACV;IACAC,SAAS;;MAEPC,QAAQ;IACV;EACF;AACF;AAGO,IAAMC,UAAUC,2BACrB,CAAC,EAAEC,MAAM,EAAEC,OAAOC,QAAO,GAAIC,OAAOC,MAAMC,YAAYC,WAAWC,YAAYC,aAAY,GAAIC,iBAAAA;AAC3F,QAAMC,aAAaC,wBAAwB;IAAEC,MAAM;EAAa,CAAA;AAChE,QAAMC,YAAYC,kBAAkB;IAAEC,aAAa;EAAqB,CAAA;AAExE,SACE,sBAAA,cAACC,OAAAA;IACCC,WAAU;IACVC,MAAK;IACLC,eAAY;IACZC,aAAWjB,QAAQ;IAClB,GAAGU;IACJQ,KAAKZ;KAEL,sBAAA,cAACO,OAAAA;IAAIC,WAAU;KACb,sBAAA,cAACK,MAAAA;IAAGL,WAAU;KAAqDhB,KAAAA,GACnE,sBAAA,cAACsB,QAAAA;IACCC,SAAQ;IACRC,SAAQ;IACRC,SAASnB,WAAWmB;IACpBzB,OAAOM,WAAW,YAAA;IAClBY,eAAY;KAEZ,sBAAA,cAACQ,GAAAA;IAAEC,QAAO;IAAOX,WAAWY,QAAQ,CAAA;QAGxC,sBAAA,cAACb,OAAAA;IAAIC,WAAU;KAAyBf,OAAAA,GACxC,sBAAA,cAACc,OAAAA;IAAIC,WAAU;IAAyC,GAAGP;KAEvD,sBAAA,cAACa,QAAAA;IACCE,SAAQ;IACRC,SAASpB,UAAUoB;IACnBzB,OAAOK,UAAU,YAAA;IACjBwB,YAAY;MAAC,EAAE3B,QAAQ,KAAKG,cAAc;;IAC1Ca,eAAY;KAEZ,sBAAA,cAACY,WAAAA;IAAUd,WAAWY,QAAQ,CAAA;OAGlC,sBAAA,cAACb,OAAAA;IAAIC,WAAU;KACb,sBAAA,cAACD,OAAAA;IAAIC,WAAU;KACZe,MAAMC,KAAK;IAAEvC,QAAQU;EAAK,CAAA,EAAG8B,IAAI,CAACC,GAAGC,MACpC,sBAAA,cAACC,QAAAA;IACCC,KAAKF;IACLR,QAAQzB,UAAUiC,IAAI,SAAS;IAC/BnB,WAAWsB,GAAGV,QAAQ,CAAA,GAAI,sBAAA;SAKjCxB,aACC,sBAAA,cAACkB,QAAAA;IACCE,SAAQ;IACRC,SAASnB,WAAWmB;IACpBzB,OAAOM,WAAW,YAAA;IAClBiC,WAAAA;IACArB,eAAY;KACb,MAAA,IAID,sBAAA,cAACI,QAAAA;IACCE,SAAQ;IACRC,SAASlB,aAAakB;IACtBzB,OAAOO,aAAa,YAAA;IACpBgC,WAAAA;IACArB,eAAY;KAEZ,sBAAA,cAACsB,YAAAA;IAAWxB,WAAWY,QAAQ,CAAA;;AAM3C,CAAA;;;ADjGF,IAAMa,eAAe,CAACC,WAAAA;AACpB,QAAMC,UAAU,OAAOD,WAAW,WAAWE,SAASC,cAAcH,MAAAA,IAAUA;AAC9E,MAAIC,SAAS;AACXA,YAAQG,UAAUC,IAAI,gBAAA;EACxB;AACF;AAEA,IAAMC,oBAAoB,CAACN,WAAAA;AACzB,QAAMC,UAAU,OAAOD,WAAW,WAAWE,SAASC,cAAcH,MAAAA,IAAUA;AAC9E,MAAIC,SAAS;AACXA,YAAQG,UAAUG,OAAO,gBAAA;EAC3B;AACF;AAEA,IAAMC,YAAY,CAACC,SAAAA;AACjB,SAAO,OAAOA,KAAKT,WAAW,WAAWE,SAASC,cAAcM,KAAKT,MAAM,IAAIS,KAAKT;AACtF;AAKA,IAAMU,gBAAgB,OAAOD,SAAAA;AAC3B,MAAI,OAAOA,KAAKT,WAAW,UAAU;AACnC,UAAMA,SAASS,KAAKT;AACpB,UAAMC,UAAUC,SAASC,cAAcH,MAAAA;AACvC,QAAIC,SAAS;AACX;IACF;AAEA,UAAM,IAAIU,QAAc,CAACC,YAAAA;AACvB,YAAMC,WAAW,IAAIC,iBAAiB,CAACC,cAAAA;AACrCA,kBAAUC,QAAQ,CAACC,aAAAA;AACjB,cAAIA,SAASC,WAAWC,SAAS,GAAG;AAClC,kBAAMlB,WAAUC,SAASC,cAAcH,MAAAA;AACvC,gBAAIC,UAAS;AACXY,uBAASO,WAAU;AACnBR,sBAAAA;YACF;UACF;QACF,CAAA;MACF,CAAA;AAEAC,eAASQ,QAAQnB,SAASoB,MAAM;QAAEC,WAAW;QAAMC,SAAS;MAAK,CAAA;IACnE,CAAA;EACF;AACF;AAQO,IAAMC,sBAAsB,CAAC,EAClCC,UACAC,OAAOC,cACPC,SAASC,aACTC,iBAAgB,MACS;AACzB,QAAM,EAAEC,QAAO,IAAKC,WAAAA;AACpB,QAAMC,eAAeC,cAAcH,SAASI,iBAAAA;AAC5C,QAAM,CAACP,SAASQ,UAAAA,IAAcC,SAAS,CAAC,CAACR,eAAe,CAAC,CAACtB,UAAUoB,aAAa,CAAA,CAAE,CAAA;AACnF,QAAM,CAACW,WAAWC,aAAAA,IAAiBF,SAAS,CAAA;AAC5C,QAAM,CAACX,OAAOc,QAAAA,IAAYH,SAASV,YAAAA;AAEnC,QAAMc,SAASR,cAAcS,SAASC,OAAOC;AAE7C,QAAMC,eAAe,CAACC,UAAAA;AACpB,QAAIjB,aAAa;AACf,YAAMrB,OAAOkB,MAAMoB,KAAAA;AACnBtC,YAAMuC,SAAS;QAAEhB;QAASvB;MAAK,CAAA;IACjC;AACA+B,kBAAcO,KAAAA;EAChB;AAEA,QAAME,oBAAoB,CAACC,UAAAA;AACzB,QAAI,OAAOpB,gBAAgB,aAAa;AACtCC,yBAAmBmB,KAAAA;IACrB,OAAO;AACL,UAAIA,OAAO;AACTJ,qBAAa,CAAA;AACbT,mBAAW,IAAA;MACb,OAAO;AACLA,mBAAW,KAAA;MACb;IACF;EACF;AAEAc,YAAU,MAAA;AACR,UAAMC,UAAUC,WAAW,YAAA;AACzB,UAAIvB,aAAa;AAGf,cAAMpB,cAAciB,MAAMY,SAAAA,CAAU;AACpCO,qBAAa,CAAA;AACbT,mBAAW,IAAA;MACb,WAAW,OAAOP,gBAAgB,aAAa;AAC7CO,mBAAW,KAAA;MACb;IACF,CAAA;AAEA,WAAO,MAAMiB,aAAaF,OAAAA;EAC5B,GAAG;IAACtB;GAAY;AAGhB,QAAMyB,WAAgC,OAAOC,YAAAA;AAC3C,UAAM,EAAEC,MAAMC,QAAQX,OAAOY,KAAI,IAAKH;AACtC,YAAQC,MAAAA;MACN,KAAKG,OAAOC;AACV9D,qBAAayD,QAAQ/C,KAAKT,MAAM;AAChC;MACF,KAAK4D,OAAOE;AACV;MACF,KAAKF,OAAOG;AACVzD,0BAAkBkD,QAAQ/C,KAAKT,MAAM;AACrC,gBAAQ0D,QAAAA;UACN,KAAKM,QAAQC;AACX,gBAAIlB,QAAQY,OAAO,GAAG;AACpBb,2BAAaC,QAAQ,CAAA;YACvB;AACA;UACF,KAAKiB,QAAQE;AACX,gBAAInB,QAAQ,GAAG;AACbD,2BAAaC,QAAQ,CAAA;YACvB;AACA;UACF,KAAKiB,QAAQG;AACXlB,8BAAkB,KAAA;AAClBH,yBAAa,CAAA;AACb;QACJ;AACA;IACJ;EACF;AAEA,SACE,gBAAAsB,OAAA,cAACC,YAAYC,UAAQ;IACnBC,OAAO;MACL1C,SAASA,WAAW,CAACa;MACrBf;MACAc;MACA+B,UAAU1B;MACV2B,OAAO,MAAMxB,kBAAkB,IAAA;MAC/ByB,MAAM,MAAMzB,kBAAkB,KAAA;IAChC;KAEA,gBAAAmB,OAAA,cAACO,SAAAA,MACE;;UAEC,GAEJ,gBAAAP,OAAA,cAACQ,SAAAA;IACCC,YAAY;IACZlD;IACAY;IACAuC,KAAKjD,WAAW,CAACa;IACjBa;IACAwB;IACAC,kBAAkBC;MAEnBvD,QAAAA;AAGP;;;AE3KA,OAAOwD,YAAW;AAElB,SAASC,UAAAA,SAAQC,QAAQC,MAAMC,kBAAAA,uBAAsB;;;ACFrD,OAAOC,UAASC,gBAAgB;AAEhC,SAASC,gBAAgB;AACzB,SAASC,mBAAmBC,sBAAsB;AAClD,SAASC,MAAAA,WAAU;;;ACJnB,OAAOC,YAAW;AAElB,SAASC,kBAAkB;;;ACF3B,SAASC,MAAAA,WAAU;AAEZ,IAAMC,cAAcC,IACzB,mFACA,4CAAA;;;ADEK,IAAMC,MAAM,CAAC,EAAEC,QAAO,MAAuB;AAClD,SACE,gBAAAC,OAAA,cAACC,QAAAA;IAAKC,MAAK;IAAOC,WAAU;IAAoBC,cAAYL;IAASM,IAAIN;KACtEO,WAAWP,OAAAA,EAASQ,IAAI,CAACC,GAAGC,MAC3B,gBAAAT,OAAA,cAACC,QAAAA;IAAKS,KAAKD;IAAGN,WAAWQ;KACtBH,CAAAA,CAAAA,CAAAA;AAKX;;;ADPO,IAAMI,gBAAgB,MAAA;AAC3B,QAAM,EAAEC,EAAC,IAAKC,eAAeC,WAAAA;AAC7B,QAAMC,WAAWC,SAASC,UAAUC,YAAW;AAG/CH,WAASI,KAAK,CAACC,GAAGC,MAAAA;AAChB,WAAOC,kBAAkBF,EAAEG,MAAMX,CAAAA,GAAIY,YAAAA,EAAcC,cAAcH,kBAAkBD,EAAEE,MAAMX,CAAAA,GAAIY,YAAAA,CAAAA;EACjG,CAAA;AAEA,SACE,gBAAAE,OAAA,cAACC,MAAAA;IAAGC,WAAWC,IAAG,gFAAA;KACfd,SAASe,IAAI,CAACC,SAASC,MACtB,gBAAAN,OAAA,cAACO,UAAAA;IAASC,KAAKF;KACb,gBAAAN,OAAA,cAACS,KAAAA;IAAIJ,SAASA,QAAQK;MACtB,gBAAAV,OAAA,cAACW,QAAAA;IAAKC,MAAK;IAAaV,WAAU;IAAQW,mBAAiBR,QAAQK;KAChEd,kBAAkBS,QAAQR,MAAMX,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA;AAM7C;;;ADvBO,IAAM4B,mBAAmB,GAAGC,WAAAA;AAE5B,IAAMC,yBAAyB,MAAA;AACpC,QAAM,EAAEC,EAAC,IAAKC,gBAAeH,WAAAA;AAE7B,SACE,gBAAAI,OAAA,cAACC,OAAOC,SAAO;IAACC,YAAW;KACzB,gBAAAH,OAAA,cAACI,OAAAA;IAAIC,MAAK;IAAOC,WAAU;KACzB,gBAAAN,OAAA,cAACC,OAAOM,OAAK,MAAET,EAAE,wBAAA,CAAA,GAEjB,gBAAAE,OAAA,cAACC,OAAOO,OAAK;IAACC,SAAAA;KACZ,gBAAAT,OAAA,cAACU,SAAAA;IAAOC,SAAQ;IAAOC,SAAQ;IAAQC,WAAAA;KACrC,gBAAAb,OAAA,cAACc,MAAAA;IAAKC,MAAK;IAAiBC,MAAM;SAKxC,gBAAAhB,OAAA,cAACI,OAAAA;IAAIE,WAAU;KACb,gBAAAN,OAAA,cAACiB,eAAAA,IAAAA,CAAAA,CAAAA;AAIT;;;AI7BA,OAAOC,YAAW;AAElB,SAA0BC,YAAAA,iBAAgB;AAC1C,SAASC,UAAAA,SAAQC,QAAAA,OAAMC,qBAAAA,oBAAmBC,kBAAAA,uBAAsB;AAIhE,IAAMC,WAAW,CAAC,EAAEC,QAAO,MAA2B;AACpD,QAAM,EAAEC,EAAC,IAAKC,gBAAe,IAAA;AAC7B,SACE,gBAAAC,OAAA,cAACC,OAAAA;IAAIC,MAAK;IAAOC,WAAU;KACzB,gBAAAH,OAAA,cAACI,KAAAA;IAAIP,SAASA,QAAQQ;MACtB,gBAAAL,OAAA,cAACM,QAAAA;IAAKH,WAAU;KAAWI,mBAAkBV,QAAQW,MAAMV,CAAAA,CAAAA,CAAAA;AAGjE;AAEO,IAAMW,iBAAiB,CAAC,EAAEC,QAAO,MAA4B;AAElE,QAAMC,WAAW;IAAC;IAAU;IAAU;;AACtC,QAAMC,WAAWC,UAASC,UAAUC,YAAW;AAC/C,QAAMC,QAAQJ,SAASK,OAAO,CAACpB,YAAYc,SAASO,SAASrB,QAAQQ,QAAQ,CAAA;AAE7E,SACE,gBAAAL,OAAA,cAACC,OAAAA;IAAIC,MAAK;IAAOC,WAAU;KACxBa,MAAMG,IAAI,CAACtB,YACV,gBAAAG,OAAA,cAACJ,UAAAA;IAASwB,KAAKvB,QAAQQ;IAAUR;OAElCa,WACC,gBAAAV,OAAA,cAACqB,SAAAA;IAAOC,SAAQ;IAAQC,YAAW;IAAqBC,SAASd;KAC/D,gBAAAV,OAAA,cAACyB,OAAAA;IAAKC,MAAK;IAAiBC,MAAM;;AAK5C;;;ACnCA,OAAOC,YAAW;AAElB,SAASC,uBAAuB;AAIzB,IAAMC,mBAAmB,MAAA;AAC9B,SACE,gBAAAC,OAAA,cAACC,WAAAA;IAAQC,WAAWC;KAClB,gBAAAH,OAAA,cAACI,eAAAA,IAAAA,CAAAA;AAGP;;;ACVA,IAAA,uBAAe;EACb;IACE,SAAS;MACP,CAACC,WAAAA,GAAc;QACb,eAAe;QACf,kBAAkB;QAClB,wBAAwB;QACxB,0BAA0B;MAC5B;IACF;EACF;;;;ATkBK,IAAMC,aAAa,CAAC,EAAEC,QAAQ,CAAA,EAAE,MAAqB;AAC1D,QAAMC,WAAW,IAAIC,kBAAqCC,aAAa;IAAEC,WAAW;IAAMC,aAAa;EAAK,CAAA;AAC5G,QAAMC,QAAQC,OAA6B;IAAEC,SAAS;EAAM,CAAA;AAC5D,SAAO;IACLC;IACAC,OAAO,YAAA;AACLT,eACGU,KAAK;QAAEC,KAAK;QAAaC,MAAMX,kBAAkBY,KAAK;UAAEC,gBAAgB;QAAK,CAAA;MAAG,CAAA,EAChFJ,KAAK;QAAEC,KAAK;QAAeC,MAAMX,kBAAkBY,KAAK;UAAEC,gBAAgB;QAAK,CAAA;MAAG,CAAA;IACvF;IACAC,UAAU;MACRC,SAAS,CAAC,EAAEC,SAAQ,MAAE;AACpB,eACE,gBAAAC,OAAA,cAACC,qBAAAA;UACCpB;UACAQ,SAASF,MAAME;UACfa,kBAAkB,CAACC,aAAAA;AACjBhB,kBAAME,UAAUc;AAChB,gBAAI,CAACA,UAAU;AACbrB,uBAASsB,OAAOnB,YAAY;YAC9B;UACF;WAECc,QAAAA;MAGP;MACAM;MACAC,OAAO;QACLC,SAAS,CAACC,YAAAA;AACR,gBAAMC,WAAWC,eAAcF,SAASG,iBAAAA,GAAoBd,SAASe,OAAOC;AAE5E,iBAAOC,gBAAgB;YACrBC,IAAI/B;YACJgC,QAAQ,CAACC,SAA6BA,KAAKF,OAAO;YAClDG,SAAS,MAAM;cACb;gBACEH,IAAII,WAAWC,MAAMC;gBACrBC,MAAM,YAAA;AACJxC,2BAASsB,OAAOnB,YAAY;AAC5B,wBAAMwB,WAAWc,aAAaJ,WAAWC,KAAK,CAAA;gBAChD;gBACAI,YAAY;kBACVC,OAAO;oBAAC;oBAAkB;sBAAEC,IAAI1C;oBAAY;;kBAC5C2C,MAAM;kBACNC,YAAY;oBACVC,OAAO;;oBAEPC,SAAS;oBACTC,OAAO;kBACT;kBACAC,QAAQ;gBACV;cACF;cACA;gBACEjB,IAAI;gBACJO,MAAM,YAAA;AACJxC,2BAASsB,OAAOnB,YAAY;AAC5B,wBAAMwB,WACJc,aAAaU,aAAaC,WAAW;oBAAEC,SAAS;oBAAUC,WAAWC;kBAAiB,CAAA,CAAA;gBAE1F;gBACAb,YAAY;kBACVC,OAAO;oBAAC;oBAAwB;sBAAEC,IAAI1C;oBAAY;;kBAClD2C,MAAM;kBACNC,YAAY;oBACVC,OAAO;kBACT;gBACF;cACF;;UAEJ,CAAA;QACF;MACF;MACAS,SAAS;QACPC,aAAa,MAAM;UACjBC,cAAc;YACZzB,IAAI,GAAG/B,WAAAA;YACPyD,MAAM;YACNL,WAAW,MAAM,gBAAApC,OAAA,cAAC0C,gBAAAA,IAAAA;UACpB,CAAA;UACAF,cAAc;YACZzB,IAAI,GAAG/B,WAAAA;YACPyD,MAAM;YACNL,WAAW,MAAM,gBAAApC,OAAA,cAAC2C,eAAAA,IAAAA;UACpB,CAAA;UACAH,cAAc;YACZzB,IAAIsB;YACJI,MAAM;YACNzB,QAAQ,CAACM,SAAsBA,KAAKc,cAAcC;YAClDD,WAAW,MAAM,gBAAApC,OAAA,cAAC4C,wBAAAA,IAAAA;UACpB,CAAA;;MAEJ;MACAhC,QAAQ;QACNiC,WAAW,MACTC,eAAe3B,WAAWC,OAAO,MAAA;AAC/BjC,gBAAME,UAAU;QAClB,CAAA;MACJ;IACF;EACF;AACF;;;AUpIA,SAAS0D,kBAAkB;AAE3B,SAASC,aAAa;AAIf,IAAMC,UAAU,MAAA;AACrB,SAAOC,WAAWC,WAAAA,KAAgBC,MAAM,IAAIC,MAAM,qBAAA,CAAA;AACpD;;;ACEA,IAAA,cAAeC;",
|
|
6
|
+
"names": ["React", "resolvePlugin", "parseIntentPlugin", "LayoutAction", "createSurface", "createResolver", "createIntent", "createExtension", "create", "LocalStorageStore", "React", "useState", "useEffect", "Joyride", "ACTIONS", "EVENTS", "usePlugins", "resolvePlugin", "parseLayoutPlugin", "useArrowNavigationGroup", "useFocusableGroup", "CaretLeft", "CaretRight", "Circle", "X", "React", "forwardRef", "Button", "getSize", "mx", "floaterProps", "styles", "arrow", "length", "spread", "floater", "filter", "Tooltip", "forwardRef", "step", "title", "content", "index", "size", "isLastStep", "backProps", "closeProps", "primaryProps", "forwardedRef", "arrowGroup", "useArrowNavigationGroup", "axis", "trapFocus", "useFocusableGroup", "tabBehavior", "div", "className", "role", "data-testid", "data-step", "ref", "h2", "Button", "density", "variant", "onClick", "X", "weight", "getSize", "classNames", "CaretLeft", "Array", "from", "map", "_", "i", "Circle", "key", "mx", "autoFocus", "CaretRight", "addStepClass", "target", "element", "document", "querySelector", "classList", "add", "removeTargetClass", "remove", "getTarget", "step", "waitForTarget", "Promise", "resolve", "observer", "MutationObserver", "mutations", "forEach", "mutation", "addedNodes", "length", "disconnect", "observe", "body", "childList", "subtree", "HelpContextProvider", "children", "steps", "initialSteps", "running", "runningProp", "onRunningChanged", "plugins", "usePlugins", "layoutPlugin", "resolvePlugin", "parseLayoutPlugin", "setRunning", "useState", "stepIndex", "_setStepIndex", "setSteps", "paused", "provides", "layout", "dialogOpen", "setStepIndex", "index", "before", "setRunningChanged", "state", "useEffect", "timeout", "setTimeout", "clearTimeout", "callback", "options", "type", "action", "size", "EVENTS", "STEP_BEFORE", "TOUR_END", "STEP_AFTER", "ACTIONS", "NEXT", "PREV", "CLOSE", "React", "HelpContext", "Provider", "value", "setIndex", "start", "stop", "style", "Joyride", "continuous", "run", "floaterProps", "tooltipComponent", "Tooltip", "React", "Button", "Dialog", "Icon", "useTranslation", "React", "Fragment", "Keyboard", "toLocalizedString", "useTranslation", "mx", "React", "keySymbols", "mx", "shortcutKey", "mx", "Key", "binding", "React", "span", "role", "className", "aria-label", "id", "keySymbols", "map", "c", "i", "key", "shortcutKey", "ShortcutsList", "t", "useTranslation", "HELP_PLUGIN", "bindings", "Keyboard", "singleton", "getBindings", "sort", "a", "b", "toLocalizedString", "data", "toLowerCase", "localeCompare", "React", "dl", "className", "mx", "map", "binding", "i", "Fragment", "key", "Key", "shortcut", "span", "role", "aria-labelledby", "SHORTCUTS_DIALOG", "HELP_PLUGIN", "ShortcutsDialogContent", "t", "useTranslation", "React", "Dialog", "Content", "classNames", "div", "role", "className", "Title", "Close", "asChild", "Button", "density", "variant", "autoFocus", "Icon", "icon", "size", "ShortcutsList", "React", "Keyboard", "Button", "Icon", "toLocalizedString", "useTranslation", "Shortcut", "binding", "t", "useTranslation", "React", "div", "role", "className", "Key", "shortcut", "span", "toLocalizedString", "data", "ShortcutsHints", "onClose", "defaults", "bindings", "Keyboard", "singleton", "getBindings", "hints", "filter", "includes", "map", "key", "Button", "variant", "classNames", "onClick", "Icon", "icon", "size", "React", "descriptionText", "ShortcutsSection", "React", "section", "className", "descriptionText", "ShortcutsList", "HELP_PLUGIN", "HelpPlugin", "steps", "settings", "LocalStorageStore", "HELP_PLUGIN", "showHints", "showWelcome", "state", "create", "running", "meta", "ready", "prop", "key", "type", "bool", "allowUndefined", "provides", "context", "children", "React", "HelpContextProvider", "onRunningChanged", "newState", "values", "translations", "graph", "builder", "plugins", "dispatch", "resolvePlugin", "parseIntentPlugin", "intent", "dispatchPromise", "createExtension", "id", "filter", "node", "actions", "HelpAction", "Start", "_tag", "data", "createIntent", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "SetLayout", "element", "component", "SHORTCUTS_DIALOG", "surface", "definitions", "createSurface", "role", "ShortcutsHints", "ShortcutsList", "ShortcutsDialogContent", "resolvers", "createResolver", "useContext", "raise", "useHelp", "useContext", "HelpContext", "raise", "Error", "HelpPlugin"]
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"packages/plugins/plugin-help/src/types.ts":{"bytes":2185,"imports":[{"path":"react","kind":"import-statement","external":true}],"format":"esm"},"packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx":{"bytes":12449,"imports":[{"path":"@fluentui/react-tabster","kind":"import-statement","external":true},{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true}],"format":"esm"},"packages/plugins/plugin-help/src/components/Tooltip/index.ts":{"bytes":518,"imports":[{"path":"packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx","kind":"import-statement","original":"./Tooltip"}],"format":"esm"},"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx":{"bytes":17572,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"react-joyride","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/types.ts","kind":"import-statement","original":"../../types"},{"path":"packages/plugins/plugin-help/src/components/Tooltip/index.ts","kind":"import-statement","original":"../Tooltip"}],"format":"esm"},"packages/plugins/plugin-help/src/components/HelpContextProvider/index.ts":{"bytes":558,"imports":[{"path":"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx","kind":"import-statement","original":"./HelpContextProvider"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/styles.ts":{"bytes":1045,"imports":[{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx":{"bytes":2038,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/styles.ts","kind":"import-statement","original":"./styles"}],"format":"esm"},"packages/plugins/plugin-help/src/meta.ts":{"bytes":1637,"imports":[],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx":{"bytes":4360,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx","kind":"import-statement","original":"./Key"},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"../../meta"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx":{"bytes":3832,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx","kind":"import-statement","original":"./ShortcutsList"},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"../../meta"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx":{"bytes":5128,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx","kind":"import-statement","original":"./Key"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx":{"bytes":1507,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx","kind":"import-statement","original":"./ShortcutsList"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/index.ts":{"bytes":938,"imports":[{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx","kind":"import-statement","original":"./ShortcutsDialog"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx","kind":"import-statement","original":"./ShortcutsHints"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx","kind":"import-statement","original":"./ShortcutsList"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx","kind":"import-statement","original":"./ShortcutsSection"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx","kind":"import-statement","original":"./Key"}],"format":"esm"},"packages/plugins/plugin-help/src/components/index.ts":{"bytes":718,"imports":[{"path":"packages/plugins/plugin-help/src/components/HelpContextProvider/index.ts","kind":"import-statement","original":"./HelpContextProvider"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/index.ts","kind":"import-statement","original":"./Shortcuts"},{"path":"packages/plugins/plugin-help/src/components/Tooltip/index.ts","kind":"import-statement","original":"./Tooltip"}],"format":"esm"},"packages/plugins/plugin-help/src/translations.ts":{"bytes":1427,"imports":[{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"./meta"}],"format":"esm"},"packages/plugins/plugin-help/src/HelpPlugin.tsx":{"bytes":16305,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/app-graph","kind":"import-statement","external":true},{"path":"@dxos/live-object","kind":"import-statement","external":true},{"path":"@dxos/local-storage","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/index.ts","kind":"import-statement","original":"./components"},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"./meta"},{"path":"packages/plugins/plugin-help/src/translations.ts","kind":"import-statement","original":"./translations"}],"format":"esm"},"packages/plugins/plugin-help/src/hooks/useHelp.tsx":{"bytes":1249,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/types.ts","kind":"import-statement","original":"../types"}],"format":"esm"},"packages/plugins/plugin-help/src/hooks/index.ts":{"bytes":505,"imports":[{"path":"packages/plugins/plugin-help/src/hooks/useHelp.tsx","kind":"import-statement","original":"./useHelp"}],"format":"esm"},"packages/plugins/plugin-help/src/index.ts":{"bytes":1015,"imports":[{"path":"packages/plugins/plugin-help/src/HelpPlugin.tsx","kind":"import-statement","original":"./HelpPlugin"},{"path":"packages/plugins/plugin-help/src/components/index.ts","kind":"import-statement","original":"./components"},{"path":"packages/plugins/plugin-help/src/hooks/index.ts","kind":"import-statement","original":"./hooks"},{"path":"packages/plugins/plugin-help/src/HelpPlugin.tsx","kind":"import-statement","original":"./HelpPlugin"}],"format":"esm"}},"outputs":{"packages/plugins/plugin-help/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":34202},"packages/plugins/plugin-help/dist/lib/browser/index.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-2EMBCGD5.mjs","kind":"import-statement"},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/app-graph","kind":"import-statement","external":true},{"path":"@dxos/live-object","kind":"import-statement","external":true},{"path":"@dxos/local-storage","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"react-joyride","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@fluentui/react-tabster","kind":"import-statement","external":true},{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true}],"exports":["HelpContextProvider","HelpPlugin","Key","ShortcutsDialogContent","ShortcutsHints","ShortcutsList","ShortcutsSection","Tooltip","default","floaterProps","useHelp"],"entryPoint":"packages/plugins/plugin-help/src/index.ts","inputs":{"packages/plugins/plugin-help/src/HelpPlugin.tsx":{"bytesInOutput":4115},"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx":{"bytesInOutput":4044},"packages/plugins/plugin-help/src/types.ts":{"bytesInOutput":200},"packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx":{"bytesInOutput":3180},"packages/plugins/plugin-help/src/components/Tooltip/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/HelpContextProvider/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx":{"bytesInOutput":1059},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx":{"bytesInOutput":995},"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx":{"bytesInOutput":394},"packages/plugins/plugin-help/src/components/Shortcuts/styles.ts":{"bytesInOutput":202},"packages/plugins/plugin-help/src/components/Shortcuts/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx":{"bytesInOutput":1367},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx":{"bytesInOutput":273},"packages/plugins/plugin-help/src/translations.ts":{"bytesInOutput":266},"packages/plugins/plugin-help/src/index.ts":{"bytesInOutput":30},"packages/plugins/plugin-help/src/hooks/useHelp.tsx":{"bytesInOutput":175},"packages/plugins/plugin-help/src/hooks/index.ts":{"bytesInOutput":0}},"bytes":17839},"packages/plugins/plugin-help/dist/lib/browser/meta.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"packages/plugins/plugin-help/dist/lib/browser/meta.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-2EMBCGD5.mjs","kind":"import-statement"}],"exports":["HELP_PLUGIN","HelpAction","default"],"entryPoint":"packages/plugins/plugin-help/src/meta.ts","inputs":{},"bytes":185},"packages/plugins/plugin-help/dist/lib/browser/chunk-2EMBCGD5.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":764},"packages/plugins/plugin-help/dist/lib/browser/chunk-2EMBCGD5.mjs":{"imports":[],"exports":["HELP_PLUGIN","HelpAction","meta_default"],"inputs":{"packages/plugins/plugin-help/src/meta.ts":{"bytesInOutput":322}},"bytes":467}}}
|
|
1
|
+
{"inputs":{"packages/plugins/plugin-help/src/meta.ts":{"bytes":1116,"imports":[],"format":"esm"},"packages/plugins/plugin-help/src/types.ts":{"bytes":3447,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"./meta"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx":{"bytes":12449,"imports":[{"path":"@fluentui/react-tabster","kind":"import-statement","external":true},{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true}],"format":"esm"},"packages/plugins/plugin-help/src/components/Tooltip/index.ts":{"bytes":518,"imports":[{"path":"packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx","kind":"import-statement","original":"./Tooltip"}],"format":"esm"},"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx":{"bytes":17572,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"react-joyride","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/types.ts","kind":"import-statement","original":"../../types"},{"path":"packages/plugins/plugin-help/src/components/Tooltip/index.ts","kind":"import-statement","original":"../Tooltip"}],"format":"esm"},"packages/plugins/plugin-help/src/components/HelpContextProvider/index.ts":{"bytes":558,"imports":[{"path":"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx","kind":"import-statement","original":"./HelpContextProvider"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/styles.ts":{"bytes":1045,"imports":[{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx":{"bytes":2038,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/styles.ts","kind":"import-statement","original":"./styles"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx":{"bytes":4360,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx","kind":"import-statement","original":"./Key"},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"../../meta"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx":{"bytes":4094,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx","kind":"import-statement","original":"./ShortcutsList"},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"../../meta"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx":{"bytes":5128,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx","kind":"import-statement","original":"./Key"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx":{"bytes":1507,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx","kind":"import-statement","original":"./ShortcutsList"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/index.ts":{"bytes":938,"imports":[{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx","kind":"import-statement","original":"./ShortcutsDialog"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx","kind":"import-statement","original":"./ShortcutsHints"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx","kind":"import-statement","original":"./ShortcutsList"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx","kind":"import-statement","original":"./ShortcutsSection"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx","kind":"import-statement","original":"./Key"}],"format":"esm"},"packages/plugins/plugin-help/src/components/index.ts":{"bytes":718,"imports":[{"path":"packages/plugins/plugin-help/src/components/HelpContextProvider/index.ts","kind":"import-statement","original":"./HelpContextProvider"},{"path":"packages/plugins/plugin-help/src/components/Shortcuts/index.ts","kind":"import-statement","original":"./Shortcuts"},{"path":"packages/plugins/plugin-help/src/components/Tooltip/index.ts","kind":"import-statement","original":"./Tooltip"}],"format":"esm"},"packages/plugins/plugin-help/src/translations.ts":{"bytes":1427,"imports":[{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"./meta"}],"format":"esm"},"packages/plugins/plugin-help/src/HelpPlugin.tsx":{"bytes":16482,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/app-graph","kind":"import-statement","external":true},{"path":"@dxos/live-object","kind":"import-statement","external":true},{"path":"@dxos/local-storage","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/components/index.ts","kind":"import-statement","original":"./components"},{"path":"packages/plugins/plugin-help/src/meta.ts","kind":"import-statement","original":"./meta"},{"path":"packages/plugins/plugin-help/src/translations.ts","kind":"import-statement","original":"./translations"},{"path":"packages/plugins/plugin-help/src/types.ts","kind":"import-statement","original":"./types"}],"format":"esm"},"packages/plugins/plugin-help/src/hooks/useHelp.tsx":{"bytes":1249,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-help/src/types.ts","kind":"import-statement","original":"../types"}],"format":"esm"},"packages/plugins/plugin-help/src/hooks/index.ts":{"bytes":505,"imports":[{"path":"packages/plugins/plugin-help/src/hooks/useHelp.tsx","kind":"import-statement","original":"./useHelp"}],"format":"esm"},"packages/plugins/plugin-help/src/index.ts":{"bytes":1015,"imports":[{"path":"packages/plugins/plugin-help/src/HelpPlugin.tsx","kind":"import-statement","original":"./HelpPlugin"},{"path":"packages/plugins/plugin-help/src/components/index.ts","kind":"import-statement","original":"./components"},{"path":"packages/plugins/plugin-help/src/hooks/index.ts","kind":"import-statement","original":"./hooks"},{"path":"packages/plugins/plugin-help/src/HelpPlugin.tsx","kind":"import-statement","original":"./HelpPlugin"}],"format":"esm"}},"outputs":{"packages/plugins/plugin-help/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":33225},"packages/plugins/plugin-help/dist/lib/browser/index.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-RHSC3EWO.mjs","kind":"import-statement"},{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-STC3ORFI.mjs","kind":"import-statement"},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/app-graph","kind":"import-statement","external":true},{"path":"@dxos/live-object","kind":"import-statement","external":true},{"path":"@dxos/local-storage","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"react-joyride","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@fluentui/react-tabster","kind":"import-statement","external":true},{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/keyboard","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true}],"exports":["HelpContextProvider","HelpPlugin","Key","SHORTCUTS_DIALOG","ShortcutsDialogContent","ShortcutsHints","ShortcutsList","ShortcutsSection","Tooltip","default","floaterProps","useHelp"],"entryPoint":"packages/plugins/plugin-help/src/index.ts","inputs":{"packages/plugins/plugin-help/src/HelpPlugin.tsx":{"bytesInOutput":4096},"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx":{"bytesInOutput":4044},"packages/plugins/plugin-help/src/components/Tooltip/Tooltip.tsx":{"bytesInOutput":3180},"packages/plugins/plugin-help/src/components/Tooltip/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/HelpContextProvider/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsDialog.tsx":{"bytesInOutput":1116},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsList.tsx":{"bytesInOutput":995},"packages/plugins/plugin-help/src/components/Shortcuts/Key.tsx":{"bytesInOutput":394},"packages/plugins/plugin-help/src/components/Shortcuts/styles.ts":{"bytesInOutput":202},"packages/plugins/plugin-help/src/components/Shortcuts/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx":{"bytesInOutput":1367},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx":{"bytesInOutput":273},"packages/plugins/plugin-help/src/translations.ts":{"bytesInOutput":266},"packages/plugins/plugin-help/src/index.ts":{"bytesInOutput":30},"packages/plugins/plugin-help/src/hooks/useHelp.tsx":{"bytesInOutput":175},"packages/plugins/plugin-help/src/hooks/index.ts":{"bytesInOutput":0}},"bytes":17705},"packages/plugins/plugin-help/dist/lib/browser/meta.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"packages/plugins/plugin-help/dist/lib/browser/meta.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-STC3ORFI.mjs","kind":"import-statement"}],"exports":["HELP_PLUGIN","default"],"entryPoint":"packages/plugins/plugin-help/src/meta.ts","inputs":{},"bytes":157},"packages/plugins/plugin-help/dist/lib/browser/types.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"packages/plugins/plugin-help/dist/lib/browser/types.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-RHSC3EWO.mjs","kind":"import-statement"},{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-STC3ORFI.mjs","kind":"import-statement"}],"exports":["HELP_ACTION","HelpAction","HelpContext"],"entryPoint":"packages/plugins/plugin-help/src/types.ts","inputs":{},"bytes":204},"packages/plugins/plugin-help/dist/lib/browser/chunk-RHSC3EWO.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":1979},"packages/plugins/plugin-help/dist/lib/browser/chunk-RHSC3EWO.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-STC3ORFI.mjs","kind":"import-statement"},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true}],"exports":["HELP_ACTION","HelpAction","HelpContext"],"inputs":{"packages/plugins/plugin-help/src/types.ts":{"bytesInOutput":502}},"bytes":702},"packages/plugins/plugin-help/dist/lib/browser/chunk-STC3ORFI.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":522},"packages/plugins/plugin-help/dist/lib/browser/chunk-STC3ORFI.mjs":{"imports":[],"exports":["HELP_PLUGIN","meta_default"],"inputs":{"packages/plugins/plugin-help/src/meta.ts":{"bytesInOutput":129}},"bytes":260}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HelpPlugin.d.ts","sourceRoot":"","sources":["../../../src/HelpPlugin.tsx"],"names":[],"mappings":"AAMA,OAAO,
|
|
1
|
+
{"version":3,"file":"HelpPlugin.d.ts","sourceRoot":"","sources":["../../../src/HelpPlugin.tsx"],"names":[],"mappings":"AAMA,OAAO,EAEL,KAAK,gBAAgB,EAMtB,MAAM,qBAAqB,CAAC;AAc7B,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,kBAAkB,EAAc,MAAM,SAAS,CAAC;AAEzE,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE/E,MAAM,MAAM,iBAAiB,GAAG;IAAE,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAC;AAEnD,eAAO,MAAM,UAAU,cAAoB,iBAAiB,KAAG,gBAAgB,CAAC,kBAAkB,CAsGjG,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ShortcutsDialog.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsDialog.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,eAAO,MAAM,sBAAsB,yBAoBlC,CAAC"}
|
|
1
|
+
{"version":3,"file":"ShortcutsDialog.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsDialog.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,eAAO,MAAM,gBAAgB,yCAAmC,CAAC;AAEjE,eAAO,MAAM,sBAAsB,yBAoBlC,CAAC"}
|
package/dist/types/src/meta.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,WAAW,yBAAyB,CAAC;;;;;;AAElD,wBAIuB
|
|
1
|
+
{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,WAAW,yBAAyB,CAAC;;;;;;AAElD,wBAIuB"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { type Context } from 'react';
|
|
2
2
|
import { type Step as BaseStep } from 'react-joyride';
|
|
3
3
|
import { type Plugin, type GraphBuilderProvides, type IntentResolverProvides, type SurfaceProvides, type TranslationsProvides } from '@dxos/app-framework';
|
|
4
|
+
import { S } from '@dxos/echo-schema';
|
|
4
5
|
export type Step = BaseStep & {
|
|
5
6
|
before?: (context: {
|
|
6
7
|
plugins: Plugin[];
|
|
@@ -17,4 +18,16 @@ export type HelpContextType = {
|
|
|
17
18
|
};
|
|
18
19
|
export declare const HelpContext: Context<HelpContextType>;
|
|
19
20
|
export type HelpPluginProvides = GraphBuilderProvides & IntentResolverProvides & SurfaceProvides & TranslationsProvides;
|
|
21
|
+
export declare const HELP_ACTION = "dxos.org/plugin/help/action";
|
|
22
|
+
export declare namespace HelpAction {
|
|
23
|
+
const Start_base: S.TaggedClass<Start, "dxos.org/plugin/help/action/start", {
|
|
24
|
+
readonly _tag: S.tag<"dxos.org/plugin/help/action/start">;
|
|
25
|
+
} & {
|
|
26
|
+
input: typeof S.Void;
|
|
27
|
+
output: typeof S.Void;
|
|
28
|
+
}>;
|
|
29
|
+
export class Start extends Start_base {
|
|
30
|
+
}
|
|
31
|
+
export {};
|
|
32
|
+
}
|
|
20
33
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,KAAK,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EACL,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAC1B,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,KAAK,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EACL,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAItC,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG;IAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,KAAK,IAAI,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,IAAI,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,eAAe,CAO/C,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAExH,eAAO,MAAM,WAAW,gCAA0B,CAAC;AACnD,yBAAiB,UAAU,CAAC;;;;;;;IAC1B,MAAM,OAAO,KAAM,SAAQ,UAGzB;KAAG;;CACN"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":"5.7.2"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/plugin-help",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.5-main.9d26e3a",
|
|
4
4
|
"description": "Help plugin.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -15,6 +15,10 @@
|
|
|
15
15
|
"./meta": {
|
|
16
16
|
"types": "./dist/types/src/meta.d.ts",
|
|
17
17
|
"browser": "./dist/lib/browser/meta.mjs"
|
|
18
|
+
},
|
|
19
|
+
"./types": {
|
|
20
|
+
"types": "./dist/types/src/types.d.ts",
|
|
21
|
+
"browser": "./dist/lib/browser/types.mjs"
|
|
18
22
|
}
|
|
19
23
|
},
|
|
20
24
|
"types": "dist/types/src/index.d.ts",
|
|
@@ -22,6 +26,9 @@
|
|
|
22
26
|
"*": {
|
|
23
27
|
"meta": [
|
|
24
28
|
"dist/types/src/meta.d.ts"
|
|
29
|
+
],
|
|
30
|
+
"types": [
|
|
31
|
+
"dist/types/src/types.d.ts"
|
|
25
32
|
]
|
|
26
33
|
}
|
|
27
34
|
},
|
|
@@ -33,17 +40,17 @@
|
|
|
33
40
|
"@fluentui/react-tabster": "^9.19.0",
|
|
34
41
|
"lodash.get": "^4.4.2",
|
|
35
42
|
"react-joyride": "^2.7.2",
|
|
36
|
-
"@dxos/app-framework": "0.7.
|
|
37
|
-
"@dxos/
|
|
38
|
-
"@dxos/
|
|
39
|
-
"@dxos/echo-schema": "0.7.
|
|
40
|
-
"@dxos/keyboard": "0.7.
|
|
41
|
-
"@dxos/
|
|
42
|
-
"@dxos/
|
|
43
|
-
"@dxos/
|
|
44
|
-
"@dxos/plugin-
|
|
45
|
-
"@dxos/plugin-
|
|
46
|
-
"@dxos/react-client": "0.7.
|
|
43
|
+
"@dxos/app-framework": "0.7.5-main.9d26e3a",
|
|
44
|
+
"@dxos/app-graph": "0.7.5-main.9d26e3a",
|
|
45
|
+
"@dxos/debug": "0.7.5-main.9d26e3a",
|
|
46
|
+
"@dxos/echo-schema": "0.7.5-main.9d26e3a",
|
|
47
|
+
"@dxos/keyboard": "0.7.5-main.9d26e3a",
|
|
48
|
+
"@dxos/local-storage": "0.7.5-main.9d26e3a",
|
|
49
|
+
"@dxos/plugin-client": "0.7.5-main.9d26e3a",
|
|
50
|
+
"@dxos/live-object": "0.7.5-main.9d26e3a",
|
|
51
|
+
"@dxos/plugin-space": "0.7.5-main.9d26e3a",
|
|
52
|
+
"@dxos/plugin-graph": "0.7.5-main.9d26e3a",
|
|
53
|
+
"@dxos/react-client": "0.7.5-main.9d26e3a"
|
|
47
54
|
},
|
|
48
55
|
"devDependencies": {
|
|
49
56
|
"@phosphor-icons/react": "^2.1.5",
|
|
@@ -55,17 +62,17 @@
|
|
|
55
62
|
"react-floater": "0.7.9",
|
|
56
63
|
"type-fest": "4.10.1",
|
|
57
64
|
"vite": "5.4.7",
|
|
58
|
-
"@dxos/random": "0.7.
|
|
59
|
-
"@dxos/react-ui": "0.7.
|
|
60
|
-
"@dxos/react-ui-theme": "0.7.
|
|
61
|
-
"@dxos/storybook-utils": "0.7.
|
|
65
|
+
"@dxos/random": "0.7.5-main.9d26e3a",
|
|
66
|
+
"@dxos/react-ui": "0.7.5-main.9d26e3a",
|
|
67
|
+
"@dxos/react-ui-theme": "0.7.5-main.9d26e3a",
|
|
68
|
+
"@dxos/storybook-utils": "0.7.5-main.9d26e3a"
|
|
62
69
|
},
|
|
63
70
|
"peerDependencies": {
|
|
64
71
|
"@phosphor-icons/react": "^2.1.5",
|
|
65
72
|
"react": "~18.2.0",
|
|
66
73
|
"react-dom": "~18.2.0",
|
|
67
|
-
"@dxos/react-ui": "0.7.
|
|
68
|
-
"@dxos/react-ui-theme": "0.7.
|
|
74
|
+
"@dxos/react-ui": "0.7.5-main.9d26e3a",
|
|
75
|
+
"@dxos/react-ui-theme": "0.7.5-main.9d26e3a"
|
|
69
76
|
},
|
|
70
77
|
"publishConfig": {
|
|
71
78
|
"access": "public"
|
package/src/HelpPlugin.tsx
CHANGED
|
@@ -4,15 +4,29 @@
|
|
|
4
4
|
|
|
5
5
|
import React from 'react';
|
|
6
6
|
|
|
7
|
-
import {
|
|
7
|
+
import {
|
|
8
|
+
resolvePlugin,
|
|
9
|
+
type PluginDefinition,
|
|
10
|
+
parseIntentPlugin,
|
|
11
|
+
LayoutAction,
|
|
12
|
+
createSurface,
|
|
13
|
+
createResolver,
|
|
14
|
+
createIntent,
|
|
15
|
+
} from '@dxos/app-framework';
|
|
8
16
|
import { createExtension, type Node } from '@dxos/app-graph';
|
|
9
17
|
import { create } from '@dxos/live-object';
|
|
10
18
|
import { LocalStorageStore } from '@dxos/local-storage';
|
|
11
19
|
|
|
12
|
-
import {
|
|
13
|
-
|
|
20
|
+
import {
|
|
21
|
+
HelpContextProvider,
|
|
22
|
+
SHORTCUTS_DIALOG,
|
|
23
|
+
ShortcutsDialogContent,
|
|
24
|
+
ShortcutsHints,
|
|
25
|
+
ShortcutsList,
|
|
26
|
+
} from './components';
|
|
27
|
+
import meta, { HELP_PLUGIN } from './meta';
|
|
14
28
|
import translations from './translations';
|
|
15
|
-
import { type Step, type HelpPluginProvides } from './types';
|
|
29
|
+
import { type Step, type HelpPluginProvides, HelpAction } from './types';
|
|
16
30
|
|
|
17
31
|
export type HelpSettingsProps = { showHints?: boolean; showWelcome?: boolean };
|
|
18
32
|
|
|
@@ -48,20 +62,17 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<
|
|
|
48
62
|
translations,
|
|
49
63
|
graph: {
|
|
50
64
|
builder: (plugins) => {
|
|
51
|
-
const
|
|
65
|
+
const dispatch = resolvePlugin(plugins, parseIntentPlugin)?.provides.intent.dispatchPromise;
|
|
52
66
|
|
|
53
67
|
return createExtension({
|
|
54
68
|
id: HELP_PLUGIN,
|
|
55
69
|
filter: (node): node is Node<null> => node.id === 'root',
|
|
56
70
|
actions: () => [
|
|
57
71
|
{
|
|
58
|
-
id: HelpAction.
|
|
72
|
+
id: HelpAction.Start._tag,
|
|
59
73
|
data: async () => {
|
|
60
74
|
settings.values.showHints = true;
|
|
61
|
-
await
|
|
62
|
-
plugin: HELP_PLUGIN,
|
|
63
|
-
action: HelpAction.START,
|
|
64
|
-
});
|
|
75
|
+
await dispatch?.(createIntent(HelpAction.Start));
|
|
65
76
|
},
|
|
66
77
|
properties: {
|
|
67
78
|
label: ['open help tour', { ns: HELP_PLUGIN }],
|
|
@@ -79,13 +90,9 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<
|
|
|
79
90
|
id: 'dxos.org/plugin/help/open-shortcuts',
|
|
80
91
|
data: async () => {
|
|
81
92
|
settings.values.showHints = true;
|
|
82
|
-
await
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
element: 'dialog',
|
|
86
|
-
component: `${HELP_PLUGIN}/Shortcuts`,
|
|
87
|
-
},
|
|
88
|
-
});
|
|
93
|
+
await dispatch?.(
|
|
94
|
+
createIntent(LayoutAction.SetLayout, { element: 'dialog', component: SHORTCUTS_DIALOG }),
|
|
95
|
+
);
|
|
89
96
|
},
|
|
90
97
|
properties: {
|
|
91
98
|
label: ['open shortcuts label', { ns: HELP_PLUGIN }],
|
|
@@ -100,30 +107,30 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<
|
|
|
100
107
|
},
|
|
101
108
|
},
|
|
102
109
|
surface: {
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
110
|
+
definitions: () => [
|
|
111
|
+
createSurface({
|
|
112
|
+
id: `${HELP_PLUGIN}/hints`,
|
|
113
|
+
role: 'hints',
|
|
114
|
+
component: () => <ShortcutsHints />,
|
|
115
|
+
}),
|
|
116
|
+
createSurface({
|
|
117
|
+
id: `${HELP_PLUGIN}/keyshortcuts`,
|
|
118
|
+
role: 'keyshortcuts',
|
|
119
|
+
component: () => <ShortcutsList />,
|
|
120
|
+
}),
|
|
121
|
+
createSurface({
|
|
122
|
+
id: SHORTCUTS_DIALOG,
|
|
123
|
+
role: 'dialog',
|
|
124
|
+
filter: (data): data is any => data.component === SHORTCUTS_DIALOG,
|
|
125
|
+
component: () => <ShortcutsDialogContent />,
|
|
126
|
+
}),
|
|
127
|
+
],
|
|
118
128
|
},
|
|
119
129
|
intent: {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
break;
|
|
125
|
-
}
|
|
126
|
-
},
|
|
130
|
+
resolvers: () =>
|
|
131
|
+
createResolver(HelpAction.Start, () => {
|
|
132
|
+
state.running = true;
|
|
133
|
+
}),
|
|
127
134
|
},
|
|
128
135
|
},
|
|
129
136
|
};
|
|
@@ -9,6 +9,8 @@ import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
|
|
|
9
9
|
import { ShortcutsList } from './ShortcutsList';
|
|
10
10
|
import { HELP_PLUGIN } from '../../meta';
|
|
11
11
|
|
|
12
|
+
export const SHORTCUTS_DIALOG = `${HELP_PLUGIN}/ShortcutsDialog`;
|
|
13
|
+
|
|
12
14
|
export const ShortcutsDialogContent = () => {
|
|
13
15
|
const { t } = useTranslation(HELP_PLUGIN);
|
|
14
16
|
|
package/src/meta.ts
CHANGED
package/src/types.ts
CHANGED
|
@@ -12,6 +12,9 @@ import {
|
|
|
12
12
|
type SurfaceProvides,
|
|
13
13
|
type TranslationsProvides,
|
|
14
14
|
} from '@dxos/app-framework';
|
|
15
|
+
import { S } from '@dxos/echo-schema';
|
|
16
|
+
|
|
17
|
+
import { HELP_PLUGIN } from './meta';
|
|
15
18
|
|
|
16
19
|
export type Step = BaseStep & {
|
|
17
20
|
before?: (context: { plugins: Plugin[]; step: Step }) => void;
|
|
@@ -36,3 +39,11 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
|
|
|
36
39
|
});
|
|
37
40
|
|
|
38
41
|
export type HelpPluginProvides = GraphBuilderProvides & IntentResolverProvides & SurfaceProvides & TranslationsProvides;
|
|
42
|
+
|
|
43
|
+
export const HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
44
|
+
export namespace HelpAction {
|
|
45
|
+
export class Start extends S.TaggedClass<Start>()(`${HELP_ACTION}/start`, {
|
|
46
|
+
input: S.Void,
|
|
47
|
+
output: S.Void,
|
|
48
|
+
}) {}
|
|
49
|
+
}
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// packages/plugins/plugin-help/src/meta.ts
|
|
2
|
-
var HELP_PLUGIN = "dxos.org/plugin/help";
|
|
3
|
-
var meta_default = {
|
|
4
|
-
id: HELP_PLUGIN,
|
|
5
|
-
name: "Help",
|
|
6
|
-
icon: "ph--info--regular"
|
|
7
|
-
};
|
|
8
|
-
var HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
9
|
-
var HelpAction;
|
|
10
|
-
(function(HelpAction2) {
|
|
11
|
-
HelpAction2[HelpAction2["START"] = `${HELP_ACTION}/start`] = "START";
|
|
12
|
-
})(HelpAction || (HelpAction = {}));
|
|
13
|
-
|
|
14
|
-
export {
|
|
15
|
-
HELP_PLUGIN,
|
|
16
|
-
meta_default,
|
|
17
|
-
HelpAction
|
|
18
|
-
};
|
|
19
|
-
//# sourceMappingURL=chunk-2EMBCGD5.mjs.map
|