@dxos/plugin-help 0.6.13 → 0.6.14-main.7bd9c89
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-2EMBCGD5.mjs +19 -0
- package/dist/lib/browser/chunk-2EMBCGD5.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +24 -29
- package/dist/lib/browser/index.mjs.map +3 -3
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/meta.mjs +1 -1
- package/dist/types/src/HelpPlugin.d.ts.map +1 -1
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.d.ts +3 -2
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.d.ts.map +1 -1
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.stories.d.ts +5 -26
- package/dist/types/src/components/HelpContextProvider/HelpContextProvider.stories.d.ts.map +1 -1
- package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts +1 -1
- package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
- package/dist/types/src/components/Shortcuts/ShortcutsSection.d.ts.map +1 -1
- package/dist/types/src/meta.d.ts +2 -9
- package/dist/types/src/meta.d.ts.map +1 -1
- package/package.json +20 -20
- package/src/HelpPlugin.tsx +3 -8
- package/src/components/HelpContextProvider/HelpContextProvider.stories.tsx +22 -21
- package/src/components/HelpContextProvider/HelpContextProvider.tsx +7 -1
- package/src/components/Shortcuts/ShortcutsHints.tsx +18 -21
- package/src/components/Shortcuts/ShortcutsSection.tsx +1 -0
- package/src/meta.ts +19 -0
- package/dist/lib/browser/chunk-DI4HXWTJ.mjs +0 -23
- package/dist/lib/browser/chunk-DI4HXWTJ.mjs.map +0 -7
- package/src/meta.tsx +0 -23
|
@@ -0,0 +1,19 @@
|
|
|
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
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 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\nconst HELP_ACTION = `${HELP_PLUGIN}/action`;\nexport enum HelpAction {\n START = `${HELP_ACTION}/start`,\n}\n"],
|
|
5
|
+
"mappings": ";AAOO,IAAMA,cAAc;AAE3B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;EACNC,MAAM;AACR;AAEA,IAAMC,cAAc,GAAGJ,WAAAA;;UACXK,aAAAA;qCACF,GAAGD,WAAAA,QAAmB,IAAA;GADpBC,eAAAA,aAAAA,CAAAA,EAAAA;",
|
|
6
|
+
"names": ["HELP_PLUGIN", "id", "name", "icon", "HELP_ACTION", "HelpAction"]
|
|
7
|
+
}
|
|
@@ -2,10 +2,9 @@ import {
|
|
|
2
2
|
HELP_PLUGIN,
|
|
3
3
|
HelpAction,
|
|
4
4
|
meta_default
|
|
5
|
-
} from "./chunk-
|
|
5
|
+
} from "./chunk-2EMBCGD5.mjs";
|
|
6
6
|
|
|
7
7
|
// packages/plugins/plugin-help/src/HelpPlugin.tsx
|
|
8
|
-
import { Keyboard as KeyboardIcon, Info } from "@phosphor-icons/react";
|
|
9
8
|
import React8 from "react";
|
|
10
9
|
import { resolvePlugin as resolvePlugin2, parseIntentPlugin, LayoutAction } from "@dxos/app-framework";
|
|
11
10
|
import { createExtension } from "@dxos/app-graph";
|
|
@@ -332,13 +331,21 @@ var ShortcutsDialogContent = () => {
|
|
|
332
331
|
};
|
|
333
332
|
|
|
334
333
|
// packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx
|
|
335
|
-
import { X as X2 } from "@phosphor-icons/react";
|
|
336
334
|
import React6 from "react";
|
|
337
335
|
import { Keyboard as Keyboard2 } from "@dxos/keyboard";
|
|
338
|
-
import { Button as Button3,
|
|
339
|
-
|
|
340
|
-
var ShortcutsHints = ({ onClose }) => {
|
|
336
|
+
import { Button as Button3, Icon as Icon2, toLocalizedString as toLocalizedString2, useTranslation as useTranslation3 } from "@dxos/react-ui";
|
|
337
|
+
var Shortcut = ({ binding }) => {
|
|
341
338
|
const { t } = useTranslation3("os");
|
|
339
|
+
return /* @__PURE__ */ React6.createElement("div", {
|
|
340
|
+
role: "none",
|
|
341
|
+
className: "flex items-center gap-2 whitespace-nowrap"
|
|
342
|
+
}, /* @__PURE__ */ React6.createElement(Key, {
|
|
343
|
+
binding: binding.shortcut
|
|
344
|
+
}), /* @__PURE__ */ React6.createElement("span", {
|
|
345
|
+
className: "text-sm"
|
|
346
|
+
}, toLocalizedString2(binding.data, t)));
|
|
347
|
+
};
|
|
348
|
+
var ShortcutsHints = ({ onClose }) => {
|
|
342
349
|
const defaults = [
|
|
343
350
|
"meta+k",
|
|
344
351
|
"meta+/",
|
|
@@ -346,28 +353,20 @@ var ShortcutsHints = ({ onClose }) => {
|
|
|
346
353
|
];
|
|
347
354
|
const bindings = Keyboard2.singleton.getBindings();
|
|
348
355
|
const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
className: "flex items-center gap-2"
|
|
353
|
-
}, /* @__PURE__ */ React6.createElement(Key, {
|
|
354
|
-
binding: binding.shortcut
|
|
355
|
-
}), /* @__PURE__ */ React6.createElement("span", {
|
|
356
|
-
className: "text-sm"
|
|
357
|
-
}, toLocalizedString2(binding.data, t)));
|
|
358
|
-
};
|
|
359
|
-
return /* @__PURE__ */ React6.createElement(DensityProvider, {
|
|
360
|
-
density: "fine"
|
|
361
|
-
}, /* @__PURE__ */ React6.createElement("div", {
|
|
362
|
-
className: mx4("flex items-center border rounded px-2 gap-4", fixedBorder, groupSurface)
|
|
356
|
+
return /* @__PURE__ */ React6.createElement("div", {
|
|
357
|
+
role: "none",
|
|
358
|
+
className: "flex overflow-hidden px-2 gap-4"
|
|
363
359
|
}, hints.map((binding) => /* @__PURE__ */ React6.createElement(Shortcut, {
|
|
364
360
|
key: binding.shortcut,
|
|
365
361
|
binding
|
|
366
|
-
})), /* @__PURE__ */ React6.createElement(Button3, {
|
|
362
|
+
})), onClose && /* @__PURE__ */ React6.createElement(Button3, {
|
|
367
363
|
variant: "ghost",
|
|
368
364
|
classNames: "p-0 cursor-pointer",
|
|
369
365
|
onClick: onClose
|
|
370
|
-
}, /* @__PURE__ */ React6.createElement(
|
|
366
|
+
}, /* @__PURE__ */ React6.createElement(Icon2, {
|
|
367
|
+
icon: "ph--x--regular",
|
|
368
|
+
size: 4
|
|
369
|
+
})));
|
|
371
370
|
};
|
|
372
371
|
|
|
373
372
|
// packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsSection.tsx
|
|
@@ -456,8 +455,7 @@ var HelpPlugin = ({ steps = [] }) => {
|
|
|
456
455
|
ns: HELP_PLUGIN
|
|
457
456
|
}
|
|
458
457
|
],
|
|
459
|
-
icon:
|
|
460
|
-
iconSymbol: "ph--info--regular",
|
|
458
|
+
icon: "ph--info--regular",
|
|
461
459
|
keyBinding: {
|
|
462
460
|
macos: "shift+meta+/",
|
|
463
461
|
// TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
|
|
@@ -486,8 +484,7 @@ var HelpPlugin = ({ steps = [] }) => {
|
|
|
486
484
|
ns: HELP_PLUGIN
|
|
487
485
|
}
|
|
488
486
|
],
|
|
489
|
-
icon:
|
|
490
|
-
iconSymbol: "ph--keyboard--regular",
|
|
487
|
+
icon: "ph--keyboard--regular",
|
|
491
488
|
keyBinding: {
|
|
492
489
|
macos: "meta+ctrl+/"
|
|
493
490
|
}
|
|
@@ -501,9 +498,7 @@ var HelpPlugin = ({ steps = [] }) => {
|
|
|
501
498
|
component: ({ data, role }) => {
|
|
502
499
|
switch (role) {
|
|
503
500
|
case "hints":
|
|
504
|
-
return
|
|
505
|
-
onClose: () => settings.values.showHints = false
|
|
506
|
-
}) : null;
|
|
501
|
+
return /* @__PURE__ */ React8.createElement(ShortcutsHints, null);
|
|
507
502
|
case "keyshortcuts":
|
|
508
503
|
return /* @__PURE__ */ React8.createElement(ShortcutsList, null);
|
|
509
504
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/HelpPlugin.tsx", "../../../src/components/HelpContextProvider/HelpContextProvider.tsx", "../../../src/types.ts", "../../../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 { type IconProps, Keyboard as KeyboardIcon, Info } from '@phosphor-icons/react';\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/echo-schema';\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', storageKey: 'show-hints', type: LocalStorageStore.bool({ allowUndefined: true }) })\n .prop({\n key: 'showWelcome',\n storageKey: 'show-welcome',\n type: LocalStorageStore.bool({ allowUndefined: true }),\n });\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: (props: IconProps) => <Info {...props} />,\n iconSymbol: '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: (props: IconProps) => <KeyboardIcon {...props} />,\n iconSymbol: '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 settings.values.showHints ? (\n <ShortcutsHints onClose={() => (settings.values.showHints = false)} />\n ) : null;\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';\nimport { useShellDisplay, ShellDisplay } from '@dxos/react-client';\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 const HelpContextProvider = ({\n children,\n steps: initialSteps,\n running: runningProp,\n onRunningChanged,\n}: PropsWithChildren<{ steps: Step[]; running?: boolean; onRunningChanged?: (state: boolean) => any }>) => {\n const shellDisplay = useShellDisplay();\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 = shellDisplay !== ShellDisplay.NONE || 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 { X } from '@phosphor-icons/react';\nimport React from 'react';\n\nimport { type KeyBinding, Keyboard } from '@dxos/keyboard';\nimport { Button, DensityProvider, toLocalizedString, useTranslation } from '@dxos/react-ui';\nimport { fixedBorder, groupSurface, mx } from '@dxos/react-ui-theme';\n\nimport { Key } from './Key';\n\nexport const ShortcutsHints = ({ onClose }: { onClose: () => void }) => {\n const { t } = useTranslation('os');\n\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 const Shortcut = ({ binding }: { binding: KeyBinding }) => {\n return (\n <div role='none' className='flex items-center gap-2'>\n <Key binding={binding.shortcut} />\n <span className='text-sm'>{toLocalizedString(binding.data, t)}</span>\n </div>\n );\n };\n\n return (\n <DensityProvider density='fine'>\n <div className={mx('flex items-center border rounded px-2 gap-4', fixedBorder, groupSurface)}>\n {hints.map((binding) => (\n <Shortcut key={binding.shortcut} binding={binding} />\n ))}\n <Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>\n <X />\n </Button>\n </div>\n </DensityProvider>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\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,
|
|
6
|
-
"names": ["
|
|
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/echo-schema';\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', storageKey: 'show-hints', type: LocalStorageStore.bool({ allowUndefined: true }) })\n .prop({\n key: 'showWelcome',\n storageKey: 'show-welcome',\n type: LocalStorageStore.bool({ allowUndefined: true }),\n });\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';\nimport { useShellDisplay, ShellDisplay } from '@dxos/react-client';\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 shellDisplay = useShellDisplay();\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 = shellDisplay !== ShellDisplay.NONE || 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": ";;;;;;;AAIA,OAAOA,YAAW;AAElB,SAASC,iBAAAA,gBAAsCC,mBAAmBC,oBAAoB;AACtF,SAASC,uBAAkC;AAC3C,SAASC,cAAc;AACvB,SAASC,yBAAyB;;;ACLlC,OAAOC,UAAiCC,UAAUC,iBAAiB;AACnE,OAAOC,WAAWC,SAASC,cAAc;AAEzC,SAASC,YAAYC,eAAeC,yBAAyB;AAC7D,SAASC,iBAAiBC,oBAAoB;;;ACJ9C,SAAuBC,qBAAqB;AAwBrC,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;;;AC/BA,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;;;AFhGF,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,QAAMC,eAAeC,gBAAAA;AACrB,QAAM,EAAEC,QAAO,IAAKC,WAAAA;AACpB,QAAMC,eAAeC,cAAcH,SAASI,iBAAAA;AAC5C,QAAM,CAACT,SAASU,UAAAA,IAAcC,SAAS,CAAC,CAACV,eAAe,CAAC,CAACtB,UAAUoB,aAAa,CAAA,CAAE,CAAA;AACnF,QAAM,CAACa,WAAWC,aAAAA,IAAiBF,SAAS,CAAA;AAC5C,QAAM,CAACb,OAAOgB,QAAAA,IAAYH,SAASZ,YAAAA;AAEnC,QAAMgB,SAASZ,iBAAiBa,aAAaC,QAAQV,cAAcW,SAASC,OAAOC;AAEnF,QAAMC,eAAe,CAACC,UAAAA;AACpB,QAAIrB,aAAa;AACf,YAAMrB,OAAOkB,MAAMwB,KAAAA;AACnB1C,YAAM2C,SAAS;QAAElB;QAASzB;MAAK,CAAA;IACjC;AACAiC,kBAAcS,KAAAA;EAChB;AAEA,QAAME,oBAAoB,CAACC,UAAAA;AACzB,QAAI,OAAOxB,gBAAgB,aAAa;AACtCC,yBAAmBuB,KAAAA;IACrB,OAAO;AACL,UAAIA,OAAO;AACTJ,qBAAa,CAAA;AACbX,mBAAW,IAAA;MACb,OAAO;AACLA,mBAAW,KAAA;MACb;IACF;EACF;AAEAgB,YAAU,MAAA;AACR,UAAMC,UAAUC,WAAW,YAAA;AACzB,UAAI3B,aAAa;AAGf,cAAMpB,cAAciB,MAAMc,SAAAA,CAAU;AACpCS,qBAAa,CAAA;AACbX,mBAAW,IAAA;MACb,WAAW,OAAOT,gBAAgB,aAAa;AAC7CS,mBAAW,KAAA;MACb;IACF,CAAA;AAEA,WAAO,MAAMmB,aAAaF,OAAAA;EAC5B,GAAG;IAAC1B;GAAY;AAGhB,QAAM6B,WAAgC,OAAOC,YAAAA;AAC3C,UAAM,EAAEC,MAAMC,QAAQX,OAAOY,KAAI,IAAKH;AACtC,YAAQC,MAAAA;MACN,KAAKG,OAAOC;AACVlE,qBAAa6D,QAAQnD,KAAKT,MAAM;AAChC;MACF,KAAKgE,OAAOE;AACV;MACF,KAAKF,OAAOG;AACV7D,0BAAkBsD,QAAQnD,KAAKT,MAAM;AACrC,gBAAQ8D,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;MACL9C,SAASA,WAAW,CAACe;MACrBjB;MACAgB;MACAiC,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;IACZtD;IACAc;IACAyC,KAAKrD,WAAW,CAACe;IACjBe;IACAwB;IACAC,kBAAkBC;MAEnB3D,QAAAA;AAGP;;;AG7KA,OAAO4D,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,yBAAyB,MAAA;AACpC,QAAM,EAAEC,EAAC,IAAKC,gBAAeC,WAAAA;AAE7B,SACE,gBAAAC,OAAA,cAACC,OAAOC,SAAO;IAACC,YAAW;KACzB,gBAAAH,OAAA,cAACI,OAAAA;IAAIC,MAAK;IAAOC,WAAU;KACzB,gBAAAN,OAAA,cAACC,OAAOM,OAAK,MAAEV,EAAE,wBAAA,CAAA,GAEjB,gBAAAG,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;;;AI3BA,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;;;;AVIK,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,YAAY;QAAcC,MAAMZ,kBAAkBa,KAAK;UAAEC,gBAAgB;QAAK,CAAA;MAAG,CAAA,EAC1GL,KAAK;QACJC,KAAK;QACLC,YAAY;QACZC,MAAMZ,kBAAkBa,KAAK;UAAEC,gBAAgB;QAAK,CAAA;MACtD,CAAA;IACJ;IACAC,UAAU;MACRC,SAAS,CAAC,EAAEC,SAAQ,MAAE;AACpB,eACE,gBAAAC,OAAA,cAACC,qBAAAA;UACCrB;UACAQ,SAASF,MAAME;UACfc,kBAAkB,CAACC,aAAAA;AACjBjB,kBAAME,UAAUe;AAChB,gBAAI,CAACA,UAAU;AACbtB,uBAASuB,OAAOpB,YAAY;YAC9B;UACF;WAECe,QAAAA;MAGP;MACAM;MACAC,OAAO;QACLC,SAAS,CAACC,YAAAA;AACR,gBAAMC,eAAeC,eAAcF,SAASG,iBAAAA;AAE5C,iBAAOC,gBAAgB;YACrBC,IAAI9B;YACJ+B,QAAQ,CAACC,SAA6BA,KAAKF,OAAO;YAClDG,SAAS,MAAM;cACb;gBACEH,IAAII,WAAWC;gBACfC,MAAM,YAAA;AACJtC,2BAASuB,OAAOpB,YAAY;AAC5B,wBAAMyB,cAAcZ,SAASuB,OAAOC,SAAS;oBAC3CC,QAAQvC;oBACRwC,QAAQN,WAAWC;kBACrB,CAAA;gBACF;gBACAM,YAAY;kBACVC,OAAO;oBAAC;oBAAkB;sBAAEC,IAAI3C;oBAAY;;kBAC5C4C,MAAM;kBACNC,YAAY;oBACVC,OAAO;;oBAEPC,SAAS;oBACTC,OAAO;kBACT;kBACAC,QAAQ;gBACV;cACF;cACA;gBACEnB,IAAI;gBACJM,MAAM,YAAA;AACJtC,2BAASuB,OAAOpB,YAAY;AAC5B,wBAAMyB,cAAcZ,SAASuB,OAAOC,SAAS;oBAC3CE,QAAQU,aAAaC;oBACrBf,MAAM;sBACJgB,SAAS;sBACTC,WAAW,GAAGrD,WAAAA;oBAChB;kBACF,CAAA;gBACF;gBACAyC,YAAY;kBACVC,OAAO;oBAAC;oBAAwB;sBAAEC,IAAI3C;oBAAY;;kBAClD4C,MAAM;kBACNC,YAAY;oBACVC,OAAO;kBACT;gBACF;cACF;;UAEJ,CAAA;QACF;MACF;MACAQ,SAAS;QACPD,WAAW,CAAC,EAAEjB,MAAMmB,KAAI,MAAE;AACxB,kBAAQA,MAAAA;YACN,KAAK;AACH,qBAAO,gBAAAtC,OAAA,cAACuC,gBAAAA,IAAAA;YACV,KAAK;AACH,qBAAO,gBAAAvC,OAAA,cAACwC,eAAAA,IAAAA;UACZ;AAEA,kBAAQrB,KAAKiB,WAAS;YACpB,KAAK,GAAGrD,WAAAA;AACN,qBAAO,gBAAAiB,OAAA,cAACyC,wBAAAA,IAAAA;UACZ;AAEA,iBAAO;QACT;MACF;MACArB,QAAQ;QACNsB,UAAU,OAAOtB,WAAAA;AACf,kBAAQA,OAAOG,QAAM;YACnB,KAAKN,WAAWC;AACdhC,oBAAME,UAAU;AAChB;UACJ;QACF;MACF;IACF;EACF;AACF;;;AWjIA,SAASuD,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", "createExtension", "create", "LocalStorageStore", "React", "useState", "useEffect", "Joyride", "ACTIONS", "EVENTS", "usePlugins", "resolvePlugin", "parseLayoutPlugin", "useShellDisplay", "ShellDisplay", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "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", "shellDisplay", "useShellDisplay", "plugins", "usePlugins", "layoutPlugin", "resolvePlugin", "parseLayoutPlugin", "setRunning", "useState", "stepIndex", "_setStepIndex", "setSteps", "paused", "ShellDisplay", "NONE", "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", "ShortcutsDialogContent", "t", "useTranslation", "HELP_PLUGIN", "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", "storageKey", "type", "bool", "allowUndefined", "provides", "context", "children", "React", "HelpContextProvider", "onRunningChanged", "newState", "values", "translations", "graph", "builder", "plugins", "intentPlugin", "resolvePlugin", "parseIntentPlugin", "createExtension", "id", "filter", "node", "actions", "HelpAction", "START", "data", "intent", "dispatch", "plugin", "action", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "SET_LAYOUT", "element", "component", "surface", "role", "ShortcutsHints", "ShortcutsList", "ShortcutsDialogContent", "resolver", "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":18014,"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":"@dxos/react-client","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.tsx":{"bytes":2299,"imports":[{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true}],"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.tsx","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.tsx","kind":"import-statement","original":"../../meta"}],"format":"esm"},"packages/plugins/plugin-help/src/components/Shortcuts/ShortcutsHints.tsx":{"bytes":5707,"imports":[{"path":"@phosphor-icons/react","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":"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":1503,"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.tsx","kind":"import-statement","original":"./meta"}],"format":"esm"},"packages/plugins/plugin-help/src/HelpPlugin.tsx":{"bytes":17890,"imports":[{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"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/echo-schema","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.tsx","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":35616},"packages/plugins/plugin-help/dist/lib/browser/index.mjs":{"imports":[{"path":"packages/plugins/plugin-help/dist/lib/browser/chunk-DI4HXWTJ.mjs","kind":"import-statement"},{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"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/echo-schema","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":"@dxos/react-client","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":"@phosphor-icons/react","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/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":4562},"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx":{"bytesInOutput":4192},"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":1552},"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":18619},"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-DI4HXWTJ.mjs","kind":"import-statement"}],"exports":["HELP_PLUGIN","HelpAction","default"],"entryPoint":"packages/plugins/plugin-help/src/meta.tsx","inputs":{},"bytes":185},"packages/plugins/plugin-help/dist/lib/browser/chunk-DI4HXWTJ.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":1110},"packages/plugins/plugin-help/dist/lib/browser/chunk-DI4HXWTJ.mjs":{"imports":[{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true}],"exports":["HELP_PLUGIN","HelpAction","meta_default"],"inputs":{"packages/plugins/plugin-help/src/meta.tsx":{"bytesInOutput":541}},"bytes":687}}}
|
|
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":18118,"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":"@dxos/react-client","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":16579,"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/echo-schema","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":34656},"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/echo-schema","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":"@dxos/react-client","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":4185},"packages/plugins/plugin-help/src/components/HelpContextProvider/HelpContextProvider.tsx":{"bytesInOutput":4192},"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":18057},"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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HelpPlugin.d.ts","sourceRoot":"","sources":["../../../src/HelpPlugin.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"HelpPlugin.d.ts","sourceRoot":"","sources":["../../../src/HelpPlugin.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAiB,KAAK,gBAAgB,EAAmC,MAAM,qBAAqB,CAAC;AAQ5G,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7D,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,CAiHjG,CAAC"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import React, { type PropsWithChildren } from 'react';
|
|
2
2
|
import { type Step } from '../../types';
|
|
3
|
-
export
|
|
3
|
+
export type HelpContextProviderProps = PropsWithChildren<{
|
|
4
4
|
steps: Step[];
|
|
5
5
|
running?: boolean;
|
|
6
6
|
onRunningChanged?: (state: boolean) => any;
|
|
7
|
-
}
|
|
7
|
+
}>;
|
|
8
|
+
export declare const HelpContextProvider: ({ children, steps: initialSteps, running: runningProp, onRunningChanged, }: HelpContextProviderProps) => React.JSX.Element;
|
|
8
9
|
//# sourceMappingURL=HelpContextProvider.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HelpContextProvider.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/HelpContextProvider.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAE,KAAK,iBAAiB,EAAuB,MAAM,OAAO,CAAC;AAM3E,OAAO,EAAE,KAAK,IAAI,EAAe,MAAM,aAAa,CAAC;AAkDrD,
|
|
1
|
+
{"version":3,"file":"HelpContextProvider.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/HelpContextProvider.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAE,KAAK,iBAAiB,EAAuB,MAAM,OAAO,CAAC;AAM3E,OAAO,EAAE,KAAK,IAAI,EAAe,MAAM,aAAa,CAAC;AAkDrD,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACvD,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC;CAC5C,CAAC,CAAC;AAEH,eAAO,MAAM,mBAAmB,+EAK7B,wBAAwB,sBA0G1B,CAAC"}
|
|
@@ -1,31 +1,10 @@
|
|
|
1
1
|
import '@dxos-theme';
|
|
2
|
-
import { type Meta } from '@
|
|
2
|
+
import { type Meta, type StoryObj } from '@storybook/react';
|
|
3
|
+
import { HelpContextProvider } from './HelpContextProvider';
|
|
4
|
+
export declare const Default: StoryObj<typeof HelpContextProvider>;
|
|
3
5
|
/**
|
|
4
|
-
* IMPORTANT:
|
|
6
|
+
* IMPORTANT: Run in separate tab.
|
|
5
7
|
*/
|
|
6
|
-
declare const meta: Meta
|
|
8
|
+
declare const meta: Meta<typeof HelpContextProvider>;
|
|
7
9
|
export default meta;
|
|
8
|
-
export declare const Default: {
|
|
9
|
-
args: {
|
|
10
|
-
steps: ({
|
|
11
|
-
target: string;
|
|
12
|
-
title: string;
|
|
13
|
-
content: string;
|
|
14
|
-
disableBeacon: boolean;
|
|
15
|
-
placement: string;
|
|
16
|
-
} | {
|
|
17
|
-
target: string;
|
|
18
|
-
title: string;
|
|
19
|
-
content: string;
|
|
20
|
-
disableBeacon?: undefined;
|
|
21
|
-
placement?: undefined;
|
|
22
|
-
} | {
|
|
23
|
-
target: string;
|
|
24
|
-
title: string;
|
|
25
|
-
content: string;
|
|
26
|
-
placement: string;
|
|
27
|
-
disableBeacon?: undefined;
|
|
28
|
-
})[];
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
10
|
//# sourceMappingURL=HelpContextProvider.stories.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HelpContextProvider.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/HelpContextProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"HelpContextProvider.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/HelpContextProvider/HelpContextProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAGrB,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAO5D,OAAO,EAAE,mBAAmB,EAAiC,MAAM,uBAAuB,CAAC;AAwD3F,eAAO,MAAM,OAAO,EAAE,QAAQ,CAAC,OAAO,mBAAmB,CA8BxD,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,mBAAmB,CAK1C,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ShortcutsHints.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsHints.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ShortcutsHints.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsHints.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAiB1B,eAAO,MAAM,cAAc,gBAAiB;IAAE,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,sBAkBnE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ShortcutsSection.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsSection.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ShortcutsSection.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsSection.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,eAAO,MAAM,gBAAgB,yBAM5B,CAAC"}
|
package/dist/types/src/meta.d.ts
CHANGED
|
@@ -1,15 +1,8 @@
|
|
|
1
|
-
import { type IconProps } from '@phosphor-icons/react';
|
|
2
|
-
import React from 'react';
|
|
3
1
|
export declare const HELP_PLUGIN = "dxos.org/plugin/help";
|
|
4
2
|
declare const _default: {
|
|
5
3
|
id: string;
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
description?: string;
|
|
9
|
-
homePage?: string;
|
|
10
|
-
tags?: string[];
|
|
11
|
-
iconComponent?: React.FC<IconProps>;
|
|
12
|
-
iconSymbol?: string;
|
|
4
|
+
name: string;
|
|
5
|
+
icon: string;
|
|
13
6
|
};
|
|
14
7
|
export default _default;
|
|
15
8
|
export declare enum HelpAction {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.
|
|
1
|
+
{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,WAAW,yBAAyB,CAAC;;;;;;AAElD,wBAIuB;AAGvB,oBAAY,UAAU;IACpB,KAAK,sCAAyB;CAC/B"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/plugin-help",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.14-main.7bd9c89",
|
|
4
4
|
"description": "Help plugin.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -32,16 +32,16 @@
|
|
|
32
32
|
"@fluentui/react-tabster": "^9.19.0",
|
|
33
33
|
"lodash.get": "^4.4.2",
|
|
34
34
|
"react-joyride": "^2.7.2",
|
|
35
|
-
"@dxos/app-framework": "0.6.
|
|
36
|
-
"@dxos/app-graph": "0.6.
|
|
37
|
-
"@dxos/debug": "0.6.
|
|
38
|
-
"@dxos/
|
|
39
|
-
"@dxos/
|
|
40
|
-
"@dxos/
|
|
41
|
-
"@dxos/
|
|
42
|
-
"@dxos/
|
|
43
|
-
"@dxos/
|
|
44
|
-
"@dxos/
|
|
35
|
+
"@dxos/app-framework": "0.6.14-main.7bd9c89",
|
|
36
|
+
"@dxos/app-graph": "0.6.14-main.7bd9c89",
|
|
37
|
+
"@dxos/debug": "0.6.14-main.7bd9c89",
|
|
38
|
+
"@dxos/keyboard": "0.6.14-main.7bd9c89",
|
|
39
|
+
"@dxos/local-storage": "0.6.14-main.7bd9c89",
|
|
40
|
+
"@dxos/plugin-client": "0.6.14-main.7bd9c89",
|
|
41
|
+
"@dxos/echo-schema": "0.6.14-main.7bd9c89",
|
|
42
|
+
"@dxos/plugin-graph": "0.6.14-main.7bd9c89",
|
|
43
|
+
"@dxos/react-client": "0.6.14-main.7bd9c89",
|
|
44
|
+
"@dxos/plugin-space": "0.6.14-main.7bd9c89"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"@phosphor-icons/react": "^2.1.5",
|
|
@@ -52,18 +52,18 @@
|
|
|
52
52
|
"react-dom": "~18.2.0",
|
|
53
53
|
"react-floater": "0.7.9",
|
|
54
54
|
"type-fest": "4.10.1",
|
|
55
|
-
"vite": "
|
|
56
|
-
"@dxos/random": "0.6.
|
|
57
|
-
"@dxos/react-ui": "0.6.
|
|
58
|
-
"@dxos/
|
|
59
|
-
"@dxos/
|
|
55
|
+
"vite": "5.4.7",
|
|
56
|
+
"@dxos/random": "0.6.14-main.7bd9c89",
|
|
57
|
+
"@dxos/react-ui-theme": "0.6.14-main.7bd9c89",
|
|
58
|
+
"@dxos/storybook-utils": "0.6.14-main.7bd9c89",
|
|
59
|
+
"@dxos/react-ui": "0.6.14-main.7bd9c89"
|
|
60
60
|
},
|
|
61
61
|
"peerDependencies": {
|
|
62
62
|
"@phosphor-icons/react": "^2.1.5",
|
|
63
|
-
"react": "
|
|
64
|
-
"react-dom": "
|
|
65
|
-
"@dxos/react-ui": "0.6.
|
|
66
|
-
"@dxos/react-ui
|
|
63
|
+
"react": "~18.2.0",
|
|
64
|
+
"react-dom": "~18.2.0",
|
|
65
|
+
"@dxos/react-ui-theme": "0.6.14-main.7bd9c89",
|
|
66
|
+
"@dxos/react-ui": "0.6.14-main.7bd9c89"
|
|
67
67
|
},
|
|
68
68
|
"publishConfig": {
|
|
69
69
|
"access": "public"
|
package/src/HelpPlugin.tsx
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
// Copyright 2023 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import { type IconProps, Keyboard as KeyboardIcon, Info } from '@phosphor-icons/react';
|
|
6
5
|
import React from 'react';
|
|
7
6
|
|
|
8
7
|
import { resolvePlugin, type PluginDefinition, parseIntentPlugin, LayoutAction } from '@dxos/app-framework';
|
|
@@ -70,8 +69,7 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<
|
|
|
70
69
|
},
|
|
71
70
|
properties: {
|
|
72
71
|
label: ['open help tour', { ns: HELP_PLUGIN }],
|
|
73
|
-
icon:
|
|
74
|
-
iconSymbol: 'ph--info--regular',
|
|
72
|
+
icon: 'ph--info--regular',
|
|
75
73
|
keyBinding: {
|
|
76
74
|
macos: 'shift+meta+/',
|
|
77
75
|
// TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
|
|
@@ -95,8 +93,7 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<
|
|
|
95
93
|
},
|
|
96
94
|
properties: {
|
|
97
95
|
label: ['open shortcuts label', { ns: HELP_PLUGIN }],
|
|
98
|
-
icon:
|
|
99
|
-
iconSymbol: 'ph--keyboard--regular',
|
|
96
|
+
icon: 'ph--keyboard--regular',
|
|
100
97
|
keyBinding: {
|
|
101
98
|
macos: 'meta+ctrl+/',
|
|
102
99
|
},
|
|
@@ -110,9 +107,7 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions): PluginDefinition<
|
|
|
110
107
|
component: ({ data, role }) => {
|
|
111
108
|
switch (role) {
|
|
112
109
|
case 'hints':
|
|
113
|
-
return
|
|
114
|
-
<ShortcutsHints onClose={() => (settings.values.showHints = false)} />
|
|
115
|
-
) : null;
|
|
110
|
+
return <ShortcutsHints />;
|
|
116
111
|
case 'keyshortcuts':
|
|
117
112
|
return <ShortcutsList />;
|
|
118
113
|
}
|
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
import '@dxos-theme';
|
|
6
6
|
|
|
7
7
|
import { Circle } from '@phosphor-icons/react';
|
|
8
|
-
import
|
|
9
|
-
import {
|
|
8
|
+
import { type Meta, type StoryObj } from '@storybook/react';
|
|
9
|
+
import React, { useState } from 'react';
|
|
10
10
|
|
|
11
11
|
import { faker } from '@dxos/random';
|
|
12
12
|
import { Button } from '@dxos/react-ui';
|
|
13
|
-
import {
|
|
13
|
+
import { withTheme } from '@dxos/storybook-utils';
|
|
14
14
|
|
|
15
|
-
import { HelpContextProvider } from './HelpContextProvider';
|
|
15
|
+
import { HelpContextProvider, type HelpContextProviderProps } from './HelpContextProvider';
|
|
16
16
|
import { useHelp } from '../../hooks';
|
|
17
17
|
|
|
18
18
|
const App = () => {
|
|
@@ -57,7 +57,7 @@ const App = () => {
|
|
|
57
57
|
);
|
|
58
58
|
};
|
|
59
59
|
|
|
60
|
-
const
|
|
60
|
+
const DefaultStory = ({ steps = [] }: HelpContextProviderProps) => (
|
|
61
61
|
<HelpContextProvider steps={steps}>
|
|
62
62
|
<div className='fixed inset-0 overflow-hidden'>
|
|
63
63
|
<App />
|
|
@@ -65,48 +65,49 @@ const Story: FC<{ steps?: Step[] }> = ({ steps = [] }) => (
|
|
|
65
65
|
</HelpContextProvider>
|
|
66
66
|
);
|
|
67
67
|
|
|
68
|
-
/**
|
|
69
|
-
* IMPORTANT: Storybook must be run in separate tab.
|
|
70
|
-
*/
|
|
71
|
-
const meta: Meta = {
|
|
72
|
-
title: 'plugin-help/Joyride',
|
|
73
|
-
render: (args: any) => <Story {...args} />,
|
|
74
|
-
decorators: [withTheme],
|
|
75
|
-
};
|
|
76
|
-
|
|
77
|
-
export default meta;
|
|
78
|
-
|
|
79
68
|
// TODO(burdon): Tour should prompt user to create a Stack -- and respond to it being created.
|
|
80
69
|
// Use beacon to simulate click.
|
|
81
70
|
|
|
82
|
-
export const Default = {
|
|
71
|
+
export const Default: StoryObj<typeof HelpContextProvider> = {
|
|
83
72
|
args: {
|
|
84
73
|
// https://docs.react-joyride.com/step#options
|
|
85
74
|
steps: [
|
|
86
75
|
{
|
|
87
76
|
target: '[data-joyride="basic/1"]',
|
|
88
|
-
title: 'Step 1',
|
|
77
|
+
title: 'plugins/Step 1',
|
|
89
78
|
content: faker.lorem.paragraph(),
|
|
90
79
|
disableBeacon: true,
|
|
91
80
|
placement: 'right',
|
|
92
81
|
},
|
|
93
82
|
{
|
|
94
83
|
target: '[data-joyride="basic/2"]',
|
|
95
|
-
title: 'Step 2',
|
|
84
|
+
title: 'plugins/Step 2',
|
|
96
85
|
content: faker.lorem.paragraph(),
|
|
97
86
|
},
|
|
98
87
|
{
|
|
99
88
|
target: '[data-joyride="basic/3"]',
|
|
100
|
-
title: 'Step 3',
|
|
89
|
+
title: 'plugins/Step 3',
|
|
101
90
|
content: faker.lorem.paragraph(),
|
|
102
91
|
placement: 'right',
|
|
103
92
|
},
|
|
104
93
|
{
|
|
105
94
|
target: '[data-joyride="basic/4"]',
|
|
106
|
-
title: 'Step 4',
|
|
95
|
+
title: 'plugins/Step 4',
|
|
107
96
|
content: faker.lorem.paragraph(),
|
|
108
97
|
placement: 'top-end',
|
|
109
98
|
},
|
|
110
99
|
],
|
|
111
100
|
},
|
|
112
101
|
};
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* IMPORTANT: Run in separate tab.
|
|
105
|
+
*/
|
|
106
|
+
const meta: Meta<typeof HelpContextProvider> = {
|
|
107
|
+
title: 'plugins/plugin-help/Joyride',
|
|
108
|
+
component: HelpContextProvider,
|
|
109
|
+
render: DefaultStory,
|
|
110
|
+
decorators: [withTheme],
|
|
111
|
+
};
|
|
112
|
+
|
|
113
|
+
export default meta;
|
|
@@ -58,12 +58,18 @@ const waitForTarget = async (step: Step) => {
|
|
|
58
58
|
}
|
|
59
59
|
};
|
|
60
60
|
|
|
61
|
+
export type HelpContextProviderProps = PropsWithChildren<{
|
|
62
|
+
steps: Step[];
|
|
63
|
+
running?: boolean;
|
|
64
|
+
onRunningChanged?: (state: boolean) => any;
|
|
65
|
+
}>;
|
|
66
|
+
|
|
61
67
|
export const HelpContextProvider = ({
|
|
62
68
|
children,
|
|
63
69
|
steps: initialSteps,
|
|
64
70
|
running: runningProp,
|
|
65
71
|
onRunningChanged,
|
|
66
|
-
}:
|
|
72
|
+
}: HelpContextProviderProps) => {
|
|
67
73
|
const shellDisplay = useShellDisplay();
|
|
68
74
|
const { plugins } = usePlugins();
|
|
69
75
|
const layoutPlugin = resolvePlugin(plugins, parseLayoutPlugin);
|
|
@@ -2,42 +2,39 @@
|
|
|
2
2
|
// Copyright 2023 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import { X } from '@phosphor-icons/react';
|
|
6
5
|
import React from 'react';
|
|
7
6
|
|
|
8
7
|
import { type KeyBinding, Keyboard } from '@dxos/keyboard';
|
|
9
|
-
import { Button,
|
|
10
|
-
import { fixedBorder, groupSurface, mx } from '@dxos/react-ui-theme';
|
|
8
|
+
import { Button, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';
|
|
11
9
|
|
|
12
10
|
import { Key } from './Key';
|
|
13
11
|
|
|
14
|
-
|
|
12
|
+
const Shortcut = ({ binding }: { binding: KeyBinding }) => {
|
|
15
13
|
const { t } = useTranslation('os');
|
|
14
|
+
return (
|
|
15
|
+
<div role='none' className='flex items-center gap-2 whitespace-nowrap'>
|
|
16
|
+
<Key binding={binding.shortcut} />
|
|
17
|
+
<span className='text-sm'>{toLocalizedString(binding.data, t)}</span>
|
|
18
|
+
</div>
|
|
19
|
+
);
|
|
20
|
+
};
|
|
16
21
|
|
|
22
|
+
export const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {
|
|
17
23
|
// TODO(burdon): Display by context/weight/cycle.
|
|
18
24
|
const defaults = ['meta+k', 'meta+/', 'meta+,'];
|
|
19
25
|
const bindings = Keyboard.singleton.getBindings();
|
|
20
26
|
const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));
|
|
21
27
|
|
|
22
|
-
const Shortcut = ({ binding }: { binding: KeyBinding }) => {
|
|
23
|
-
return (
|
|
24
|
-
<div role='none' className='flex items-center gap-2'>
|
|
25
|
-
<Key binding={binding.shortcut} />
|
|
26
|
-
<span className='text-sm'>{toLocalizedString(binding.data, t)}</span>
|
|
27
|
-
</div>
|
|
28
|
-
);
|
|
29
|
-
};
|
|
30
|
-
|
|
31
28
|
return (
|
|
32
|
-
<
|
|
33
|
-
|
|
34
|
-
{
|
|
35
|
-
|
|
36
|
-
|
|
29
|
+
<div role='none' className='flex overflow-hidden px-2 gap-4'>
|
|
30
|
+
{hints.map((binding) => (
|
|
31
|
+
<Shortcut key={binding.shortcut} binding={binding} />
|
|
32
|
+
))}
|
|
33
|
+
{onClose && (
|
|
37
34
|
<Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>
|
|
38
|
-
<
|
|
35
|
+
<Icon icon='ph--x--regular' size={4} />
|
|
39
36
|
</Button>
|
|
40
|
-
|
|
41
|
-
</
|
|
37
|
+
)}
|
|
38
|
+
</div>
|
|
42
39
|
);
|
|
43
40
|
};
|
package/src/meta.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2023 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { type PluginMeta } from '@dxos/app-framework';
|
|
6
|
+
|
|
7
|
+
// TODO(burdon): Rename Guide? Help?
|
|
8
|
+
export const HELP_PLUGIN = 'dxos.org/plugin/help';
|
|
9
|
+
|
|
10
|
+
export default {
|
|
11
|
+
id: HELP_PLUGIN,
|
|
12
|
+
name: 'Help',
|
|
13
|
+
icon: 'ph--info--regular',
|
|
14
|
+
} satisfies PluginMeta;
|
|
15
|
+
|
|
16
|
+
const HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
17
|
+
export enum HelpAction {
|
|
18
|
+
START = `${HELP_ACTION}/start`,
|
|
19
|
+
}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
// packages/plugins/plugin-help/src/meta.tsx
|
|
2
|
-
import { Info } from "@phosphor-icons/react";
|
|
3
|
-
import React from "react";
|
|
4
|
-
import { pluginMeta } from "@dxos/app-framework";
|
|
5
|
-
var HELP_PLUGIN = "dxos.org/plugin/help";
|
|
6
|
-
var meta_default = pluginMeta({
|
|
7
|
-
id: HELP_PLUGIN,
|
|
8
|
-
name: "Help",
|
|
9
|
-
iconComponent: (props) => /* @__PURE__ */ React.createElement(Info, props),
|
|
10
|
-
iconSymbol: "ph--info--regular"
|
|
11
|
-
});
|
|
12
|
-
var HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
13
|
-
var HelpAction;
|
|
14
|
-
(function(HelpAction2) {
|
|
15
|
-
HelpAction2[HelpAction2["START"] = `${HELP_ACTION}/start`] = "START";
|
|
16
|
-
})(HelpAction || (HelpAction = {}));
|
|
17
|
-
|
|
18
|
-
export {
|
|
19
|
-
HELP_PLUGIN,
|
|
20
|
-
meta_default,
|
|
21
|
-
HelpAction
|
|
22
|
-
};
|
|
23
|
-
//# sourceMappingURL=chunk-DI4HXWTJ.mjs.map
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/meta.tsx"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Info, type IconProps } from '@phosphor-icons/react';\nimport React from 'react';\n\nimport { pluginMeta } from '@dxos/app-framework';\n\n// TODO(burdon): Rename Guide? Help?\nexport const HELP_PLUGIN = 'dxos.org/plugin/help';\n\nexport default pluginMeta({\n id: HELP_PLUGIN,\n name: 'Help',\n iconComponent: (props: IconProps) => <Info {...props} />,\n iconSymbol: 'ph--info--regular',\n});\n\nconst HELP_ACTION = `${HELP_PLUGIN}/action`;\nexport enum HelpAction {\n START = `${HELP_ACTION}/start`,\n}\n"],
|
|
5
|
-
"mappings": ";AAIA,SAASA,YAA4B;AACrC,OAAOC,WAAW;AAElB,SAASC,kBAAkB;AAGpB,IAAMC,cAAc;AAE3B,IAAA,eAAeC,WAAW;EACxBC,IAAIF;EACJG,MAAM;EACNC,eAAe,CAACC,UAAqB,sBAAA,cAACC,MAASD,KAAAA;EAC/CE,YAAY;AACd,CAAA;AAEA,IAAMC,cAAc,GAAGR,WAAAA;;UACXS,aAAAA;qCACF,GAAGD,WAAAA,QAAmB,IAAA;GADpBC,eAAAA,aAAAA,CAAAA,EAAAA;",
|
|
6
|
-
"names": ["Info", "React", "pluginMeta", "HELP_PLUGIN", "pluginMeta", "id", "name", "iconComponent", "props", "Info", "iconSymbol", "HELP_ACTION", "HelpAction"]
|
|
7
|
-
}
|
package/src/meta.tsx
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2023 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import { Info, type IconProps } from '@phosphor-icons/react';
|
|
6
|
-
import React from 'react';
|
|
7
|
-
|
|
8
|
-
import { pluginMeta } from '@dxos/app-framework';
|
|
9
|
-
|
|
10
|
-
// TODO(burdon): Rename Guide? Help?
|
|
11
|
-
export const HELP_PLUGIN = 'dxos.org/plugin/help';
|
|
12
|
-
|
|
13
|
-
export default pluginMeta({
|
|
14
|
-
id: HELP_PLUGIN,
|
|
15
|
-
name: 'Help',
|
|
16
|
-
iconComponent: (props: IconProps) => <Info {...props} />,
|
|
17
|
-
iconSymbol: 'ph--info--regular',
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
const HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
21
|
-
export enum HelpAction {
|
|
22
|
-
START = `${HELP_ACTION}/start`,
|
|
23
|
-
}
|