@dxos/plugin-deck 0.7.5-labs.a279d8c → 0.7.5-labs.d453967

package/src/components/DeckLayout/DeckLayout.tsx

@@ -6,14 +6,23 @@ import { untracked } from '@preact/signals-core';
 import React, { useCallback, useEffect, useMemo, useRef, type UIEvent, Fragment } from 'react';
 
 import {
-  firstIdInPart,
+  LayoutAction,
+  createIntent,
   Surface,
+  useCapability,
+  useIntentDispatcher,
   usePluginManager,
-  type LayoutParts,
-  type Toast as ToastSchema,
 } from '@dxos/app-framework';
 import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { AlertDialog, Dialog as NaturalDialog, Main, Popover, useOnTransition, type MainProps } from '@dxos/react-ui';
+import {
+  AlertDialog,
+  Dialog as NaturalDialog,
+  Main,
+  Popover,
+  useOnTransition,
+  type MainProps,
+  useMediaQuery,
+} from '@dxos/react-ui';
 import { Stack, StackContext, DEFAULT_HORIZONTAL_SIZE } from '@dxos/react-ui-stack';
 import { mainPaddingTransitions } from '@dxos/react-ui-theme';
 
@@ -23,18 +32,16 @@ import { ContentEmpty } from './ContentEmpty';
 import { Fullscreen } from './Fullscreen';
 import { Plank } from './Plank';
 import { Sidebar } from './Sidebar';
+import { ToggleComplementarySidebarButton, ToggleSidebarButton } from './SidebarButton';
 import { StatusBar } from './StatusBar';
 import { Toast } from './Toast';
 import { Topbar } from './Topbar';
-import { type Overscroll } from '../../types';
-import { calculateOverscroll, useBreakpoints } from '../../util';
-import { useHoistStatusbar } from '../../util/useHoistStatusbar';
-import { useDeckContext } from '../DeckContext';
-import { useLayout } from '../LayoutContext';
+import { DeckCapabilities } from '../../capabilities';
+import { getMode, type Overscroll } from '../../types';
+import { calculateOverscroll, layoutAppliesTopbar, useBreakpoints, useHoistStatusbar } from '../../util';
+import { fixedComplementarySidebarToggleStyles, fixedSidebarToggleStyles } from '../fragments';
 
 export type DeckLayoutProps = {
-  layoutParts: LayoutParts;
-  toasts: ToastSchema[];
   overscroll: Overscroll;
   showHints: boolean;
   onDismissToast: (id: string) => void;
@@ -43,12 +50,13 @@ export type DeckLayoutProps = {
 const PlankSeparator = ({ index }: { index: number }) =>
   index > 0 ? <span role='separator' className='row-span-2 bg-deck is-4' style={{ gridColumn: index * 2 }} /> : null;
 
-export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels, onDismissToast }: DeckLayoutProps) => {
-  const context = useLayout();
+export const DeckLayout = ({ overscroll, showHints, panels, onDismissToast }: DeckLayoutProps) => {
+  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  const context = useCapability(DeckCapabilities.MutableDeckState);
   const {
-    layoutMode,
-    sidebarOpen,
-    complementarySidebarOpen,
+    sidebarState,
+    complementarySidebarState,
+    complementarySidebarPanel,
     dialogOpen,
     dialogContent,
     dialogBlockAlign,
@@ -56,18 +64,18 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
     popoverOpen,
     popoverContent,
     popoverAnchorId,
+    deck,
+    toasts,
   } = context;
+  const { active, fullscreen, solo, plankSizing } = deck;
   const breakpoint = useBreakpoints();
+  const topbar = layoutAppliesTopbar(breakpoint);
   const hoistStatusbar = useHoistStatusbar(breakpoint);
-  const { plankSizing } = useDeckContext();
   const pluginManager = usePluginManager();
-  const fullScreenSlug = useMemo(() => firstIdInPart(layoutParts, 'fullScreen'), [layoutParts]);
 
   const scrollLeftRef = useRef<number | null>();
   const deckRef = useRef<HTMLDivElement>(null);
 
-  const isSoloModeLoaded = layoutMode === 'solo' && Boolean(layoutParts.solo?.[0]);
-
   // Ensure the first plank is attended when the deck is first rendered.
   useEffect(() => {
     // NOTE: Not `useAttended` so that the layout component is not re-rendered when the attended list changes.
@@ -75,7 +83,7 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
       const attention = pluginManager.context.requestCapability(AttentionCapabilities.Attention);
       return attention.current;
     });
-    const firstId = isSoloModeLoaded ? firstIdInPart(layoutParts, 'solo') : firstIdInPart(layoutParts, 'main');
+    const firstId = solo ?? active[0];
     if (attended.length === 0 && firstId) {
       // TODO(wittjosiah): Focusing the type button is a workaround.
       //   If the plank is directly focused on first load the focus ring appears.
@@ -83,6 +91,27 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
     }
   }, []);
 
