@dxos/plugin-deck 0.8.4-main.a4bbb77 → 0.8.4-main.ae835ea

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/dist/lib/browser/{app-graph-builder-7SR53CCK.mjs → app-graph-builder-PCMSER2O.mjs} +6 -5
  2. package/dist/lib/browser/app-graph-builder-PCMSER2O.mjs.map +7 -0
  3. package/dist/lib/browser/{check-app-scheme-GCOL6YDT.mjs → check-app-scheme-HIEVFAAX.mjs} +2 -2
  4. package/dist/lib/browser/{chunk-WOCUNO27.mjs → chunk-27I7DJUG.mjs} +5 -5
  5. package/dist/lib/browser/{chunk-WOCUNO27.mjs.map → chunk-27I7DJUG.mjs.map} +2 -2
  6. package/dist/lib/browser/{chunk-HUWUYTOI.mjs → chunk-5KMJPIQC.mjs} +2 -2
  7. package/dist/lib/browser/{chunk-VSJ7FFQS.mjs → chunk-F3VCCHVL.mjs} +6 -4
  8. package/dist/lib/browser/chunk-F3VCCHVL.mjs.map +7 -0
  9. package/dist/lib/browser/{chunk-7CL25AYA.mjs → chunk-MFFZK4LT.mjs} +13 -13
  10. package/dist/lib/browser/{chunk-7CL25AYA.mjs.map → chunk-MFFZK4LT.mjs.map} +3 -3
  11. package/dist/lib/browser/{chunk-QHJ7N7BF.mjs → chunk-SBJLGRJV.mjs} +322 -288
  12. package/dist/lib/browser/chunk-SBJLGRJV.mjs.map +7 -0
  13. package/dist/lib/browser/chunk-UXLU6CMW.mjs +16 -0
  14. package/dist/lib/browser/chunk-UXLU6CMW.mjs.map +7 -0
  15. package/dist/lib/browser/index.mjs +6 -5
  16. package/dist/lib/browser/index.mjs.map +2 -2
  17. package/dist/lib/browser/{intent-resolver-Y5YOA4NR.mjs → intent-resolver-Q3KETDSS.mjs} +12 -9
  18. package/dist/lib/browser/intent-resolver-Q3KETDSS.mjs.map +7 -0
  19. package/dist/lib/browser/meta.json +1 -1
  20. package/dist/lib/browser/{react-root-A537NMT6.mjs → react-root-LU3662ME.mjs} +7 -7
  21. package/dist/lib/browser/{react-surface-DAS4HS3Y.mjs → react-surface-TDBFPN5T.mjs} +7 -7
  22. package/dist/lib/browser/{settings-3642GPOR.mjs → settings-SDPTOCCM.mjs} +5 -4
  23. package/dist/lib/browser/{settings-3642GPOR.mjs.map → settings-SDPTOCCM.mjs.map} +3 -3
  24. package/dist/lib/browser/state-QTVNH7N6.mjs +12 -0
  25. package/dist/lib/browser/toolkit-TM2Y6YL2.mjs +53 -0
  26. package/dist/lib/browser/toolkit-TM2Y6YL2.mjs.map +7 -0
  27. package/dist/lib/browser/types/index.mjs +2 -2
  28. package/dist/lib/browser/{url-handler-354LL74P.mjs → url-handler-QEYGYE2H.mjs} +4 -4
  29. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
  30. package/dist/types/src/capabilities/intent-resolver.d.ts.map +1 -1
  31. package/dist/types/src/capabilities/settings.d.ts.map +1 -1
  32. package/dist/types/src/capabilities/state.d.ts +3 -0
  33. package/dist/types/src/capabilities/state.d.ts.map +1 -1
  34. package/dist/types/src/capabilities/toolkit.d.ts +21 -3
  35. package/dist/types/src/capabilities/toolkit.d.ts.map +1 -1
  36. package/dist/types/src/components/DeckLayout/DeckLayout.d.ts +2 -3
  37. package/dist/types/src/components/DeckLayout/DeckLayout.d.ts.map +1 -1
  38. package/dist/types/src/components/DeckLayout/DeckLayout.stories.d.ts +74 -0
  39. package/dist/types/src/components/DeckLayout/DeckLayout.stories.d.ts.map +1 -0
  40. package/dist/types/src/components/DeckLayout/DeckMain.d.ts +3 -0
  41. package/dist/types/src/components/DeckLayout/DeckMain.d.ts.map +1 -0
  42. package/dist/types/src/components/DeckLayout/Toast.d.ts +5 -0
  43. package/dist/types/src/components/DeckLayout/Toast.d.ts.map +1 -1
  44. package/dist/types/src/components/DeckSettings/DeckSettings.d.ts.map +1 -1
  45. package/dist/types/src/components/Plank/Plank.d.ts.map +1 -1
  46. package/dist/types/src/components/Plank/Plank.stories.d.ts +1 -0
  47. package/dist/types/src/components/Plank/Plank.stories.d.ts.map +1 -1
  48. package/dist/types/src/components/Plank/PlankHeading.d.ts.map +1 -1
  49. package/dist/types/src/hooks/useHoistStatusbar.d.ts.map +1 -1
  50. package/dist/types/src/meta.d.ts.map +1 -1
  51. package/dist/types/src/translations.d.ts +1 -0
  52. package/dist/types/src/translations.d.ts.map +1 -1
  53. package/dist/types/src/types/schema.d.ts +2 -1
  54. package/dist/types/src/types/schema.d.ts.map +1 -1
  55. package/dist/types/tsconfig.tsbuildinfo +1 -1
  56. package/package.json +32 -33
  57. package/src/capabilities/app-graph-builder.ts +3 -2
  58. package/src/capabilities/intent-resolver.ts +6 -3
  59. package/src/capabilities/settings.ts +1 -0
  60. package/src/capabilities/state.ts +3 -0
  61. package/src/capabilities/toolkit.ts +23 -10
  62. package/src/capabilities/tools.ts +1 -1
  63. package/src/components/DeckLayout/DeckLayout.stories.tsx +64 -0
  64. package/src/components/DeckLayout/DeckLayout.tsx +8 -278
  65. package/src/components/DeckLayout/DeckMain.tsx +285 -0
  66. package/src/components/DeckLayout/Toast.tsx +25 -0
  67. package/src/components/DeckSettings/DeckSettings.tsx +6 -0
  68. package/src/components/Plank/Plank.tsx +27 -12
  69. package/src/components/Plank/PlankHeading.tsx +2 -1
  70. package/src/hooks/useHoistStatusbar.ts +3 -2
  71. package/src/meta.ts +5 -0
  72. package/src/translations.ts +1 -0
  73. package/src/types/schema.ts +3 -1
  74. package/dist/lib/browser/app-graph-builder-7SR53CCK.mjs.map +0 -7
  75. package/dist/lib/browser/chunk-MHP4GPX5.mjs +0 -11
  76. package/dist/lib/browser/chunk-MHP4GPX5.mjs.map +0 -7
  77. package/dist/lib/browser/chunk-QHJ7N7BF.mjs.map +0 -7
  78. package/dist/lib/browser/chunk-VSJ7FFQS.mjs.map +0 -7
  79. package/dist/lib/browser/intent-resolver-Y5YOA4NR.mjs.map +0 -7
  80. package/dist/lib/browser/state-MKKK3WGD.mjs +0 -12
  81. package/dist/lib/browser/toolkit-UPUBQIYU.mjs +0 -61
  82. package/dist/lib/browser/toolkit-UPUBQIYU.mjs.map +0 -7
  83. /package/dist/lib/browser/{check-app-scheme-GCOL6YDT.mjs.map → check-app-scheme-HIEVFAAX.mjs.map} +0 -0
  84. /package/dist/lib/browser/{chunk-HUWUYTOI.mjs.map → chunk-5KMJPIQC.mjs.map} +0 -0
  85. /package/dist/lib/browser/{react-root-A537NMT6.mjs.map → react-root-LU3662ME.mjs.map} +0 -0
  86. /package/dist/lib/browser/{react-surface-DAS4HS3Y.mjs.map → react-surface-TDBFPN5T.mjs.map} +0 -0
  87. /package/dist/lib/browser/{state-MKKK3WGD.mjs.map → state-QTVNH7N6.mjs.map} +0 -0
  88. /package/dist/lib/browser/{url-handler-354LL74P.mjs.map → url-handler-QEYGYE2H.mjs.map} +0 -0
