@dxos/plugin-deck 0.6.11 → 0.6.12-main.2d19bf1

package/src/DeckPlugin.tsx

@@ -2,7 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ArrowsOut, type IconProps } from '@phosphor-icons/react';
 import { batch, effect } from '@preact/signals-core';
 import { setAutoFreeze } from 'immer';
 import React, { type PropsWithChildren } from 'react';
@@ -41,7 +40,6 @@ import { createExtension, type Node } from '@dxos/plugin-graph';
 import { ObservabilityAction } from '@dxos/plugin-observability/meta';
 import { fullyQualifiedId } from '@dxos/react-client/echo';
 import { translations as deckTranslations } from '@dxos/react-ui-deck';
-import { Mosaic } from '@dxos/react-ui-mosaic';
 
 import {
   DeckLayout,
@@ -71,7 +69,7 @@ const isSocket = !!(globalThis as any).__args;
 // TODO(mjamesderocher): Can we get this directly from Socket?
 const appScheme = 'composer://';
 
-// TODO(burdon): Evolve into customizable prefs,.
+// TODO(burdon): Evolve into customizable prefs.
 const customSlots: DeckLayoutProps['slots'] = {
   wallpaper: {
     classNames:
@@ -112,7 +110,7 @@ export const DeckPlugin = ({
   let handleNavigation: () => Promise<void> | undefined;
 
   const settings = new LocalStorageStore<DeckSettingsProps>('dxos.org/settings/layout', {
-    showFooter: false,
+    showHints: true,
     customSlots: false,
     flatDeck: false,
     enableNativeRedirect: false,
@@ -190,6 +188,25 @@ export const DeckPlugin = ({
     }
   };
 
+  /**
+   * Update the active state and ensure that attention is on an active element.
+   */
+  const handleSetLocation = (next: LayoutParts) => {
+    if (attentionPlugin) {
+      const attended = attentionPlugin.provides.attention.attended;
+      const [attendedId] = Array.from(attended);
+      const ids = (layout.values.layoutMode === 'deck' ? next.main : next.solo)?.map(({ id }) => id) ?? [];
+      const isAttendedAvailable = !!attendedId && ids.includes(attendedId);
+      if (!isAttendedAvailable) {
+        const nextAttended = next.main?.[0]?.id;
+        const article = document.querySelector<HTMLElement>(`article[data-attendable-id="${nextAttended}"]`);
+        article?.focus();
+      }
+    }
+
+    location.values.active = next;
+  };
+
   return {
     meta,
     ready: async (plugins) => {
@@ -198,16 +215,21 @@ export const DeckPlugin = ({
       attentionPlugin = resolvePlugin(plugins, parseAttentionPlugin);
       clientPlugin = resolvePlugin(plugins, parseClientPlugin);
 
-      // prettier-ignore
       layout
         .prop({ key: 'layoutMode', storageKey: 'layout-mode', type: LocalStorageStore.enum<LayoutMode>() })
         .prop({ key: 'sidebarOpen', storageKey: 'sidebar-open', type: LocalStorageStore.bool() })
-        .prop({ key: 'complementarySidebarOpen', storageKey: 'complementary-sidebar-open', type: LocalStorageStore.bool() });
-
-      // prettier-ignore
-      deck.prop({ key: 'plankSizing', storageKey: 'plank-sizing', type: LocalStorageStore.json<Record<string, number>>() });
+        .prop({
+          key: 'complementarySidebarOpen',
+          storageKey: 'complementary-sidebar-open',
+          type: LocalStorageStore.bool(),
+        });
+
+      deck.prop({
+        key: 'plankSizing',
+        storageKey: 'plank-sizing',
+        type: LocalStorageStore.json<Record<string, number>>(),
+      });
 
-      // prettier-ignore
       location
         .prop({ key: 'active', storageKey: 'active', type: LocalStorageStore.json<LayoutParts>() })
         .prop({ key: 'closed', storageKey: 'closed', type: LocalStorageStore.json<string[]>() });
@@ -220,14 +242,17 @@ export const DeckPlugin = ({
         }),
       );
 
-      // prettier-ignore
       settings
-        .prop({ key: 'showFooter', storageKey: 'show-footer', type: LocalStorageStore.bool() })
+        .prop({ key: 'showHints', storageKey: 'show-hints', type: LocalStorageStore.bool() })
         .prop({ key: 'customSlots', storageKey: 'customSlots', type: LocalStorageStore.bool() })
         .prop({ key: 'flatDeck', storageKey: 'flatDeck', type: LocalStorageStore.bool() })
         .prop({ key: 'enableNativeRedirect', storageKey: 'enable-native-redirect', type: LocalStorageStore.bool() })
         .prop({ key: 'disableDeck', storageKey: 'disable-deck', type: LocalStorageStore.bool() }) // Deprecated.
-        .prop({ key: 'newPlankPositioning', storageKey: 'newPlankPositioning', type: LocalStorageStore.enum<NewPlankPositioning>() })
+        .prop({
+          key: 'newPlankPositioning',
+          storageKey: 'newPlankPositioning',
+          type: LocalStorageStore.enum<NewPlankPositioning>(),
+        })
         .prop({ key: 'overscroll', storageKey: 'overscroll', type: LocalStorageStore.enum<Overscroll>() });
 
       if (!isSocket && settings.values.enableNativeRedirect) {
@@ -237,7 +262,7 @@ export const DeckPlugin = ({
       handleNavigation = async () => {
         const pathname = window.location.pathname;
         if (pathname === '/reset') {
-          location.values.active = { sidebar: [{ id: NAV_ID }] };
+          handleSetLocation({ sidebar: [{ id: NAV_ID }] });
           location.values.closed = [];
           layout.values.layoutMode = 'solo';
           window.location.pathname = '/';
@@ -250,7 +275,7 @@ export const DeckPlugin = ({
         }
 
         const startingLayout = removePart(location.values.active, 'solo');
-        location.values.active = mergeLayoutParts(layoutFromUri, startingLayout);
+        handleSetLocation(mergeLayoutParts(layoutFromUri, startingLayout));
         layout.values.layoutMode = 'solo';
       };
 
@@ -310,8 +335,7 @@ export const DeckPlugin = ({
                 },
                 properties: {
                   label: ['toggle fullscreen label', { ns: DECK_PLUGIN }],
-                  icon: (props: IconProps) => <ArrowsOut {...props} />,
-                  iconSymbol: 'ph--arrows-out--regular',
+                  icon: 'ph--arrows-out--regular',
                   keyBinding: {
                     macos: 'ctrl+meta+f',
                     windows: 'shift+ctrl+f',
@@ -329,31 +353,27 @@ export const DeckPlugin = ({
       ),
       root: () => {
         return (
-          <Mosaic.Root>
-            <DeckLayout
-              attention={attentionPlugin?.provides.attention ?? { attended: new Set() }}
-              layoutParts={location.values.active}
-              showHintsFooter={settings.values.showFooter}
-              overscroll={settings.values.overscroll}
-              flatDeck={settings.values.flatDeck}
-              slots={settings.values.customSlots ? customSlots : undefined}
-              toasts={layout.values.toasts}
-              onDismissToast={(id) => {
-                const index = layout.values.toasts.findIndex((toast) => toast.id === id);
-                if (index !== -1) {
-                  // Allow time for the toast to animate out.
-                  // TODO(burdon): Factor out and unregister timeout.
-                  setTimeout(() => {
-                    if (layout.values.toasts[index].id === currentUndoId) {
-                      currentUndoId = undefined;
-                    }
-                    layout.values.toasts.splice(index, 1);
-                  }, 1_000);
-                }
-              }}
-            />
-            <Mosaic.DragOverlay />
-          </Mosaic.Root>
+          <DeckLayout
+            layoutParts={location.values.active}
+            showHints={settings.values.showHints}
+            overscroll={settings.values.overscroll}
+            flatDeck={settings.values.flatDeck}
+            slots={settings.values.customSlots ? customSlots : undefined}
+            toasts={layout.values.toasts}
+            onDismissToast={(id) => {
+              const index = layout.values.toasts.findIndex((toast) => toast.id === id);
+              if (index !== -1) {
+                // Allow time for the toast to animate out.
+                // TODO(burdon): Factor out and unregister timeout.
+                setTimeout(() => {
+                  if (layout.values.toasts[index].id === currentUndoId) {
+                    currentUndoId = undefined;
+                  }
+                  layout.values.toasts.splice(index, 1);
+                }, 1_000);
+              }
+            }}
+          />
         );
       },
       surface: {
@@ -472,7 +492,7 @@ export const DeckPlugin = ({
                   }
                 });
 
-                location.values.active = newLayout;
+                handleSetLocation(newLayout);
               });
 
               const ids = openIds(location.values.active);
@@ -522,10 +542,12 @@ export const DeckPlugin = ({
               const layoutEntry = { id: data.id };
               const effectivePart = getEffectivePart(data.part, layout.values.layoutMode);
 
-              location.values.active = openEntry(location.values.active, effectivePart, layoutEntry, {
-                positioning: data.positioning ?? settings.values.newPlankPositioning,
-                pivotId: data.pivotId,
-              });
+              handleSetLocation(
+                openEntry(location.values.active, effectivePart, layoutEntry, {
+                  positioning: data.positioning ?? settings.values.newPlankPositioning,
+                  pivotId: data.pivotId,
+                }),
+              );
 
               const intents = [];
               if (data.scrollIntoView && layout.values.layoutMode === 'deck') {
@@ -561,7 +583,11 @@ export const DeckPlugin = ({
                   }
                 });
 
-                location.values.active = newLayout;
+                handleSetLocation(newLayout);
+                // TODO(wittjosiah): This needs to also set the closed state.
+                //   The closed state should be the existing closed state plus the newly closed ids.
+                //   The closed state should also be updated when opening entries to remove the id from closed.
+                //   When SET is called the closed ids should also be calculated and set.
                 return { data: true };
               });
             }
@@ -570,7 +596,7 @@ export const DeckPlugin = ({
             case NavigationAction.SET: {
               return batch(() => {
                 if (isLayoutParts(intent.data?.activeParts)) {
-                  location.values.active = intent.data!.activeParts;
+                  handleSetLocation(intent.data!.activeParts);
                 }
                 return { data: true };
               });
@@ -581,10 +607,12 @@ export const DeckPlugin = ({
                 if (isLayoutAdjustment(intent.data)) {
                   const adjustment = intent.data;
                   if (adjustment.type === 'increment-end' || adjustment.type === 'increment-start') {
-                    location.values.active = incrementPlank(location.values.active, {
-                      type: adjustment.type,
-                      layoutCoordinate: adjustment.layoutCoordinate,
-                    });
+                    handleSetLocation(
+                      incrementPlank(location.values.active, {
+                        type: adjustment.type,
+                        layoutCoordinate: adjustment.layoutCoordinate,
+                      }),
+                    );
                   }
 
                   if (adjustment.type === 'solo') {

package/src/components/DeckLayout/ComplementarySidebar.tsx

@@ -2,12 +2,18 @@
 // Copyright 2024 DXOS.org
 //
 
-import React from 'react';
+import React, { useMemo } from 'react';
 
-import { type LayoutParts, SLUG_PATH_SEPARATOR, Surface } from '@dxos/app-framework';
+import {
+  type LayoutParts,
+  NavigationAction,
+  SLUG_PATH_SEPARATOR,
+  Surface,
+  useIntentDispatcher,
+} from '@dxos/app-framework';
 import { useGraph } from '@dxos/plugin-graph';
 import { Main } from '@dxos/react-ui';
-import { createAttendableAttributes } from '@dxos/react-ui-attention';
+import { useAttended } from '@dxos/react-ui-attention';
 import { deckGrid } from '@dxos/react-ui-deck';
 import { mx } from '@dxos/react-ui-theme';
 
@@ -15,44 +21,89 @@ import { NodePlankHeading } from './NodePlankHeading';
 import { PlankContentError } from './PlankError';
 import { PlankLoading } from './PlankLoading';
 import { useNode, useNodeActionExpander } from '../../hooks';
+import { DECK_PLUGIN } from '../../meta';
 import { useLayout } from '../LayoutContext';
 
 export type ComplementarySidebarProps = {
-  id?: string;
+  context?: string;
   layoutParts: LayoutParts;
   flatDeck?: boolean;
 };
 
-export const ComplementarySidebar = ({ id, layoutParts, flatDeck }: ComplementarySidebarProps) => {
+const panels = ['comments', 'settings'] as const;
+type Panel = (typeof panels)[number];
+const getPanel = (part?: string): Panel => {
+  if (part && panels.findIndex((panel) => panel === part) !== -1) {
+    return part as Panel;
+  } else {
+    return 'settings';
+  }
+};
+
+export const ComplementarySidebar = ({ layoutParts, flatDeck }: ComplementarySidebarProps) => {
   const { popoverAnchorId } = useLayout();
+  const attended = useAttended();
+  const part = getPanel(layoutParts.complementary?.[0].id);
+  const id = attended[0] ? `${attended[0]}${SLUG_PATH_SEPARATOR}${part}` : undefined;
   const { graph } = useGraph();
   const node = useNode(graph, id);
-  // const complementaryAvailable = useMemo(() => id === NAV_ID || !!node, [id, node]);
-  const complementaryAttrs = createAttendableAttributes(id?.split(SLUG_PATH_SEPARATOR)[0] ?? 'never');
+  const dispatch = useIntentDispatcher();
 
   useNodeActionExpander(node);
 
+  const actions = useMemo(
+    () => [
+      {
+        id: 'complementary-settings',
+        data: () => {
+          void dispatch({ action: NavigationAction.OPEN, data: { activeParts: { complementary: 'settings' } } });
+        },
+        properties: {
+          label: ['settings label', { ns: DECK_PLUGIN }],
+          icon: 'ph--gear--regular',
+          menuItemType: 'toggle',
+          isChecked: part === 'settings',
+        },
+      },
+      {
+        id: 'complementary-comments',
+        data: () => {
+          void dispatch({ action: NavigationAction.OPEN, data: { activeParts: { complementary: 'comments' } } });
+        },
+        properties: {
+          label: ['comments label', { ns: DECK_PLUGIN }],
+          icon: 'ph--chat-text--regular',
+          menuItemType: 'toggle',
+          isChecked: part === 'comments',
+        },
+      },
+    ],
+    [part],
+  );
+
   return (
-    <Main.ComplementarySidebar {...complementaryAttrs}>
-      {node ? (
-        <div role='none' className={mx(deckGrid, 'grid-cols-1 bs-full')}>
-          <NodePlankHeading
-            node={node}
-            id={id}
-            layoutParts={layoutParts}
-            layoutPart='complementary'
-            popoverAnchorId={popoverAnchorId}
-            flatDeck={flatDeck}
-          />
+    <Main.ComplementarySidebar>
+      <div role='none' className={mx(deckGrid, 'grid-cols-1 bs-full')}>
+        <NodePlankHeading
+          node={node}
+          id={id}
+          layoutParts={layoutParts}
+          layoutPart='complementary'
+          popoverAnchorId={popoverAnchorId}
+          flatDeck={flatDeck}
+          actions={actions}
+        />
+        {/* TODO(wittjosiah): Render some placeholder when node is undefined. */}
+        {node && (
           <Surface
-            role='article'
-            data={{ subject: node.data, part: 'complementary', popoverAnchorId }}
+            role={`complementary--${part}`}
+            data={{ subject: node.properties.object, popoverAnchorId }}
             limit={1}
             fallback={PlankContentError}
             placeholder={<PlankLoading />}
           />
-        </div>
-      ) : null}
+        )}
+      </div>
     </Main.ComplementarySidebar>
   );
 };

package/src/components/DeckLayout/DeckLayout.tsx

@@ -3,11 +3,9 @@
 //
 
 import { Sidebar as MenuIcon } from '@phosphor-icons/react';
-import React, { useCallback, useEffect, useMemo, useRef, useState, useLayoutEffect, type UIEvent } from 'react';
+import React, { useCallback, useEffect, useMemo, useRef, type UIEvent } from 'react';
 
 import {
-  SLUG_PATH_SEPARATOR,
-  type Attention,
   type LayoutEntry,
   type LayoutParts,
   Surface,
@@ -15,7 +13,8 @@ import {
   firstIdInPart,
   usePlugin,
 } from '@dxos/app-framework';
-import { Button, Dialog, Main, Popover, useTranslation } from '@dxos/react-ui';
+import { Button, Dialog, Main, Popover, useOnTransition, useTranslation } from '@dxos/react-ui';
+import { useAttended } from '@dxos/react-ui-attention';
 import { Deck } from '@dxos/react-ui-deck';
 import { getSize } from '@dxos/react-ui-theme';
 
@@ -35,11 +34,10 @@ import { useLayout } from '../LayoutContext';
 
 export type DeckLayoutProps = {
   layoutParts: LayoutParts;
-  attention: Attention;
   toasts: ToastSchema[];
   flatDeck?: boolean;
   overscroll: Overscroll;
-  showHintsFooter: boolean;
+  showHints: boolean;
   slots?: {
     wallpaper?: { classNames?: string };
   };
@@ -48,11 +46,10 @@ export type DeckLayoutProps = {
 
 export const DeckLayout = ({
   layoutParts,
-  attention,
   toasts,
   flatDeck,
   overscroll,
-  showHintsFooter,
+  showHints,
   slots,
   onDismissToast,
 }: DeckLayoutProps) => {
@@ -70,36 +67,42 @@ export const DeckLayout = ({
   } = context;
   const { t } = useTranslation(DECK_PLUGIN);
   const { plankSizing } = useDeckContext();
+  const attended = useAttended();
   const searchPlugin = usePlugin('dxos.org/plugin/search');
   const fullScreenSlug = useMemo(() => firstIdInPart(layoutParts, 'fullScreen'), [layoutParts]);
 
-  const [scrollLeft, setScrollLeft] = useState<number | null>(null);
-  const deckRef = useRef<HTMLDivElement | null>(null);
-  const restoreScrollRef = useRef<boolean>(false);
+  const scrollLeftRef = useRef<number | null>();
+  const deckRef = useRef<HTMLDivElement>(null);
+
+  // Ensure the first plank is attended when the deck is first rendered.
+  useEffect(() => {
+    const firstId = layoutMode === 'solo' ? firstIdInPart(layoutParts, 'solo') : firstIdInPart(layoutParts, 'main');
+    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.
+      document.querySelector<HTMLElement>(`article[data-attendable-id="${firstId}"] button`)?.focus();
+    }
+  }, []);
 
   /**
    * Clear scroll restoration state if the window is resized
    */
   const handleResize = useCallback(() => {
-    setScrollLeft(null);
+    scrollLeftRef.current = null;
   }, []);
+
   useEffect(() => {
     window.addEventListener('resize', handleResize);
     return () => window.removeEventListener('resize', handleResize);
   }, [handleResize]);
 
-  /**
-   * Restore scroll when returning to deck mode
-   */
-  useLayoutEffect(() => {
-    if (layoutMode !== 'deck') {
-      restoreScrollRef.current = true;
-    } else if (restoreScrollRef.current && deckRef.current && scrollLeft) {
-      // console.log('[restoring scrollLeft]', scrollLeft);
-      deckRef.current.scrollLeft = scrollLeft;
-      restoreScrollRef.current = false;
+  const restoreScroll = useCallback(() => {
+    if (deckRef.current && scrollLeftRef.current != null) {
+      deckRef.current.scrollLeft = scrollLeftRef.current;
     }
-  }, [layoutMode, deckRef.current, scrollLeft]);
+  }, []);
+
+  useOnTransition(layoutMode, (mode) => mode !== 'deck', 'deck', restoreScroll);
 
   /**
    * Save scroll position as the user scrolls
@@ -107,22 +110,13 @@ export const DeckLayout = ({
   const handleScroll = useCallback(
     (event: UIEvent) => {
       if (layoutMode === 'deck' && event.currentTarget === event.target) {
-        // console.log('[save scroll left]', (event.target as HTMLDivElement).scrollLeft);
-        setScrollLeft((event.target as HTMLDivElement).scrollLeft);
+        scrollLeftRef.current = (event.target as HTMLDivElement).scrollLeft;
       }
     },
     [layoutMode],
   );
 
-  const complementarySlug = useMemo(() => {
-    const entry = layoutParts.complementary?.at(0);
-    if (entry) {
-      return entry.path ? `${entry.id}${SLUG_PATH_SEPARATOR}${entry.path}` : entry.id;
-    }
-  }, [layoutParts]);
-
-  const firstAttendedId = useMemo(() => Array.from(attention.attended ?? [])[0], [attention.attended]);
-
+  const firstAttendedId = attended[0];
   useEffect(() => {
     // TODO(burdon): Can we prevent the need to re-scroll since the planks are preserved?
     //  E.g., hide the deck and just move the solo article?
@@ -145,10 +139,12 @@ export const DeckLayout = ({
     return parts;
   }, [layoutParts.main, layoutParts.solo]);
 
-  const padding =
-    layoutMode === 'deck' && overscroll === 'centering'
-      ? calculateOverscroll(layoutParts.main, plankSizing, sidebarOpen, complementarySidebarOpen)
-      : {};
+  const padding = useMemo(() => {
+    if (layoutMode === 'deck' && overscroll === 'centering') {
+      return calculateOverscroll(layoutParts.main, plankSizing, sidebarOpen, complementarySidebarOpen);
+    }
+    return {};
+  }, [layoutMode, overscroll, layoutParts.main, plankSizing, sidebarOpen, complementarySidebarOpen]);
 
   if (layoutMode === 'fullscreen') {
     return <Fullscreen id={fullScreenSlug} />;
@@ -173,25 +169,17 @@ export const DeckLayout = ({
       <Main.Root
         navigationSidebarOpen={context.sidebarOpen}
         onNavigationSidebarOpenChange={(next) => (context.sidebarOpen = next)}
-        {...(complementarySidebarOpen !== null && {
-          complementarySidebarOpen: /* complementaryAvailable && */ context.complementarySidebarOpen as boolean,
-          onComplementarySidebarOpenChange: (next) => (context.complementarySidebarOpen = next),
-        })}
+        complementarySidebarOpen={context.complementarySidebarOpen}
+        onComplementarySidebarOpenChange={(next) => (context.complementarySidebarOpen = next)}
       >
         {/* Notch */}
         <Main.Notch classNames='z-[21]'>
           <Surface role='notch-start' />
-          <Button
-            // disabled={!sidebarAvailable}
-            onClick={() => (context.sidebarOpen = !context.sidebarOpen)}
-            variant='ghost'
-            classNames='p-1'
-          >
+          <Button onClick={() => (context.sidebarOpen = !context.sidebarOpen)} variant='ghost' classNames='p-1'>
             <span className='sr-only'>{t('open navigation sidebar label')}</span>
             <MenuIcon weight='light' className={getSize(5)} />
           </Button>
           <Button
-            // disabled={!complementaryAvailable}
             onClick={() => (context.complementarySidebarOpen = !context.complementarySidebarOpen)}
             variant='ghost'
             classNames='p-1'
@@ -203,10 +191,11 @@ export const DeckLayout = ({
         </Main.Notch>
 
         {/* Left sidebar. */}
-        <Sidebar attention={attention} layoutParts={layoutParts} />
+        <Sidebar layoutParts={layoutParts} />
 
         {/* Right sidebar. */}
-        <ComplementarySidebar id={complementarySlug} layoutParts={layoutParts} flatDeck={flatDeck} />
+        {/* TODO(wittjosiah): Get context from layout parts. */}
+        <ComplementarySidebar context='comments' layoutParts={layoutParts} flatDeck={flatDeck} />
 
         {/* Dialog overlay to dismiss dialogs. */}
         <Main.Overlay />
@@ -245,15 +234,8 @@ export const DeckLayout = ({
           </Main.Content>
         )}
 
-        <StatusBar />
-
-        {/* Help hints. */}
-        {/* TODO(burdon): Need to make room for this in status bar. */}
-        {showHintsFooter && (
-          <div className='fixed bottom-0 left-0 right-0 h-[32px] z-[1] flex justify-center'>
-            <Surface role='hints' limit={1} />
-          </div>
-        )}
+        {/* Footer status. */}
+        <StatusBar showHints={showHints} />
 
         {/* Global popovers. */}
         <Popover.Portal>