+  // Not using `breakpoint` to avoid firing when breakpoint changes between tablet and desktop.
+  // `ssr: false` to avoid using fallback values and flashing into solo mode on startup.
+  const [isNotMobile] = useMediaQuery('md', { ssr: false });
+  const shouldRevert = useRef(false);
+  useEffect(() => {
+    if (!isNotMobile && getMode(deck) === 'deck') {
+      // NOTE: Not `useAttended` so that the layout component is not re-rendered when the attended list changes.
+      const attended = untracked(() => {
+        const attention = pluginManager.context.requestCapability(AttentionCapabilities.Attention);
+        return attention.current;
+      });
+
+      shouldRevert.current = true;
+      void dispatch(
+        createIntent(LayoutAction.SetLayoutMode, { part: 'mode', subject: attended[0], options: { mode: 'solo' } }),
+      );
+    } else if (isNotMobile && getMode(deck) === 'solo' && shouldRevert.current) {
+      void dispatch(createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { revert: true } }));
+    }
+  }, [isNotMobile, deck, dispatch]);
+
   /**
    * Clear scroll restoration state if the window is resized
    */
@@ -101,6 +130,7 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
     }
   }, []);
 
+  const layoutMode = getMode(deck);
   useOnTransition(layoutMode, (mode) => mode !== 'deck', 'deck', restoreScroll);
 
   /**
@@ -108,21 +138,30 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
    */
   const handleScroll = useCallback(
     (event: UIEvent) => {
-      if (layoutMode === 'deck' && event.currentTarget === event.target) {
+      if (!solo && event.currentTarget === event.target) {
         scrollLeftRef.current = (event.target as HTMLDivElement).scrollLeft;
       }
     },
-    [layoutMode],
+    [solo],
   );
 
-  const isEmpty = (layoutParts.main?.length ?? 0) === 0 && (layoutParts.solo?.length ?? 0) === 0;
+  const isEmpty = !solo && active.length === 0;
 
   const padding = useMemo(() => {
-    if (layoutMode === 'deck' && overscroll === 'centering') {
-      return calculateOverscroll(layoutParts.main?.length ?? 0);
+    if (!solo && overscroll === 'centering') {
+      return calculateOverscroll(active.length);
     }
     return {};
-  }, [layoutMode, overscroll, layoutParts.main]);
+  }, [solo, overscroll, deck]);
+
+  const mainPosition = useMemo(
+    () => [
+      'grid !block-start-[env(safe-area-inset-top)]',
+      topbar && '!block-start-[calc(env(safe-area-inset-top)+var(--rail-size))]',
+      hoistStatusbar && 'lg:block-end-[--statusbar-size]',
+    ],
+    [topbar, hoistStatusbar],
+  );
 
   const Dialog = dialogType === 'alert' ? AlertDialog : NaturalDialog;
 
@@ -141,27 +180,27 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
     >
       <ActiveNode />
 
-      {layoutMode === 'fullscreen' && <Fullscreen id={fullScreenSlug} />}
+      {fullscreen && <Fullscreen id={solo} />}
 