@@ -0,0 +1,285 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { untracked } from '@preact/signals-core';
6
+ import React, { Fragment, type UIEvent, useCallback, useEffect, useMemo, useRef } from 'react';
7
+
8
+ import {
9
+ Capabilities,
10
+ LayoutAction,
11
+ createIntent,
12
+ useCapability,
13
+ useIntentDispatcher,
14
+ usePluginManager,
15
+ } from '@dxos/app-framework';
16
+ import { AttentionCapabilities } from '@dxos/plugin-attention';
17
+ import { Main, type MainProps, useMediaQuery, useOnTransition } from '@dxos/react-ui';
18
+ import { DEFAULT_HORIZONTAL_SIZE, Stack, StackContext } from '@dxos/react-ui-stack';
19
+ import { mainPaddingTransitions, mx } from '@dxos/react-ui-theme';
20
+
21
+ import { DeckCapabilities } from '../../capabilities';
22
+ import { useBreakpoints, useHoistStatusbar } from '../../hooks';
23
+ import { meta } from '../../meta';
24
+ import { type DeckSettingsProps, getMode } from '../../types';
25
+ import { calculateOverscroll, layoutAppliesTopbar } from '../../util';
26
+ import { fixedComplementarySidebarToggleStyles, fixedSidebarToggleStyles } from '../fragments';
27
+ import { Plank } from '../Plank';
28
+ import { ComplementarySidebar, Sidebar, ToggleComplementarySidebarButton, ToggleSidebarButton } from '../Sidebar';
29
+
30
+ import { ContentEmpty } from './ContentEmpty';
31
+ import { StatusBar } from './StatusBar';
32
+ import { Topbar } from './Topbar';
33
+
34
+ export const DeckMain = () => {
35
+ const { dispatchPromise: dispatch } = useIntentDispatcher();
36
+ const settings = useCapability(Capabilities.SettingsStore).getStore<DeckSettingsProps>(meta.id)?.value;
37
+ const context = useCapability(DeckCapabilities.MutableDeckState);
38
+ const { sidebarState, complementarySidebarState, complementarySidebarPanel, deck } = context;
39
+ const { active, activeCompanions, fullscreen, solo, plankSizing } = deck;
40
+ const layoutMode = getMode(deck);
41
+ const breakpoint = useBreakpoints();
42
+ const topbar = layoutAppliesTopbar(breakpoint, layoutMode);
43
+ const hoistStatusbar = useHoistStatusbar(breakpoint, layoutMode);
44
+ const pluginManager = usePluginManager();
45
+
46
+ const scrollLeftRef = useRef<number>(null);
47
+ const deckRef = useRef<HTMLDivElement>(null);
48
+
49
+ // Ensure the first plank is attended when the deck is first rendered.
50
+ useEffect(() => {
51
+ // NOTE: Not `useAttended` so that the layout component is not re-rendered when the attended list changes.
52
+ const attended = untracked(() => {
53
+ const attention = pluginManager.context.getCapability(AttentionCapabilities.Attention);
54
+ return attention.current;
55
+ });
56
+ const firstId = solo ?? active[0];
57
+ if (attended.length === 0 && firstId) {
58
+ // TODO(wittjosiah): Focusing the type button is a workaround.
59
+ // If the plank is directly focused on first load the focus ring appears.
60
+ document.querySelector<HTMLElement>(`article[data-attendable-id="${firstId}"] button`)?.focus();
61
+ }
62
+ }, []);
63
+
64
+ // Not using `breakpoint` to avoid firing when breakpoint changes between tablet and desktop.
65
+ // `ssr: false` to avoid using fallback values and flashing into solo mode on startup.
66
+ const [isNotMobile] = useMediaQuery('md');
67
+ const shouldRevert = useRef(false);
68
+ useEffect(() => {
69
+ if (!isNotMobile && getMode(deck) === 'deck') {
70
+ // NOTE: Not `useAttended` so that the layout component is not re-rendered when the attended list changes.
71
+ const attended = untracked(() => {
72
+ const attention = pluginManager.context.getCapability(AttentionCapabilities.Attention);
73
+ return attention.current;
74
+ });
75
+
76
+ shouldRevert.current = true;
77
+ void dispatch(
78
+ createIntent(LayoutAction.SetLayoutMode, { part: 'mode', subject: attended[0], options: { mode: 'solo' } }),
79
+ );
80
+ } else if (isNotMobile && getMode(deck) === 'solo' && shouldRevert.current) {
81
+ void dispatch(createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { revert: true } }));
82
+ }
83
+ }, [isNotMobile, deck, dispatch]);
84
+
85
+ // When deck is disabled in settings, set to solo mode if the current layout mode is deck.
86
+ // TODO(thure): Applying this as an effect should be avoided over emitting the intent only when the setting changes.
87
+ useEffect(() => {
88
+ if (!settings?.enableDeck && layoutMode === 'deck') {
89
+ void dispatch(
90
+ createIntent(LayoutAction.SetLayoutMode, { part: 'mode', subject: active[0], options: { mode: 'solo' } }),
91
+ );
92
+ }
93
+ }, [settings?.enableDeck, dispatch, active, layoutMode]);
94
+
95
+ /**
96
+ * Clear scroll restoration state if the window is resized.
97
+ */
98
+ const handleResize = useCallback(() => {
99
+ scrollLeftRef.current = null;
100
+ }, []);
101
+
102
+ useEffect(() => {
103
+ window.addEventListener('resize', handleResize);
104
+ return () => window.removeEventListener('resize', handleResize);
105
+ }, [handleResize]);
106
+
107
+ const restoreScroll = useCallback(() => {
108
+ if (deckRef.current && scrollLeftRef.current != null) {
109
+ deckRef.current.scrollLeft = scrollLeftRef.current;
110
+ }
111
+ }, []);
112
+ useOnTransition(layoutMode, (mode) => mode !== 'deck', 'deck', restoreScroll);
113
+
114
+ /**
115
+ * Save scroll position as the user scrolls.
116
+ */
117
+ const handleScroll = useCallback(
118
+ (event: UIEvent) => {
119
+ if (!solo && event.currentTarget === event.target) {
120
+ scrollLeftRef.current = (event.target as HTMLDivElement).scrollLeft;
121
+ }
122
+ },
123
+ [solo],
124
+ );
125
+
126
+ const isEmpty = !solo && active.length === 0;
127
+
128
+ const padding = useMemo(() => {
129
+ if (!solo && settings?.overscroll === 'centering') {
130
+ return calculateOverscroll(active.length);
131
+ }
132
+ return {};
133
+ }, [solo, settings?.overscroll, deck]);
134
+
135
+ const mainPosition = useMemo(
136
+ () => [
137
+ 'grid !block-start-[env(safe-area-inset-top)]',
138
+ topbar && '!block-start-[calc(env(safe-area-inset-top)+var(--rail-size))]',
139
+ hoistStatusbar && 'lg:block-end-[--statusbar-size]',
140
+ ],
141
+ [topbar, hoistStatusbar],
142
+ );
143
+
144
+ const { order, itemsCount }: { order: Record<string, number>; itemsCount: number } = useMemo(() => {
145
+ return active.reduce(
146
+ (acc: { order: Record<string, number>; itemsCount: number }, entryId) => {
147
+ acc.order[entryId] = acc.itemsCount + 1;
148
+ acc.itemsCount += activeCompanions?.[entryId] ? 3 : 2;
149
+ return acc;
150
+ },
151
+ { order: {}, itemsCount: 0 },
152
+ );
153
+ }, [active, activeCompanions]);
154
+
155
+ return (
156
+ <Main.Root
157
+ navigationSidebarState={fullscreen ? 'closed' : context.sidebarState}
158
+ onNavigationSidebarStateChange={(next) => (context.sidebarState = next)}
159
+ complementarySidebarState={fullscreen ? 'closed' : context.complementarySidebarState}
160
+ onComplementarySidebarStateChange={(next) => (context.complementarySidebarState = next)}
161
+ >
162
+ {/* Left sidebar. */}
163
+ <Sidebar />
164
+
165
+ {/* Right sidebar. */}
166
+ <ComplementarySidebar current={complementarySidebarPanel} />
167
+
168
+ {/* Dialog overlay to dismiss dialogs. */}
169
+ <Main.Overlay />
170
+
171
+ {/* No content. */}
172
+ {isEmpty && (
173
+ <Main.Content bounce handlesFocus classNames={mainPosition}>
174
+ <ContentEmpty />
175
+ </Main.Content>
176
+ )}
177
+
178
+ {/* Solo/deck mode. */}
179
+ {!isEmpty && (
180
+ <Main.Content
181
+ bounce
182
+ handlesFocus
183
+ classNames={mainPosition}
184
+ style={
185
+ {
186
+ '--main-spacing': settings?.encapsulatedPlanks ? '0.75rem' : '0',
187
+ '--dx-main-sidebarWidth':
188
+ sidebarState === 'expanded'
189
+ ? 'var(--nav-sidebar-size)'
190
+ : sidebarState === 'collapsed'
191
+ ? 'var(--l0-size)'
192
+ : '0',
193
+ '--dx-main-complementaryWidth':
194
+ complementarySidebarState === 'expanded'
195
+ ? 'var(--complementary-sidebar-size)'
196
+ : complementarySidebarState === 'collapsed'
197
+ ? 'var(--rail-size)'
198
+ : '0',
199
+ '--dx-main-contentFirstWidth': `${plankSizing[active[0] ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
200
+ '--dx-main-contentLastWidth': `${plankSizing[active[(active.length ?? 1) - 1] ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
201
+ } as MainProps['style']
202
+ }
203
+ >
204
+ <div
205
+ role='none'
206
+ className={!solo ? 'relative bg-deckSurface overflow-hidden' : 'sr-only'}
207
+ {...(solo && { inert: true })}
208
+ >
209
+ {!topbar && !fullscreen && <ToggleSidebarButton classNames={fixedSidebarToggleStyles} />}
210
+ {!topbar && !fullscreen && (
211
+ <ToggleComplementarySidebarButton classNames={fixedComplementarySidebarToggleStyles} />
212
+ )}
213
+ <Stack
214
+ ref={deckRef}
215
+ orientation='horizontal'
216
+ size='contain'
217
+ itemsCount={itemsCount - 1}
218
+ classNames={[
219
+ 'absolute inset-block-[--main-spacing] -inset-inline-px bs-[calc(100%-2*var(--main-spacing))]',
220
+ mainPaddingTransitions,
221
+ ]}
222
+ style={padding}
223
+ onScroll={handleScroll}
224
+ >
225
+ {active.map((entryId) => (
226
+ <Fragment key={entryId}>
227
+ <PlankSeparator order={order[entryId] - 1} encapsulate={!!settings?.enableDeck} />
228
+ <Plank
229
+ id={entryId}
230
+ companionId={activeCompanions?.[entryId]}
231
+ part='deck'
232
+ order={order[entryId]}
233
+ active={active}
234
+ layoutMode={layoutMode}
235
+ settings={settings}
236
+ />
237
+ </Fragment>
238
+ ))}
239
+ </Stack>
240
+ </div>
241
+ <div
242
+ role='none'
243
+ className={solo ? 'relative overflow-hidden bg-deckSurface' : 'sr-only'}
244
+ {...(!solo && { inert: true })}
245
+ >
246
+ {!topbar && !fullscreen && <ToggleSidebarButton classNames={fixedSidebarToggleStyles} />}
247
+ {!topbar && !fullscreen && (
248
+ <ToggleComplementarySidebarButton classNames={fixedComplementarySidebarToggleStyles} />
249
+ )}
250
+ <StackContext.Provider
251
+ value={{
252
+ orientation: 'horizontal',
253
+ size: 'contain',
254
+ rail: true,
255
+ }}
256
+ >
257
+ <Plank
258
+ id={solo}
259
+ companionId={solo ? activeCompanions?.[solo] : undefined}
260
+ part='solo'
261
+ layoutMode={layoutMode}
262
+ settings={settings}
263
+ />
264
+ </StackContext.Provider>
265
+ </div>
266
+ </Main.Content>
267
+ )}
268
+
269
+ {/* Topbar. */}
270
+ {topbar && <Topbar />}
271
+
272
+ {/* Status bar. */}
273
+ {hoistStatusbar && <StatusBar showHints={settings?.showHints} />}
274
+ </Main.Root>
275
+ );
276
+ };
277
+
278
+ const PlankSeparator = ({ order, encapsulate }: { order: number; encapsulate?: boolean }) =>
279
+ order > 0 ? (
280
+ <span
281
+ role='separator'
282
+ className={mx('row-span-2 bg-deckSurface', encapsulate ? 'is-0' : 'is-4')}
283
+ style={{ gridColumn: order }}
284
+ />
285
+ ) : null;
@@ -59,3 +59,28 @@ export const Toast = ({
59
59
  </NaturalToast.Root>
60
60
  );
61
61
  };
62
+
63
+ export type ToasterProps = {
64
+ toasts?: LayoutAction.Toast[];
65
+ onDismissToast?: (id: string) => void;
66
+ };
67
+
68
+ export const Toaster = ({ toasts, onDismissToast }: ToasterProps) => {
69
+ return (
70
+ <>
71
+ {toasts?.map((toast) => (
72
+ <Toast
73
+ {...toast}
74
+ key={toast.id}
75
+ onOpenChange={(open) => {
76
+ if (!open) {
77
+ onDismissToast?.(toast.id);
78
+ }
79
+
80
+ return open;
81
+ }}
82
+ />
83
+ ))}
84
+ </>
85
+ );
86
+ };
@@ -31,6 +31,12 @@ export const DeckSettings = ({ settings }: { settings: DeckSettingsProps }) => {
31
31
  onCheckedChange={(checked) => (settings.enableDeck = checked)}
32
32
  />
33
33
  </ControlItemInput>
34
+ <ControlItemInput title={t('settings encapsulated planks label')}>
35
+ <Input.Switch
36
+ checked={settings.encapsulatedPlanks ?? false}
37
+ onCheckedChange={(checked) => (settings.encapsulatedPlanks = checked)}
38
+ />
39
+ </ControlItemInput>
34
40
  <ControlItemInput title={t('select new plank positioning label')}>
35
41
  <Select.Root
36
42
  disabled={!settings.enableDeck}
@@ -68,7 +68,11 @@ export const Plank = memo(({ id = UNKNOWN_ID, companionId, ...props }: PlankProp
68
68
  const hasCompanion = !!(companionId && currentCompanion);
69
69
 
70
70
  return (
71
- <PlankContainer solo={props.part === 'solo'} companion={hasCompanion}>
71
+ <PlankContainer
72
+ solo={props.part === 'solo'}
73
+ companion={hasCompanion}
74
+ encapsulate={!!props.settings?.encapsulatedPlanks}
75
+ >
72
76
  <PlankComponent
73
77
  id={id}
74
78
  node={node}
@@ -92,7 +96,12 @@ export const Plank = memo(({ id = UNKNOWN_ID, companionId, ...props }: PlankProp
92
96
  );
93
97
  });
94
98
 
95
- const PlankContainer = ({ children, solo, companion }: PropsWithChildren<{ solo: boolean; companion: boolean }>) => {
99
+ const PlankContainer = ({
100
+ children,
101
+ solo,
102
+ companion,
103
+ encapsulate,
104
+ }: PropsWithChildren<{ solo: boolean; companion: boolean; encapsulate: boolean }>) => {
96
105
  const sizeAttrs = useMainSize();
97
106
  if (!solo) {
98
107
  return children;
@@ -102,7 +111,13 @@ const PlankContainer = ({ children, solo, companion }: PropsWithChildren<{ solo:
102
111
  return (
103
112
  <div
104
113
  role='none'
105
- className={mx('absolute inset-0 grid', companion && 'grid-cols-[1fr_1fr]', railGridHorizontal, mainIntrinsicSize)}
114
+ className={mx(
115
+ 'absolute inset-[--main-spacing] grid',
116
+ encapsulate && 'border border-separator rounded overflow-hidden',
117
+ companion && 'grid-cols-[6fr_4fr]',
118
+ railGridHorizontal,
119
+ mainIntrinsicSize,
120
+ )}
106
121
  {...sizeAttrs}
107
122
  >
108
123
  {children}
@@ -171,11 +186,7 @@ const PlankComponent = memo(
171
186
 
172
187
  useLayoutEffect(() => {
173
188
  if (scrollIntoView === id) {
174
- // TODO(wittjosiah): When focused on page load, the focus is always visible.
175
- // Forcing focus to something smaller than the plank prevents large focus ring in the interim.
176
- const focusable = rootElement.current?.querySelector('button') || rootElement.current;
177
- focusable?.focus({ preventScroll: true });
178
- layoutMode === 'deck' && focusable?.scrollIntoView({ behavior: 'smooth', inline: 'center' });
189
+ layoutMode === 'deck' && rootElement.current?.scrollIntoView({ behavior: 'smooth', inline: 'center' });
179
190
  // Clear the scroll into view state once it has been actioned.
180
191
  void dispatch(createIntent(LayoutAction.ScrollIntoView, { part: 'current', subject: undefined }));
181
192
  }
@@ -190,13 +201,15 @@ const PlankComponent = memo(
190
201
  const data = useMemo(
191
202
  () =>
192
203
  node && {
204
+ attendableId: id,
193
205
  subject: node.data,
194
206
  companionTo: primary?.data,
207
+ properties: node.properties,
195
208
  variant,
196
209
  path,
197
210
  popoverAnchorId,
198
211
  },
199
- [node, node?.data, path, popoverAnchorId, primary?.data, variant],
212
+ [node, node?.data, node?.properties, path, popoverAnchorId, primary?.data, variant],
200
213
  );
201
214
 
202
215
  // TODO(wittjosiah): Change prop to accept a component.
@@ -205,13 +218,16 @@ const PlankComponent = memo(
205
218
  const Root = part.startsWith('solo') ? 'article' : StackItem.Root;
206
219
  const className = mx(
207
220
  'attention-surface relative dx-focus-ring-inset-over-all density-coarse',
208
- isSolo && mainIntrinsicSize,
209
- isSolo && railGridHorizontal,
210
221
  isSolo && 'absolute inset-0',
222
+ isSolo && mainIntrinsicSize,
223
+ railGridHorizontal,
211
224
  part.startsWith('solo') && 'grid',
212
225
  part === 'deck' && (companioned === 'companion' ? '!border-separator border-ie' : '!border-separator border-li'),
213
226
  part.startsWith('solo-') && 'row-span-2 grid-rows-subgrid min-is-0',
214
227
  part === 'solo-companion' && '!border-separator border-is',
228
+ settings?.encapsulatedPlanks &&
229
+ !part.startsWith('solo') &&
230
+ 'mli-[--main-spacing] !border-separator border rounded overflow-hidden',
215
231
  );
216
232
 
217
233
  return (
@@ -259,7 +275,6 @@ const PlankComponent = memo(
259
275
  ) : (
260
276
  <PlankError id={id} part={part} />
261
277
  )}
262
-
263
278
  {canResize && <StackItem.ResizeHandle />}
264
279
  </Root>
265
280
  );
@@ -162,7 +162,8 @@ export const PlankHeading = memo(
162
162
  ? [
163
163
  hoverableControls,
164
164
  hoverableFocusedWithinControls,
165
- '*:transition-opacity *:opacity-[--controls-opacity] bg-transparent border-transparent transition-[background-color,border-color] hover-hover:hover:bg-headerSurface focus-within:bg-headerSurface hover-hover:hover:border-subduedSeparator focus-within:border-subduedSeparator',
165
+ '*:transition-opacity *:opacity-[--controls-opacity] bg-transparent border-transparent transition-[background-color,border-color]',
166
+ 'hover-hover:hover:bg-headerSurface focus-within:bg-headerSurface hover-hover:hover:border-subduedSeparator focus-within:border-subduedSeparator',
166
167
  ]
167
168
  : []),
168
169
  ]}
@@ -11,9 +11,10 @@ import { meta } from '../meta';
11
11
  import type { DeckSettingsProps, LayoutMode } from '../types';
12
12
 
13
13
  export const useHoistStatusbar = (breakpoint: string, layoutMode?: LayoutMode): boolean => {
14
- const enableStatusbar = useCapability(Capabilities.SettingsStore).getStore<DeckSettingsProps>(meta.id)!.value
15
- .enableStatusbar;
16
14
  const { safeAreaPadding } = useThemeContext();
15
+ const enableStatusbar = useCapability(Capabilities.SettingsStore).getStore<DeckSettingsProps>(meta.id)?.value
16
+ .enableStatusbar;
17
+
17
18
  return useMemo(() => {
18
19
  return (
19
20
  breakpoint === 'desktop' &&
package/src/meta.ts CHANGED
@@ -3,9 +3,14 @@
3
3
  //
4
4
 
5
5
  import { type PluginMeta } from '@dxos/app-framework';
6
+ import { trim } from '@dxos/util';
6
7
 
7
8
  export const meta: PluginMeta = {
8
9
  id: 'dxos.org/plugin/deck',
9
10
  name: 'Layout',
11
+ description: trim`
12
+ Flexible layout system for arranging workspace views in tabs, splits, and panels.
13
+ Customize your workspace organization with drag-and-drop layout management.
14
+ `,
10
15
  icon: 'ph--layout--regular',
11
16
  };
@@ -59,6 +59,7 @@ export const translations = [
59
59
  'settings overscroll none label': 'None',
60
60
  'settings enable statusbar label': 'Show status bar',
61
61
  'settings enable deck label': 'Enable Deck',
62
+ 'settings encapsulated planks label': 'Encapsulated planks',
62
63
  'close current label': 'Close current plank',
63
64
  'close others label': 'Close other planks',
64
65
  'close all label': 'Close all planks',
@@ -2,7 +2,7 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { Schema } from 'effect';
5
+ import * as Schema from 'effect/Schema';
6
6
 
7
7
  import { LayoutAction } from '@dxos/app-framework';
8
8
  import { type DeepReadonly } from '@dxos/util';
@@ -31,6 +31,8 @@ export const DeckSettingsSchema = Schema.Struct({
31
31
  enableNativeRedirect: Schema.optional(Schema.Boolean),
32
32
  newPlankPositioning: Schema.optional(Schema.Literal(...NewPlankPositions)),
33
33
  overscroll: Schema.optional(Schema.Literal(...OverscrollOptions)),
34
+ // TODO(burdon): Rename layoutMode? (e.g., bento | encapsulated?)
35
+ encapsulatedPlanks: Schema.optional(Schema.Boolean),
34
36
  }).pipe(Schema.mutable);
35
37
  export type DeckSettingsProps = Schema.Schema.Type<typeof DeckSettingsSchema>;
36
38
 
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport { Option, pipe } from 'effect';\n\nimport { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';\nimport { AttentionCapabilities } from '@dxos/plugin-attention';\nimport { ROOT_ID, createExtension, rxFromSignal } from '@dxos/plugin-graph';\n\nimport { meta } from '../meta';\n\nimport { DeckCapabilities } from './capabilities';\n\nexport default (context: PluginContext) =>\n contributes(\n Capabilities.AppGraphBuilder,\n createExtension({\n id: meta.id,\n actions: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n Option.map(() => {\n const state = context.getCapability(DeckCapabilities.MutableDeckState);\n\n // NOTE(Zan): This is currently disabled.\n // TODO(Zan): Fullscreen needs to know the active node and provide that to the layout part.\n const _fullscreen = {\n id: `${LayoutAction.UpdateLayout._tag}/fullscreen`,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n await dispatch(\n createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { mode: 'fullscreen' } }),\n );\n },\n properties: {\n label: ['toggle fullscreen label', { ns: meta.id }],\n icon: 'ph--arrows-out--regular',\n keyBinding: {\n macos: 'ctrl+meta+f',\n windows: 'shift+ctrl+f',\n },\n },\n };\n\n const closeCurrent = {\n id: `${LayoutAction.Close._tag}/current`,\n data: async () => {\n const attention = context.getCapability(AttentionCapabilities.Attention);\n const attended = attention.current.at(-1);\n if (attended) {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n await dispatch(\n createIntent(LayoutAction.Close, {\n part: 'main',\n subject: [attended],\n options: { state: false },\n }),\n );\n }\n },\n properties: {\n label: ['close current label', { ns: meta.id }],\n icon: 'ph--x--regular',\n },\n };\n\n const closeOthers = {\n id: `${LayoutAction.Close._tag}/others`,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n const attention = context.getCapability(AttentionCapabilities.Attention);\n const attended = attention.current.at(-1);\n const ids = state.deck.active.filter((id) => id !== attended) ?? [];\n await dispatch(\n createIntent(LayoutAction.Close, { part: 'main', subject: ids, options: { state: false } }),\n );\n },\n properties: {\n label: ['close others label', { ns: meta.id }],\n icon: 'ph--x-square--regular',\n },\n };\n\n const closeAll = {\n id: `${LayoutAction.Close._tag}/all`,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n await dispatch(\n createIntent(LayoutAction.Close, {\n part: 'main',\n subject: state.deck.active,\n options: { state: false },\n }),\n );\n },\n properties: {\n label: ['close all label', { ns: meta.id }],\n icon: 'ph--x-circle--regular',\n },\n };\n\n const toggleSidebar = {\n id: `${LayoutAction.UpdateSidebar._tag}/nav`,\n data: async () => {\n state.sidebarState = state.sidebarState === 'expanded' ? 'collapsed' : 'expanded';\n },\n properties: {\n label: [\n get(\n rxFromSignal(() =>\n state.sidebarState === 'expanded'\n ? 'collapse navigation sidebar label'\n : 'open navigation sidebar label',\n ),\n ),\n { ns: meta.id },\n ],\n icon: 'ph--sidebar--regular',\n keyBinding: {\n macos: \"meta+'\",\n },\n disposition: 'pin-end',\n position: 'hoist',\n l0Breakpoint: 'lg',\n },\n };\n\n return get(\n rxFromSignal(() =>\n !state.deck.solo ? [closeCurrent, closeOthers, closeAll, toggleSidebar] : [toggleSidebar],\n ),\n );\n }),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n );\n"],
5
- "mappings": ";;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,cAAcC,cAAkCC,aAAaC,oBAAoB;AAC1F,SAASC,6BAA6B;AACtC,SAASC,SAASC,iBAAiBC,oBAAoB;AAMvD,IAAA,6BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC,KAAKD;EACTE,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAOU,UAAUF,OAAOG,KAAKR,KAAAA,IAAQK,OAAOI,KAAI,CAAA,GAC/EJ,OAAOK,IAAI,MAAA;AACT,UAAMC,QAAQnB,QAAQoB,cAAcC,iBAAiBC,gBAAgB;AAIrE,UAAMC,cAAc;MAClBlB,IAAI,GAAGmB,aAAaC,aAAaC,IAAI;MACrCC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAK7B,QAAQoB,cAAclB,aAAa4B,gBAAgB;AACzF,cAAMD,SACJE,aAAaP,aAAaQ,eAAe;UAAEC,MAAM;UAAQC,SAAS;YAAEC,MAAM;UAAa;QAAE,CAAA,CAAA;MAE7F;MACAC,YAAY;QACVC,OAAO;UAAC;UAA2B;YAAEC,IAAIhC,KAAKD;UAAG;;QACjDkC,MAAM;QACNC,YAAY;UACVC,OAAO;UACPC,SAAS;QACX;MACF;IACF;AAEA,UAAMC,eAAe;MACnBtC,IAAI,GAAGmB,aAAaoB,MAAMlB,IAAI;MAC9BC,MAAM,YAAA;AACJ,cAAMkB,YAAY7C,QAAQoB,cAAc0B,sBAAsBC,SAAS;AACvE,cAAMC,WAAWH,UAAUI,QAAQC,GAAG,EAAC;AACvC,YAAIF,UAAU;AACZ,gBAAM,EAAEpB,iBAAiBC,SAAQ,IAAK7B,QAAQoB,cAAclB,aAAa4B,gBAAgB;AACzF,gBAAMD,SACJE,aAAaP,aAAaoB,OAAO;YAC/BX,MAAM;YACNkB,SAAS;cAACH;;YACVd,SAAS;cAAEf,OAAO;YAAM;UAC1B,CAAA,CAAA;QAEJ;MACF;MACAiB,YAAY;QACVC,OAAO;UAAC;UAAuB;YAAEC,IAAIhC,KAAKD;UAAG;;QAC7CkC,MAAM;MACR;IACF;AAEA,UAAMa,cAAc;MAClB/C,IAAI,GAAGmB,aAAaoB,MAAMlB,IAAI;MAC9BC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAK7B,QAAQoB,cAAclB,aAAa4B,gBAAgB;AACzF,cAAMe,YAAY7C,QAAQoB,cAAc0B,sBAAsBC,SAAS;AACvE,cAAMC,WAAWH,UAAUI,QAAQC,GAAG,EAAC;AACvC,cAAMG,MAAMlC,MAAMmC,KAAKC,OAAOC,OAAO,CAACnD,OAAOA,OAAO2C,QAAAA,KAAa,CAAA;AACjE,cAAMnB,SACJE,aAAaP,aAAaoB,OAAO;UAAEX,MAAM;UAAQkB,SAASE;UAAKnB,SAAS;YAAEf,OAAO;UAAM;QAAE,CAAA,CAAA;MAE7F;MACAiB,YAAY;QACVC,OAAO;UAAC;UAAsB;YAAEC,IAAIhC,KAAKD;UAAG;;QAC5CkC,MAAM;MACR;IACF;AAEA,UAAMkB,WAAW;MACfpD,IAAI,GAAGmB,aAAaoB,MAAMlB,IAAI;MAC9BC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAK7B,QAAQoB,cAAclB,aAAa4B,gBAAgB;AACzF,cAAMD,SACJE,aAAaP,aAAaoB,OAAO;UAC/BX,MAAM;UACNkB,SAAShC,MAAMmC,KAAKC;UACpBrB,SAAS;YAAEf,OAAO;UAAM;QAC1B,CAAA,CAAA;MAEJ;MACAiB,YAAY;QACVC,OAAO;UAAC;UAAmB;YAAEC,IAAIhC,KAAKD;UAAG;;QACzCkC,MAAM;MACR;IACF;AAEA,UAAMmB,gBAAgB;MACpBrD,IAAI,GAAGmB,aAAamC,cAAcjC,IAAI;MACtCC,MAAM,YAAA;AACJR,cAAMyC,eAAezC,MAAMyC,iBAAiB,aAAa,cAAc;MACzE;MACAxB,YAAY;QACVC,OAAO;UACL1B,IACEkD,aAAa,MACX1C,MAAMyC,iBAAiB,aACnB,sCACA,+BAAA,CAAA;UAGR;YAAEtB,IAAIhC,KAAKD;UAAG;;QAEhBkC,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;QACAqB,aAAa;QACbC,UAAU;QACVC,cAAc;MAChB;IACF;AAEA,WAAOrD,IACLkD,aAAa,MACX,CAAC1C,MAAMmC,KAAKW,OAAO;MAACtB;MAAcS;MAAaK;MAAUC;QAAiB;MAACA;KAAc,CAAA;EAG/F,CAAA,GACA7C,OAAOqD,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
6
- "names": ["Rx", "Option", "pipe", "Capabilities", "LayoutAction", "contributes", "createIntent", "AttentionCapabilities", "ROOT_ID", "createExtension", "rxFromSignal", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "meta", "actions", "node", "Rx", "make", "get", "pipe", "Option", "flatMap", "ROOT_ID", "some", "none", "map", "state", "getCapability", "DeckCapabilities", "MutableDeckState", "_fullscreen", "LayoutAction", "UpdateLayout", "_tag", "data", "dispatchPromise", "dispatch", "IntentDispatcher", "createIntent", "SetLayoutMode", "part", "options", "mode", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "closeCurrent", "Close", "attention", "AttentionCapabilities", "Attention", "attended", "current", "at", "subject", "closeOthers", "ids", "deck", "active", "filter", "closeAll", "toggleSidebar", "UpdateSidebar", "sidebarState", "rxFromSignal", "disposition", "position", "l0Breakpoint", "solo", "getOrElse"]
7
- }
@@ -1,11 +0,0 @@
1
- // src/meta.ts
2
- var meta = {
3
- id: "dxos.org/plugin/deck",
4
- name: "Layout",
5
- icon: "ph--layout--regular"
6
- };
7
-
8
- export {
9
- meta
10
- };
11
- //# sourceMappingURL=chunk-MHP4GPX5.mjs.map
@@ -1,7 +0,0 @@
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\nexport const meta: PluginMeta = {\n id: 'dxos.org/plugin/deck',\n name: 'Layout',\n icon: 'ph--layout--regular',\n};\n"],
5
- "mappings": ";AAMO,IAAMA,OAAmB;EAC9BC,IAAI;EACJC,MAAM;EACNC,MAAM;AACR;",
6
- "names": ["meta", "id", "name", "icon"]
7
- }