@dxos/plugin-deck 0.6.8-main.046e6cf → 0.6.8-staging.63bcb81

package/src/components/DeckLayout/DeckLayout.tsx

@@ -3,11 +3,12 @@
 //
 
 import { Sidebar as MenuIcon } from '@phosphor-icons/react';
-import React, { useMemo } from 'react';
+import React, { useEffect, useMemo, useRef } from 'react';
 
 import {
   SLUG_PATH_SEPARATOR,
   type Attention,
+  type LayoutEntry,
   type LayoutParts,
   Surface,
   type Toast as ToastSchema,
@@ -16,7 +17,7 @@ import {
 } from '@dxos/app-framework';
 import { Button, Dialog, Main, Popover, useTranslation } from '@dxos/react-ui';
 import { Deck } from '@dxos/react-ui-deck';
-import { getSize, mx } from '@dxos/react-ui-theme';
+import { getSize } from '@dxos/react-ui-theme';
 
 import { ActiveNode } from './ActiveNode';
 import { ComplementarySidebar } from './ComplementarySidebar';
@@ -32,30 +33,27 @@ import { useDeckContext } from '../DeckContext';
 import { useLayout } from '../LayoutContext';
 
 export type DeckLayoutProps = {
-  showHintsFooter: boolean;
-  overscroll: Overscroll;
-  flatDeck?: boolean;
-  toasts: ToastSchema[];
-  onDismissToast: (id: string) => void;
   layoutParts: LayoutParts;
   attention: Attention;
-  // TODO(Zan): Deprecate slots.
+  toasts: ToastSchema[];
+  flatDeck?: boolean;
+  overscroll: Overscroll;
+  showHintsFooter: boolean;
   slots?: {
     wallpaper?: { classNames?: string };
-    deck?: { classNames?: string };
-    plank?: { classNames?: string };
   };
+  onDismissToast: (id: string) => void;
 };
 
 export const DeckLayout = ({
-  showHintsFooter,
+  layoutParts,
+  attention,
   toasts,
-  onDismissToast,
   flatDeck,
-  attention,
-  layoutParts,
-  slots,
   overscroll,
+  showHintsFooter,
+  slots,
+  onDismissToast,
 }: DeckLayoutProps) => {
   const context = useLayout();
   const {
@@ -71,7 +69,7 @@ export const DeckLayout = ({
   } = context;
   const { t } = useTranslation(DECK_PLUGIN);
   const { plankSizing } = useDeckContext();
-
+  const searchPlugin = usePlugin('dxos.org/plugin/search');
   const fullScreenSlug = useMemo(() => firstIdInPart(layoutParts, 'fullScreen'), [layoutParts]);
 
   const complementarySlug = useMemo(() => {
@@ -81,17 +79,39 @@ export const DeckLayout = ({
     }
   }, [layoutParts]);
 
-  const searchEnabled = !!usePlugin('dxos.org/plugin/search');
   const activeId = useMemo(() => Array.from(attention.attended ?? [])[0], [attention.attended]);
 
-  const overscrollAmount = calculateOverscroll(
-    layoutMode,
-    sidebarOpen,
-    complementarySidebarOpen,
-    layoutParts,
-    plankSizing,
-    overscroll,
-  );
+  const deckRef = useRef<HTMLDivElement | null>(null);
+  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?
+    if (layoutMode === 'deck' && activeId) {
+      // setTimeout(() => {
+      // const el = deckRef.current?.querySelector(`article[data-attendable-id="${activeId}"]`);
+      // el?.scrollIntoView({ behavior: 'smooth', inline: 'center' });
+      // }, 0);
+    }
+  }, [layoutMode, activeId]);
+
+  // TODO(burdon): Needs cleaning up.
+  const parts: LayoutEntry[] = useMemo(() => {
+    const parts = [...(layoutParts.main ?? [])];
+    for (const part of layoutParts.solo ?? []) {
+      if (!parts.find((entry) => entry.id === part.id)) {
+        parts.push(part);
+      }
+    }
+    return parts;
+  }, [layoutParts.main, layoutParts.solo]);
+
+  const showPlank = (part: LayoutEntry) => {
+    return layoutMode === 'deck' || layoutParts.solo?.find((entry) => entry.id === part.id);
+  };
+
+  const padding =
+    layoutMode === 'deck' && overscroll === 'centering'
+      ? calculateOverscroll(layoutParts.main, plankSizing, sidebarOpen, complementarySidebarOpen)
+      : {};
 
   if (layoutMode === 'fullscreen') {
     return <Fullscreen id={fullScreenSlug} />;
@@ -110,6 +130,7 @@ export const DeckLayout = ({
         }
       }}
     >
+      {/* TODO(burdon): Factor out hook to set document title. */}
       <ActiveNode id={activeId} />
 
       <Main.Root
@@ -144,83 +165,63 @@ export const DeckLayout = ({
           <Surface role='notch-end' />
         </Main.Notch>
 
-        {/* Sidebars */}
+        {/* Left sidebar. */}
         <Sidebar attention={attention} layoutParts={layoutParts} />
 
+        {/* Right sidebar. */}
         <ComplementarySidebar id={complementarySlug} layoutParts={layoutParts} flatDeck={flatDeck} />
 
         {/* Dialog overlay to dismiss dialogs. */}
         <Main.Overlay />
 
-        {/* Main content surface. */}
-        {layoutMode === 'deck' && layoutParts.main && layoutParts.main.length > 0 && (
-          <Main.Content bounce classNames={['grid', 'block-end-[--statusbar-size]']}>
-            <div role='none' className='relative'>
-              <Deck.Root
-                classNames={mx(
-                  'absolute inset-0',
-                  !flatDeck && 'surface-deck',
-                  slots?.wallpaper?.classNames,
-                  slots?.deck?.classNames,
-                  'transition-[padding] duration-200 ease-in-out',
-                )}
-                style={{ ...overscrollAmount }}
-              >
-                {layoutParts.main.map((layoutEntry) => {
-                  return (
-                    <Plank
-                      key={layoutEntry.id}
-                      entry={layoutEntry}
-                      layoutParts={layoutParts}
-                      part='main'
-                      resizeable
-                      flatDeck={flatDeck}
-                      searchEnabled={searchEnabled}
-                    />
-                  );
-                })}
-              </Deck.Root>
-            </div>
+        {/* No content. */}
+        {parts.length === 0 && (
+          <Main.Content handlesFocus>
+            <ContentEmpty />
           </Main.Content>
         )}
 
-        {/* Solo main content surface. */}
-        {layoutMode === 'solo' && layoutParts.solo && layoutParts.solo.length > 0 && (
-          <Main.Content bounce classNames={['grid', 'block-end-[--statusbar-size]']}>
-            <Deck.Root
-              classNames={[!flatDeck && 'surface-deck', slots?.wallpaper?.classNames, slots?.deck?.classNames]}
-              solo={true}
-            >
-              {layoutParts.solo.map((layoutEntry) => {
-                return (
+        {/* Solo/deck mode. */}
+        {parts.length !== 0 && (
+          <Main.Content bounce classNames='grid block-end-[--statusbar-size]' handlesFocus>
+            <div role='none' className={layoutMode === 'solo' ? 'contents' : 'relative'}>
+              <Deck.Root
+                ref={deckRef}
+                solo={layoutMode === 'solo'}
+                style={padding}
+                classNames={[
+                  !flatDeck && 'surface-deck',
+                  layoutMode === 'deck' && [
+                    'absolute inset-0',
+                    'transition-[padding] duration-200 ease-in-out',
+                    slots?.wallpaper?.classNames,
+                  ],
+                ]}
+              >
+                {parts.map((layoutEntry) => (
                   <Plank
                     key={layoutEntry.id}
                     entry={layoutEntry}
                     layoutParts={layoutParts}
-                    part='solo'
+                    part={layoutMode === 'solo' && layoutEntry.id === activeId ? 'solo' : 'main'}
                     flatDeck={flatDeck}
-                    classNames={slots?.plank?.classNames}
+                    searchEnabled={!!searchPlugin}
+                    resizeable={layoutMode === 'deck'}
+                    classNames={showPlank(layoutEntry) ? '' : 'hidden'}
                   />
-                );
-              })}
-            </Deck.Root>
-          </Main.Content>
-        )}
-
-        {((layoutMode === 'solo' && (!layoutParts.solo || layoutParts.solo.length === 0)) ||
-          (layoutMode === 'deck' && (!layoutParts.main || layoutParts.main.length === 0))) && (
-          <Main.Content>
-            <ContentEmpty />
+                ))}
+              </Deck.Root>
+            </div>
           </Main.Content>
         )}
 
-        {/* Note: This is not Main.Content */}
-        <Main.Content role='none' classNames={['fixed inset-inline-0 block-end-0 z-[2]']}>
+        {/* TODO(burdon): Why Main.Content? */}
+        <Main.Content role='none' classNames='fixed inset-inline-0 block-end-0 z-[2]'>
           <Surface role='status-bar' limit={1} />
         </Main.Content>
 
         {/* Help hints. */}
-        {/* TODO(burdon): Make surface roles/names fully-qualified. */}
+        {/* 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} />

package/src/components/DeckLayout/Plank.tsx

@@ -3,7 +3,7 @@
 //
 
 import { Plus } from '@phosphor-icons/react';
-import React, { useCallback } from 'react';
+import React, { type KeyboardEvent, useCallback, useLayoutEffect, useRef } from 'react';
 
 import {
   LayoutAction,
@@ -24,7 +24,6 @@ import { Plank as NaturalPlank } from '@dxos/react-ui-deck';
 import { NodePlankHeading } from './NodePlankHeading';
 import { PlankContentError, PlankError } from './PlankError';
 import { PlankLoading } from './PlankLoading';
-import { NAV_ID } from './constants';
 import { DeckAction } from '../../DeckPlugin';
 import { useNode } from '../../hooks';
 import { DECK_PLUGIN } from '../../meta';
@@ -49,8 +48,10 @@ export const Plank = ({ entry, layoutParts, part, resizeable, flatDeck, searchEn
   const { plankSizing } = useDeckContext();
   const { graph } = useGraph();
   const node = useNode(graph, entry.id);
+  const rootElement = useRef<HTMLDivElement | null>(null);
 
   const attendableAttrs = createAttendableAttributes(entry.id);
+  const coordinate: LayoutCoordinate = { part, entryId: entry.id };
 
   const size = plankSizing?.[entry.id] as number | undefined;
   const setSize = useCallback(
@@ -60,23 +61,36 @@ export const Plank = ({ entry, layoutParts, part, resizeable, flatDeck, searchEn
     [dispatch, entry.id],
   );
 
-  const coordinate: LayoutCoordinate = { part, entryId: entry.id };
+  // TODO(thure): Tabster’s focus group should handle moving focus to Main, but something is blocking it.
+  const handleKeyDown = useCallback((event: KeyboardEvent) => {
+    if (event.target === event.currentTarget && event.key === 'Escape') {
+      rootElement.current?.closest('main')?.focus();
+    }
+  }, []);
+
+  useLayoutEffect(() => {
+    if (scrollIntoView === entry.id) {
+      rootElement.current?.scrollIntoView({ behavior: 'smooth', inline: 'center' });
+    }
+  }, [scrollIntoView]);
 
   return (
-    <NaturalPlank.Root size={size} setSize={setSize}>
-      <NaturalPlank.Content
-        {...attendableAttrs}
-        classNames={[!flatDeck && 'surface-base', classNames]}
-        scrollIntoViewOnMount={entry.id === scrollIntoView}
-        suppressAutofocus={entry.id === NAV_ID || !!node?.properties?.managesAutofocus}
-      >
+    <NaturalPlank.Root
+      size={size}
+      setSize={setSize}
+      classNames={classNames}
+      {...attendableAttrs}
+      onKeyDown={handleKeyDown}
+      ref={rootElement}
+    >
+      <NaturalPlank.Content classNames={[!flatDeck && 'surface-base']}>
         {node ? (
           <>
             <NodePlankHeading
+              id={entry.id}
+              node={node}
               layoutPart={coordinate.part}
               layoutParts={layoutParts}
-              node={node}
-              id={entry.id}
               popoverAnchorId={popoverAnchorId}
               flatDeck={flatDeck}
             />

package/src/layout.ts

@@ -7,12 +7,12 @@ import {
   type LayoutAdjustment,
   type LayoutCoordinate,
   type LayoutEntry,
+  type LayoutPart,
   type LayoutParts,
   SLUG_ENTRY_SEPARATOR,
   SLUG_KEY_VALUE_SEPARATOR,
   SLUG_LIST_SEPARATOR,
   SLUG_PATH_SEPARATOR,
-  type LayoutPart,
 } from '@dxos/app-framework';
 
 import { type NewPlankPositioning } from './types';
@@ -161,7 +161,9 @@ export const mergeLayoutParts = (...layoutParts: LayoutParts[]): LayoutParts =>
 };
 
 //
-// --- URI Projection ---------------------------------------------------------
+// URI Projection
+//
+
 const parseLayoutEntry = (itemString: string): LayoutEntry => {
   // Layout entries are in the form of 'id~path' or just 'id'
   const [id, path] = itemString.split(SLUG_PATH_SEPARATOR);

package/src/util/overscroll.ts

@@ -2,70 +2,64 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type LayoutMode, type LayoutParts } from '@dxos/app-framework';
-import { PLANK_DEFAULTS } from '@dxos/react-ui-deck';
+import type { CSSProperties } from 'react';
 
-import { type Overscroll } from '../types';
+import { type LayoutEntry } from '@dxos/app-framework';
+import { PLANK_DEFAULTS } from '@dxos/react-ui-deck';
 
+/**
+ * ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
+ * | Overscroll Padding Calculation for Centering Planks on Screen.                                     │
+ * ├────────────────────────────────────────────────────────────────────────────────────────────────────┤
+ * │ NOTE(Zan): I found the way you calculate the overscroll padding to center a plank on the screen    │
+ * │ at the edges of the scroll context a bit confusing, so I've diagrammed it here.                    │
+ * │                                                                                                    │
+ * │ Multiple Planks:                                                                                   │
+ * │ ───────────────                                                                                    │
+ * | Use the following overscroll padding calculation centering the boundary planks on the SCREEN.      │
+ * │                                                                                                    │
+ * │ Left Padding:                           Right Padding:                                             │
+ * │ ┌───┬────┬──────────────────┬──────┐    ┌──────┬──────────────────┬────┬───┐                       │
+ * │ │   │████│     Ideal        │      │    │      │      Ideal       │████│   │                       │
+ * │ │ S │█PL█│     first        │      │    │      │      last        │█PR█│ C │                       │
+ * │ │   │████│     plank        │      │    │      │      plank       │████│   │                       │
+ * │ └───┴────┴──────────────────┴──────┘    └──────┴──────────────────┴────┴───┘                       │
+ * │ <--------- screen width ----------->    <---------- screen width ---------->                       │
+ * │                                                                                                    │
+ * │ PL = ((screen width - Plank Width) / 2) - S                                                        │
+ * │ PR = ((screen width - Plank Width) / 2) - C                                                        │
+ * │                                                                                                    │
+ * │ S  = Sidebar width                     C  = Complementary sidebar width                            │
+ * │ PL = Padding Left                      PR = Padding Right                                          │
+ * │                                                                                                    │
+ * │ Single Plank:                                                                                      │
+ * │ ─────────────                                                                                      │
+ * │ For a single plank we use the following overscroll padding calculation to center the plank in      │
+ * │ the content area:                                                                                  │
+ * │                                                                                                    │
+ * │ ┌───┬───────────────────────┬───┬───────────────────────┬───┐                                      │
+ * │ │   │███████████████████████│   │███████████████████████│   │                                      │
+ * │ │ S │█████ Left Padding ████│ P │████ Right Padding ████│ C │                                      │
+ * │ │   │███████████████████████│   │███████████████████████│   │                                      │
+ * │ └───┴───────────────────────┴───┴───────────────────────┴───┘                                      │
+ * │ <------------------------ screen width --------------------->                                      │
+ * │                                                                                                    │
+ * │ Left/Right Padding Width = (screen width - S - P - C) / 2                                          │
+ * │                                                                                                    │
+ * │ S = Sidebar width (may be 0)                                                                       │
+ * │ P = Plank width (centered)                                                                         │
+ * │ C = Complementary sidebar width (may be 0)                                                         │
+ * └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+ */
 export const calculateOverscroll = (
-  layoutMode: LayoutMode,
+  planks: LayoutEntry[] | undefined,
+  plankSizing: Record<string, number>,
   sidebarOpen: boolean,
   complementarySidebarOpen: boolean,
-  layoutParts: LayoutParts,
-  plankSizing: Record<string, number>,
-  overscroll: Overscroll,
-) => {
-  if (!(layoutMode === 'deck' && overscroll === 'centering')) {
+): Pick<CSSProperties, 'paddingLeft' | 'paddingRight'> | undefined => {
+  if (!planks?.length) {
     return;
   }
-  if (!layoutParts.main || layoutParts.main.length === 0) {
-    return;
-  }
-
-  /**
-   * ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
-   * | Overscroll Padding Calculation for Centering Planks on Screen.                                     │
-   * ├────────────────────────────────────────────────────────────────────────────────────────────────────┤
-   * │ NOTE(Zan): I found the way you calculate the overscroll padding to center a plank on the screen    │
-   * │ at the edges of the scroll context a bit confusing, so I've diagrammed it here.                    │
-   * │                                                                                                    │
-   * │ Multiple Planks:                                                                                   │
-   * │ ───────────────                                                                                    │
-   * | Use the following overscroll padding calculation centering the boundary planks on the SCREEN.      │
-   * │                                                                                                    │
-   * │ Left Padding:                           Right Padding:                                             │
-   * │ ┌───┬────┬──────────────────┬──────┐    ┌──────┬──────────────────┬────┬───┐                       │
-   * │ │   │████│     Ideal        │      │    │      │      Ideal       │████│   │                       │
-   * │ │ S │█PL█│     first        │      │    │      │      last        │█PR█│ C │                       │
-   * │ │   │████│     plank        │      │    │      │      plank       │████│   │                       │
-   * │ └───┴────┴──────────────────┴──────┘    └──────┴──────────────────┴────┴───┘                       │
-   * │ <--------- screen width ----------->    <---------- screen width ---------->                       │
-   * │                                                                                                    │
-   * │ PL = ((screen width - Plank Width) / 2) - S                                                        │
-   * │ PR = ((screen width - Plank Width) / 2) - C                                                        │
-   * │                                                                                                    │
-   * │ S  = Sidebar width                     C  = Complementary sidebar width                            │
-   * │ PL = Padding Left                      PR = Padding Right                                          │
-   * │                                                                                                    │
-   * │ Single Plank:                                                                                      │
-   * │ ─────────────                                                                                      │
-   * │ For a single plank we use the following overscroll padding calculation to center the plank in      │
-   * │ the content area:                                                                                  │
-   * │                                                                                                    │
-   * │ ┌───┬───────────────────────┬───┬───────────────────────┬───┐                                      │
-   * │ │   │███████████████████████│   │███████████████████████│   │                                      │
-   * │ │ S │█████ Left Padding ████│ P │████ Right Padding ████│ C │                                      │
-   * │ │   │███████████████████████│   │███████████████████████│   │                                      │
-   * │ └───┴───────────────────────┴───┴───────────────────────┴───┘                                      │
-   * │ <------------------------ screen width --------------------->                                      │
-   * │                                                                                                    │
-   * │ Left/Right Padding Width = (screen width - S - P - C) / 2                                          │
-   * │                                                                                                    │
-   * │ S = Sidebar width (may be 0)                                                                       │
-   * │ P = Plank width (centered)                                                                         │
-   * │ C = Complementary sidebar width (may be 0)                                                         │
-   * └────────────────────────────────────────────────────────────────────────────────────────────────────┘
-   */
 
   // TODO(Zan): Move complementary sidebar size (360px), sidebar size (270px), plank resize handle size (20px) to CSS variables.
   const sidebarWidth = sidebarOpen ? '270px' : '0px';
@@ -73,25 +67,24 @@ export const calculateOverscroll = (
 
   const getPlankSize = (id: string) => (plankSizing[id] ?? PLANK_DEFAULTS.size).toFixed(2) + 'rem';
 
-  if (layoutParts.main.length === 1) {
+  if (planks.length === 1) {
     // Center the plank in the content area.
-
-    const plank = layoutParts.main[0];
+    const plank = planks[0];
     const plankSize = getPlankSize(plank.id);
     const overscrollPadding = `max(0px, calc(((100dvw - ${sidebarWidth} - ${complementarySidebarWidth} - (${plankSize} + 20px)) / 2)))`;
 
     return { paddingLeft: overscrollPadding, paddingRight: overscrollPadding };
   } else {
     // Center the plank on the screen.
+    const first = planks[0];
+    const firstSize = getPlankSize(first.id);
 
-    const firstPlank = layoutParts.main[0];
-    const firstPlankInlineSize = getPlankSize(firstPlank.id);
-    const paddingLeft = `max(0px, calc(((100dvw - (${firstPlankInlineSize} + 20px)) / 2) - ${sidebarWidth}))`;
-
-    const lastPlank = layoutParts.main[layoutParts.main.length - 1];
-    const lastPlankInlineSize = getPlankSize(lastPlank.id);
-    const paddingRight = `max(0px, calc(((100dvw - (${lastPlankInlineSize} + 20px)) / 2) - ${complementarySidebarWidth}))`;
+    const last = planks[planks.length - 1];
+    const lastSize = getPlankSize(last.id);
 
-    return { paddingLeft, paddingRight };
+    return {
+      paddingLeft: `max(0px, calc(((100dvw - (${firstSize} + 20px)) / 2) - ${sidebarWidth}))`,
+      paddingRight: `max(0px, calc(((100dvw - (${lastSize} + 20px)) / 2) - ${complementarySidebarWidth}))`,
+    };
   }
 };