-      {layoutMode !== 'fullscreen' && (
+      {!fullscreen && (
         <Main.Root
-          navigationSidebarOpen={context.sidebarOpen}
-          onNavigationSidebarOpenChange={(next) => (context.sidebarOpen = next)}
-          complementarySidebarOpen={context.complementarySidebarOpen}
-          onComplementarySidebarOpenChange={(next) => (context.complementarySidebarOpen = next)}
+          navigationSidebarState={context.sidebarState}
+          onNavigationSidebarStateChange={(next) => (context.sidebarState = next)}
+          complementarySidebarState={context.complementarySidebarState}
+          onComplementarySidebarStateChange={(next) => (context.complementarySidebarState = next)}
         >
           {/* Left sidebar. */}
           <Sidebar />
 
           {/* Right sidebar. */}
-          <ComplementarySidebar panels={panels} current={layoutParts.complementary?.[0].id} />
+          <ComplementarySidebar panels={panels} current={complementarySidebarPanel} />
 
           {/* Dialog overlay to dismiss dialogs. */}
           <Main.Overlay />
 
           {/* No content. */}
           {isEmpty && (
-            <Main.Content handlesFocus>
+            <Main.Content bounce handlesFocus classNames={mainPosition}>
               <ContentEmpty />
             </Main.Content>
           )}
@@ -170,64 +209,67 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
           {!isEmpty && (
             <Main.Content
               bounce
-              classNames={[
-                'grid !block-start-[env(safe-area-inset-top)] lg:!block-start-[calc(env(safe-area-inset-top)+var(--rail-size))]',
-                hoistStatusbar && 'lg:block-end-[--statusbar-size]',
-              ]}
+              classNames={mainPosition}
               handlesFocus
               style={
                 {
-                  '--dx-main-sidebarWidth': sidebarOpen ? 'var(--nav-sidebar-size)' : '0px',
-                  '--dx-main-complementaryWidth': complementarySidebarOpen
-                    ? 'var(--complementary-sidebar-size)'
-                    : '0px',
-                  '--dx-main-contentFirstWidth': `${plankSizing[layoutParts.main?.[0]?.id ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
-                  '--dx-main-contentLastWidth': `${plankSizing[layoutParts.main?.[(layoutParts.main?.length ?? 1) - 1]?.id ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
+                  '--dx-main-sidebarWidth':
+                    sidebarState === 'expanded'
+                      ? 'var(--nav-sidebar-size)'
+                      : sidebarState === 'collapsed'
+                        ? 'var(--l0-size)'
+                        : '0',
+                  '--dx-main-complementaryWidth':
+                    complementarySidebarState === 'expanded'
+                      ? 'var(--complementary-sidebar-size)'
+                      : complementarySidebarState === 'collapsed'
+                        ? 'var(--rail-size)'
+                        : '0',
+                  '--dx-main-contentFirstWidth': `${plankSizing[active[0] ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
+                  '--dx-main-contentLastWidth': `${plankSizing[active[(active.length ?? 1) - 1] ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
                 } as MainProps['style']
               }
             >
               <div
                 role='none'
-                className={!isSoloModeLoaded ? 'relative bg-deck overflow-hidden' : 'sr-only'}
-                {...(isSoloModeLoaded && { inert: '' })}
+                className={!solo ? 'relative bg-deck overflow-hidden' : 'sr-only'}
+                {...(solo && { inert: '' })}
               >
+                {!topbar && <ToggleSidebarButton classNames={fixedSidebarToggleStyles} />}
+                {!topbar && <ToggleComplementarySidebarButton classNames={fixedComplementarySidebarToggleStyles} />}
                 <Stack
                   orientation='horizontal'
                   size='contain'
                   classNames={['absolute inset-block-0 -inset-inline-px', mainPaddingTransitions]}
                   onScroll={handleScroll}
-                  itemsCount={2 * (layoutParts.main?.length ?? 0) - 1}
+                  itemsCount={2 * (active.length ?? 0) - 1}
                   style={padding}
                   ref={deckRef}
                 >
-                  {layoutParts.main?.map((layoutEntry, index) => (
-                    <Fragment key={layoutEntry.id}>
+                  {active.map((entryId, index) => (
+                    <Fragment key={entryId}>
                       <PlankSeparator index={index} />
-                      <Plank
-                        entry={layoutEntry}
-                        layoutParts={layoutParts}
-                        part='main'
-                        layoutMode={layoutMode}
-                        order={index * 2 + 1}
-                      />
+                      <Plank id={entryId} part='deck' order={index * 2 + 1} active={active} layoutMode={layoutMode} />
                     </Fragment>
                   ))}
                 </Stack>
               </div>
               <div
                 role='none'
-                className={isSoloModeLoaded ? 'relative bg-deck overflow-hidden' : 'sr-only'}
-                {...(!isSoloModeLoaded && { inert: '' })}
+                className={solo ? 'relative bg-deck overflow-hidden' : 'sr-only'}
+                {...(!solo && { inert: '' })}
               >
+                {!topbar && <ToggleSidebarButton classNames={fixedSidebarToggleStyles} />}
+                {!topbar && <ToggleComplementarySidebarButton classNames={fixedComplementarySidebarToggleStyles} />}
                 <StackContext.Provider value={{ size: 'contain', orientation: 'horizontal', rail: true }}>
-                  <Plank entry={layoutParts.solo?.[0]} layoutParts={layoutParts} part='solo' layoutMode={layoutMode} />
+                  <Plank id={solo} part='solo' layoutMode={layoutMode} />
                 </StackContext.Provider>
               </div>
             </Main.Content>
           )}
 
           {/* Status bar. */}
-          {breakpoint === 'desktop' && <Topbar />}
+          {topbar && <Topbar />}
           {hoistStatusbar && <StatusBar showHints={showHints} />}
         </Main.Root>
       )}
@@ -248,10 +290,20 @@ export const DeckLayout = ({ layoutParts, toasts, overscroll, showHints, panels,
       </Popover.Portal>
 
       {/* Global dialog. */}
-      <Dialog.Root open={dialogOpen} onOpenChange={(nextOpen) => (context.dialogOpen = nextOpen)}>
-        <Dialog.Overlay blockAlign={dialogBlockAlign}>
+      {/* TODO(thure): End block alignment affecting `modal` and whether the surface renders in an overlay is tailored
+            to the needs of the ambient chat dialog. As the feature matures, consider separating concerns. */}
+      <Dialog.Root
+        modal={dialogBlockAlign !== 'end'}
+        open={dialogOpen}
+        onOpenChange={(nextOpen) => (context.dialogOpen = nextOpen)}
+      >
+        {dialogBlockAlign === 'end' ? (
           <Surface role='dialog' data={dialogContent} limit={1} />
-        </Dialog.Overlay>
+        ) : (
+          <Dialog.Overlay blockAlign={dialogBlockAlign}>
+            <Surface role='dialog' data={dialogContent} limit={1} />
+          </Dialog.Overlay>
+        )}
       </Dialog.Root>
 
       {/* Global toasts. */}

package/src/components/DeckLayout/Fullscreen.tsx

@@ -4,8 +4,7 @@
 
 import React from 'react';
 
-import { Surface } from '@dxos/app-framework';
-import { useGraph } from '@dxos/plugin-graph';
+import { Surface, useAppGraph } from '@dxos/app-framework';
 import { fixedInsetFlexLayout } from '@dxos/react-ui-theme';
 
 import { Fallback } from './Fallback';
@@ -13,7 +12,7 @@ import { SURFACE_PREFIX } from './constants';
 import { useNode } from '../../hooks';
 
 export const Fullscreen = ({ id }: { id?: string }) => {
-  const { graph } = useGraph();
+  const { graph } = useAppGraph();
   const fullScreenNode = useNode(graph, id);
 
   return (

package/src/components/DeckLayout/NodePlankHeading.tsx

@@ -2,30 +2,23 @@
 // Copyright 2024 DXOS.org
 //
 
-import React, { Fragment, memo, useEffect, useMemo } from 'react';
+import React, { Fragment, memo, useCallback, useEffect, useMemo } from 'react';
 
-import {
-  createIntent,
-  LayoutAction,
-  NavigationAction,
-  SLUG_PATH_SEPARATOR,
-  Surface,
-  useIntentDispatcher,
-  type LayoutCoordinate,
-} from '@dxos/app-framework';
-import { type Node, useGraph } from '@dxos/plugin-graph';
+import { createIntent, LayoutAction, Surface, useAppGraph, useIntentDispatcher } from '@dxos/app-framework';
+import { type Node } from '@dxos/plugin-graph';
 import { Icon, Popover, toLocalizedString, useTranslation } from '@dxos/react-ui';
 import { StackItem, type StackItemSigilAction } from '@dxos/react-ui-stack';
 import { TextTooltip } from '@dxos/react-ui-text-tooltip';
 
 import { PlankControls } from './PlankControls';
-import { ToggleComplementarySidebarButton, ToggleSidebarButton } from './SidebarButton';
 import { DECK_PLUGIN } from '../../meta';
+import { DeckAction, SLUG_PATH_SEPARATOR } from '../../types';
 import { useBreakpoints } from '../../util';
 import { soloInlinePadding } from '../fragments';
 
 export type NodePlankHeadingProps = {
-  coordinate: LayoutCoordinate;
+  id: string;
+  part: 'solo' | 'deck' | 'complementary';
   node?: Node;
   canIncrementStart?: boolean;
   canIncrementEnd?: boolean;
@@ -36,7 +29,8 @@ export type NodePlankHeadingProps = {
 
 export const NodePlankHeading = memo(
   ({
-    coordinate,
+    id,
+    part,
     node,
     canIncrementStart,
     canIncrementEnd,
@@ -45,14 +39,14 @@ export const NodePlankHeading = memo(
     actions = [],
   }: NodePlankHeadingProps) => {
     const { t } = useTranslation(DECK_PLUGIN);
-    const { graph } = useGraph();
+    const { graph } = useAppGraph();
+    const breakpoint = useBreakpoints();
     const icon = node?.properties?.icon ?? 'ph--placeholder--regular';
     const label = pending
       ? t('pending heading')
       : toLocalizedString(node?.properties?.label ?? ['plank heading fallback label', { ns: DECK_PLUGIN }], t);
     const { dispatchPromise: dispatch } = useIntentDispatcher();
     const ActionRoot = node && popoverAnchorId === `dxos.org/ui/${DECK_PLUGIN}/${node.id}` ? Popover.Anchor : Fragment;
-    const breakpoint = useBreakpoints();
 
     useEffect(() => {
       const frame = requestAnimationFrame(() => {
@@ -63,36 +57,65 @@ export const NodePlankHeading = memo(
       return () => cancelAnimationFrame(frame);
     }, [node]);
 
-    const layoutPart = coordinate.part;
     // NOTE(Zan): Node ids may now contain a path like `${space}:${id}~comments`
-    const attendableId = coordinate.entryId.split(SLUG_PATH_SEPARATOR).at(0);
+    const attendableId = id.split(SLUG_PATH_SEPARATOR).at(0);
     const capabilities = useMemo(
       () => ({
-        solo: layoutPart === 'solo' || layoutPart === 'main',
+        solo: breakpoint !== 'mobile' && (part === 'solo' || part === 'deck'),
         incrementStart: canIncrementStart,
         incrementEnd: canIncrementEnd,
       }),
-      [breakpoint, layoutPart, canIncrementStart, canIncrementEnd],
+      [breakpoint, part, canIncrementStart, canIncrementEnd],
+    );
+
+    const sigilActions = useMemo(
+      () => node && [actions, graph.actions(node)].filter((a) => a.length > 0),
+      [actions, node, graph],
+    );
+    const handleAction = useCallback((action: StackItemSigilAction) => {
+      typeof action.data === 'function' && action.data?.({ node: action as Node, caller: DECK_PLUGIN });
+    }, []);
+
+    const handlePlankAction = useCallback(
+      (eventType: DeckAction.PartAdjustment) => {
+        if (eventType === 'solo') {
+          return dispatch(createIntent(DeckAction.Adjust, { type: eventType, id }));
+        } else if (eventType === 'close') {
+          if (part === 'complementary') {
+            return dispatch(
+              createIntent(LayoutAction.UpdateComplementary, {
+                part: 'complementary',
+                options: { state: 'collapsed' },
+              }),
+            );
+          } else {
+            return dispatch(
+              createIntent(LayoutAction.Close, { part: 'main', subject: [id], options: { state: false } }),
+            );
+          }
+        } else {
+          return dispatch(createIntent(DeckAction.Adjust, { type: eventType, id }));
+        }
+      },
+      [dispatch, id, part],
     );
 
     return (
       <StackItem.Heading
         classNames={[
-          'plb-1 border-be border-separator items-stretch gap-1',
-          layoutPart === 'solo' ? soloInlinePadding : 'pli-1',
+          'plb-1 border-be border-separator items-stretch gap-1 sticky inline-start-12 app-drag',
+          part === 'solo' ? soloInlinePadding : 'pli-1',
         ]}
       >
         <ActionRoot>
-          {node ? (
+          {node && sigilActions ? (
             <StackItem.Sigil
               icon={icon}
-              related={layoutPart === 'complementary'}
+              related={part === 'complementary'}
               attendableId={attendableId}
               triggerLabel={t('actions menu label')}
-              actions={[actions, graph.actions(node)].filter((a) => a.length > 0)}
-              onAction={(action) =>
-                typeof action.data === 'function' && action.data?.({ node: action as Node, caller: DECK_PLUGIN })
-              }
+              actions={sigilActions}
+              onAction={handleAction}
             >
               <Surface role='menu-footer' data={{ subject: node.data }} />
             </StackItem.Sigil>
@@ -103,53 +126,22 @@ export const NodePlankHeading = memo(
             </StackItem.SigilButton>
           )}
         </ActionRoot>
-        {breakpoint !== 'desktop' && <ToggleSidebarButton />}
         <TextTooltip text={label} onlyWhenTruncating>
           <StackItem.HeadingLabel
             attendableId={attendableId}
-            related={layoutPart === 'complementary'}
+            related={part === 'complementary'}
             {...(pending && { classNames: 'text-description' })}
           >
             {label}
           </StackItem.HeadingLabel>
         </TextTooltip>
-        {node && layoutPart !== 'complementary' && (
-          // TODO(Zan): What are we doing with layout coordinate here?
-          <Surface role='navbar-end' data={{ subject: node.data }} />
-        )}
-        {/* NOTE(thure): Pinning & unpinning are temporarily disabled */}
+        {node && part !== 'complementary' && <Surface role='navbar-end' data={{ subject: node.data }} />}
         <PlankControls
           capabilities={capabilities}
-          isSolo={layoutPart === 'solo'}
-          onClick={(eventType) => {
-            if (!layoutPart) {
-              return;
-            }
-
-            // TODO(Zan): Update this to use the new layout actions.
-            if (eventType === 'solo') {
-              return dispatch(
-                createIntent(NavigationAction.Adjust, {
-                  type: eventType,
-                  layoutCoordinate: { part: 'main', entryId: coordinate.entryId },
-                }),
-              );
-            } else if (eventType === 'close') {
-              if (layoutPart === 'complementary') {
-                return dispatch(createIntent(LayoutAction.SetLayout, { element: 'complementary', state: false }));
-              } else {
-                return dispatch(
-                  createIntent(NavigationAction.Close, { activeParts: { [layoutPart]: [coordinate.entryId] } }),
-                );
-              }
-            } else {
-              return dispatch(createIntent(NavigationAction.Adjust, { type: eventType, layoutCoordinate: coordinate }));
-            }
-          }}
-          close={layoutPart === 'complementary' ? 'minify-end' : true}
-        >
-          <ToggleComplementarySidebarButton />
-        </PlankControls>
+          isSolo={part === 'solo'}
+          onClick={handlePlankAction}
+          close={part === 'complementary' ? 'minify-end' : true}
+        />
       </StackItem.Heading>
     );
   },