@dxos/plugin-deck 0.7.5-main.9d26e3a → 0.7.5-main.b19bfc8

package/src/components/DeckLayout/Plank.tsx

@@ -5,66 +5,58 @@
 import React, { type KeyboardEvent, memo, useCallback, useLayoutEffect, useMemo, useRef } from 'react';
 
 import {
-  type LayoutCoordinate,
-  type LayoutEntry,
-  type LayoutPart,
-  type LayoutParts,
+  createIntent,
+  LayoutAction,
   Surface,
+  useCapability,
+  useAppGraph,
   useIntentDispatcher,
-  type Layout,
-  indexInPart,
-  partLength,
-  LayoutAction,
-  createIntent,
 } from '@dxos/app-framework';
 import { debounce } from '@dxos/async';
-import { useGraph } from '@dxos/plugin-graph';
 import { useAttendableAttributes } from '@dxos/react-ui-attention';
 import { StackItem, railGridHorizontal } from '@dxos/react-ui-stack';
 import { mainIntrinsicSize, mx } from '@dxos/react-ui-theme';
 
-import { NodePlankHeading } from './NodePlankHeading';
+import { NodePlankHeading, type NodePlankHeadingProps } from './NodePlankHeading';
 import { PlankContentError, PlankError } from './PlankError';
 import { PlankLoading } from './PlankLoading';
+import { DeckCapabilities } from '../../capabilities';
 import { useNode, useMainSize } from '../../hooks';
-import { DeckAction } from '../../types';
-import { useDeckContext } from '../DeckContext';
-import { useLayout } from '../LayoutContext';
+import { DeckAction, type LayoutMode } from '../../types';
 
 const UNKNOWN_ID = 'unknown_id';
 
 export type PlankProps = {
-  entry?: LayoutEntry;
-  layoutParts: LayoutParts;
-  // TODO(wittjosiah): Remove. Pass in LayoutCoordinate instead of LayoutEntry.
-  part: LayoutPart;
-  layoutMode: Layout['layoutMode'];
+  id?: string;
+  part: NodePlankHeadingProps['part'];
+  path?: string[];
   order?: number;
+  active?: string[];
+  layoutMode: LayoutMode;
 };
 
-export const Plank = memo(({ entry, layoutParts, part, layoutMode, order }: PlankProps) => {
+export const Plank = memo(({ id = UNKNOWN_ID, part, path, order, active, layoutMode }: PlankProps) => {
   const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const coordinate: LayoutCoordinate = useMemo(() => ({ part, entryId: entry?.id ?? UNKNOWN_ID }), [entry?.id, part]);
-  const { popoverAnchorId, scrollIntoView } = useLayout();
-  const { plankSizing } = useDeckContext();
-  const { graph } = useGraph();
-  const node = useNode(graph, entry?.id);
+  const { deck, popoverAnchorId, scrollIntoView } = useCapability(DeckCapabilities.DeckState);
+  const { graph } = useAppGraph();
+  const node = useNode(graph, id);
   const rootElement = useRef<HTMLDivElement | null>(null);
   const canResize = layoutMode === 'deck';
   const Root = part === 'solo' ? 'article' : StackItem.Root;
 
-  const attendableAttrs = useAttendableAttributes(coordinate.entryId);
-  const index = indexInPart(layoutParts, coordinate);
-  const length = partLength(layoutParts, part);
-  const canIncrementStart = part === 'main' && index !== undefined && index > 0 && length !== undefined && length > 1;
-  const canIncrementEnd = part === 'main' && index !== undefined && index < length - 1 && length !== undefined;
+  const attendableAttrs = useAttendableAttributes(id);
+  const index = active ? active.findIndex((entryId) => entryId === id) : 0;
+  const length = active?.length ?? 1;
+  const canIncrementStart = active && index !== undefined && index > 0 && length !== undefined && length > 1;
+  const canIncrementEnd = active && index !== undefined && index < length - 1 && length !== undefined;
 
-  const size = plankSizing?.[coordinate.entryId] as number | undefined;
+  const key = id.split('+')[0];
+  const size = deck.plankSizing[key] as number | undefined;
   const setSize = useCallback(
     debounce((nextSize: number) => {
-      return dispatch(createIntent(DeckAction.UpdatePlankSize, { id: coordinate.entryId, size: nextSize }));
+      return dispatch(createIntent(DeckAction.UpdatePlankSize, { id: key, size: nextSize }));
     }, 200),
-    [dispatch, coordinate.entryId],
+    [dispatch, key],
   );
 
   // TODO(thure): Tabster’s focus group should handle moving focus to Main, but something is blocking it.
@@ -75,19 +67,19 @@ export const Plank = memo(({ entry, layoutParts, part, layoutMode, order }: Plan
   }, []);
 
   useLayoutEffect(() => {
-    if (scrollIntoView === coordinate.entryId) {
+    if (scrollIntoView === id) {
       // TODO(wittjosiah): When focused on page load, the focus is always visible.
       //   Forcing focus to something smaller than the plank prevents large focus ring in the interim.
       const focusable = rootElement.current?.querySelector('button') || rootElement.current;
       focusable?.focus({ preventScroll: true });
       layoutMode === 'deck' && focusable?.scrollIntoView({ behavior: 'smooth', inline: 'center' });
       // Clear the scroll into view state once it has been actioned.
-      void dispatch(createIntent(LayoutAction.ScrollIntoView, { id: undefined }));
+      void dispatch(createIntent(LayoutAction.ScrollIntoView, { part: 'current', subject: undefined }));
     }
-  }, [coordinate.entryId, scrollIntoView, layoutMode]);
+  }, [id, scrollIntoView, layoutMode]);
 
   const isSolo = layoutMode === 'solo' && part === 'solo';
-  const isAttendable = isSolo || (layoutMode === 'deck' && part === 'main');
+  const isAttendable = isSolo || (layoutMode === 'deck' && part === 'deck');
 
   const sizeAttrs = useMainSize();
 
@@ -95,11 +87,10 @@ export const Plank = memo(({ entry, layoutParts, part, layoutMode, order }: Plan
     () =>
       node && {
         subject: node.data,
-        path: entry?.path,
-        coordinate,
+        path,
         popoverAnchorId,
       },
-    [node, node?.data, entry?.path, coordinate, popoverAnchorId],
+    [node, node?.data, path, popoverAnchorId],
   );
 
   // TODO(wittjosiah): Change prop to accept a component.
@@ -120,7 +111,7 @@ export const Plank = memo(({ entry, layoutParts, part, layoutMode, order }: Plan
       {...(part === 'solo'
         ? ({ ...sizeAttrs, className } as any)
         : {
-            item: { id: entry?.id ?? 'never' },
+            item: { id },
             size,
             onSizeChange: setSize,
             classNames: className,
@@ -133,7 +124,8 @@ export const Plank = memo(({ entry, layoutParts, part, layoutMode, order }: Plan
       {node ? (
         <>
           <NodePlankHeading
-            coordinate={coordinate}
+            id={id}
+            part={part}
             node={node}
             canIncrementStart={canIncrementStart}
             canIncrementEnd={canIncrementEnd}
@@ -149,7 +141,7 @@ export const Plank = memo(({ entry, layoutParts, part, layoutMode, order }: Plan
           />
         </>
       ) : (
-        <PlankError layoutCoordinate={coordinate} />
+        <PlankError id={id} part={part} />
       )}
       {canResize && <StackItem.ResizeHandle />}
     </Root>

package/src/components/DeckLayout/PlankControls.tsx

@@ -4,7 +4,6 @@
 
 import React, { forwardRef } from 'react';
 
-import { type PartAdjustment } from '@dxos/app-framework';
 import {
   Button,
   ButtonGroup,
@@ -16,8 +15,9 @@ import {
 } from '@dxos/react-ui';
 
 import { DECK_PLUGIN } from '../../meta';
+import { type DeckAction } from '../../types';
 
-export type PlankControlHandler = (event: PartAdjustment) => void;
+export type PlankControlHandler = (event: DeckAction.PartAdjustment) => void;
 
 export type PlankCapabilities = {
   incrementStart?: boolean;
@@ -40,7 +40,7 @@ const PlankControl = ({ icon, label, ...props }: Omit<ButtonProps, 'children'> &
       <Tooltip.Trigger asChild>
         <Button variant='ghost' {...props}>
           <span className='sr-only'>{label}</span>
-          <Icon icon={icon} size={4} />
+          <Icon icon={icon} size={5} />
         </Button>
       </Tooltip.Trigger>
       <Tooltip.Portal>
@@ -52,17 +52,18 @@ const PlankControl = ({ icon, label, ...props }: Omit<ButtonProps, 'children'> &
 
 // TODO(wittjosiah): Duplicate of stack LayoutControls?
 //   Translations were to be duplicated between packages.
+// NOTE(thure): Pinning & unpinning are disabled indefinitely.
 export const PlankControls = forwardRef<HTMLDivElement, PlankControlsProps>(
   (
-    { onClick, variant = 'default', capabilities: can, isSolo, pin, close = false, children, ...props },
+    { onClick, variant = 'default', capabilities: can, isSolo, pin, close = false, children, classNames, ...props },
     forwardedRef,
   ) => {
     const { t } = useTranslation(DECK_PLUGIN);
-    const buttonClassNames = variant === 'hide-disabled' ? 'disabled:hidden !pli-2 !plb-3' : '!pli-2 !plb-3';
+    const buttonClassNames = variant === 'hide-disabled' ? 'disabled:hidden pli-2 plb-3' : 'pli-2 plb-3';
 
     return (
-      <ButtonGroup {...props} ref={forwardedRef}>
-        {pin && !isSolo && ['both', 'start'].includes(pin) && (
+      <ButtonGroup {...props} classNames={['app-no-drag', classNames]} ref={forwardedRef}>
+        {/* {pin && !isSolo && ['both', 'start'].includes(pin) && (
           <PlankControl
             label={t('pin start label')}
             variant='ghost'
@@ -70,14 +71,14 @@ export const PlankControls = forwardRef<HTMLDivElement, PlankControlsProps>(
             onClick={() => onClick?.('pin-start')}
             icon='ph--caret-line-left--regular'
           />
-        )}
+        )} */}
 
         {can.solo && (
           <PlankControl
             label={isSolo ? t('show deck plank label') : t('show solo plank label')}
             classNames={buttonClassNames}
             onClick={() => onClick?.('solo')}
-            icon={isSolo ? 'ph--arrow-u-down-left--regular' : 'ph--arrows-out--regular'}
+            icon={isSolo ? 'ph--corners-in--regular' : 'ph--corners-out--regular'}
           />
         )}
 
@@ -100,14 +101,14 @@ export const PlankControls = forwardRef<HTMLDivElement, PlankControlsProps>(
           </>
         )}
 
-        {pin && !isSolo && ['both', 'end'].includes(pin) && (
+        {/* {pin && !isSolo && ['both', 'end'].includes(pin) && (
           <PlankControl
             label={t('pin end label')}
             classNames={buttonClassNames}
             onClick={() => onClick?.('pin-end')}
             icon='ph--caret-line-right--regular'
           />
-        )}
+        )} */}
 
         {close && !isSolo && (
           <PlankControl

package/src/components/DeckLayout/PlankError.tsx

@@ -4,12 +4,11 @@
 
 import React, { useEffect, useState } from 'react';
 
-import { type LayoutCoordinate } from '@dxos/app-framework';
 import { type Node } from '@dxos/plugin-graph';
 import { useTranslation } from '@dxos/react-ui';
 import { descriptionText, mx } from '@dxos/react-ui-theme';
 
-import { NodePlankHeading } from './NodePlankHeading';
+import { NodePlankHeading, type NodePlankHeadingProps } from './NodePlankHeading';
 import { PlankLoading } from './PlankLoading';
 import { DECK_PLUGIN } from '../../meta';
 
@@ -33,11 +32,13 @@ export const PlankContentError = ({ error }: { error?: Error }) => {
 };
 
 export const PlankError = ({
-  layoutCoordinate,
+  id,
+  part,
   node,
   error,
 }: {
-  layoutCoordinate: LayoutCoordinate;
+  id: string;
+  part: NodePlankHeadingProps['part'];
   node?: Node;
   error?: Error;
 }) => {
@@ -47,7 +48,7 @@ export const PlankError = ({
   }, []);
   return (
     <>
-      <NodePlankHeading coordinate={layoutCoordinate} node={node} pending={!timedOut} />
+      <NodePlankHeading id={id} part={part} node={node} pending={!timedOut} />
       {timedOut ? <PlankContentError error={error} /> : <PlankLoading />}
     </>
   );

package/src/components/DeckLayout/Sidebar.tsx

@@ -4,21 +4,31 @@
 
 import React, { useMemo } from 'react';
 
-import { type LayoutParts, Surface } from '@dxos/app-framework';
+import { Surface, useCapability } from '@dxos/app-framework';
 import { Main } from '@dxos/react-ui';
 
-import { useLayout } from '../LayoutContext';
+import { DeckCapabilities } from '../../capabilities';
+import { layoutAppliesTopbar, useBreakpoints, useHoistStatusbar } from '../../util';
 
-export type SidebarProps = {
-  layoutParts: LayoutParts;
-};
+export const Sidebar = () => {
+  const { popoverAnchorId, activeDeck: current } = useCapability(DeckCapabilities.DeckState);
+  const breakpoint = useBreakpoints();
+  const topbar = layoutAppliesTopbar(breakpoint);
+  const hoistStatusbar = useHoistStatusbar(breakpoint);
 
-export const Sidebar = ({ layoutParts }: SidebarProps) => {
-  const { popoverAnchorId } = useLayout();
-  const navigationData = useMemo(() => ({ popoverAnchorId }), [popoverAnchorId]);
+  const navigationData = useMemo(
+    () => ({ popoverAnchorId, topbar, hoistStatusbar, current }),
+    [popoverAnchorId, topbar, hoistStatusbar, current],
+  );
 
   return (
-    <Main.NavigationSidebar>
+    <Main.NavigationSidebar
+      classNames={[
+        'grid',
+        topbar && 'block-start-[calc(env(safe-area-inset-top)+var(--rail-size))]',
+        hoistStatusbar && 'block-end-[--statusbar-size]',
+      ]}
+    >
       <Surface role='navigation' data={navigationData} limit={1} />
     </Main.NavigationSidebar>
   );

package/src/components/DeckLayout/SidebarButton.tsx

@@ -0,0 +1,68 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { useCapability } from '@dxos/app-framework';
+import { IconButton, type IconButtonProps, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+
+import { DeckCapabilities } from '../../capabilities';
+import { DECK_PLUGIN } from '../../meta';
+
+export const ToggleSidebarButton = ({
+  classNames,
+  variant = 'ghost',
+}: ThemedClassName<Pick<IconButtonProps, 'variant'>>) => {
+  const layoutContext = useCapability(DeckCapabilities.MutableDeckState);
+  const { t } = useTranslation(DECK_PLUGIN);
+  return (
+    <IconButton
+      variant={variant}
+      iconOnly
+      icon='ph--sidebar--regular'
+      size={4}
+      label={t('open navigation sidebar label')}
+      onClick={() =>
+        (layoutContext.sidebarState = layoutContext.sidebarState === 'expanded' ? 'collapsed' : 'expanded')
+      }
+      classNames={classNames}
+    />
+  );
+};
+
+export const CloseSidebarButton = () => {
+  const layoutContext = useCapability(DeckCapabilities.MutableDeckState);
+  const { t } = useTranslation(DECK_PLUGIN);
+  return (
+    <IconButton
+      variant='ghost'
+      iconOnly
+      icon='ph--caret-line-left--regular'
+      size={4}
+      label={t('close navigation sidebar label')}
+      onClick={() => (layoutContext.sidebarState = 'collapsed')}
+      classNames='rounded-none pli-1 dx-focus-ring-inset pie-[max(.5rem,env(safe-area-inset-left))]'
+    />
+  );
+};
+
+export const ToggleComplementarySidebarButton = ({ inR0, classNames }: ThemedClassName<{ inR0?: boolean }>) => {
+  const layoutContext = useCapability(DeckCapabilities.MutableDeckState);
+  const { t } = useTranslation(DECK_PLUGIN);
+  return (
+    <IconButton
+      iconOnly
+      onClick={() =>
+        (layoutContext.complementarySidebarState =
+          layoutContext.complementarySidebarState === 'expanded' ? 'collapsed' : 'expanded')
+      }
+      variant='ghost'
+      label={t('open complementary sidebar label')}
+      classNames={['[&>svg]:-scale-x-100', classNames]}
+      icon='ph--sidebar-simple--regular'
+      size={inR0 ? 5 : 4}
+      tooltipSide={inR0 ? 'left' : undefined}
+    />
+  );
+};

package/src/components/DeckLayout/StatusBar.tsx

@@ -5,23 +5,17 @@
 import React from 'react';
 
 import { Surface } from '@dxos/app-framework';
-import { mainPadding, mainPaddingTransitions, mx } from '@dxos/react-ui-theme';
-
-import { useMainSize } from '../../hooks';
+import { useLandmarkMover } from '@dxos/react-ui';
 
 export const StatusBar = ({ showHints }: { showHints?: boolean }) => {
-  const sizeAttrs = useMainSize();
+  const mover = useLandmarkMover(undefined, '3');
   return (
     <div
-      role='none'
-      {...sizeAttrs}
-      className={mx(
-        'fixed flex justify-between block-end-0 inset-inline-0 items-center border-bs border-separator z-[2]',
-        mainPadding,
-        mainPaddingTransitions,
-      )}
+      role='contentinfo'
+      className='fixed block-end-0 inset-inline-0 bs-[--statusbar-size] border-bs border-separator z-[2] flex text-description'
+      {...mover}
     >
-      <div role='none'>{showHints && <Surface role='hints' limit={1} />}</div>
+      {showHints && <Surface role='hints' limit={1} />}
       <Surface role='status-bar' limit={1} />
     </div>
   );

package/src/components/DeckLayout/Toast.tsx

@@ -4,7 +4,7 @@
 
 import React from 'react';
 
-import type { Toast as ToastProps } from '@dxos/app-framework';
+import { type LayoutAction } from '@dxos/app-framework';
 import {
   Button,
   Icon,
@@ -28,7 +28,7 @@ export const Toast = ({
   closeLabel,
   onAction,
   onOpenChange,
-}: ToastProps & Pick<ToastRootProps, 'onOpenChange'>) => {
+}: LayoutAction.Toast & Pick<ToastRootProps, 'onOpenChange'>) => {
   const { t } = useTranslation(DECK_PLUGIN);
 
   return (

package/src/components/DeckLayout/Topbar.tsx

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { Banner } from './Banner';
+
+export const Topbar = () => {
+  return <Banner variant='topbar' />;
+};

package/src/components/LayoutSettings.tsx

@@ -5,7 +5,7 @@
 import React from 'react';
 
 import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { DeprecatedFormInput } from '@dxos/react-ui-form';
+import { DeprecatedFormContainer, DeprecatedFormInput } from '@dxos/react-ui-form';
 
 import { DECK_PLUGIN } from '../meta';
 import {
@@ -22,7 +22,7 @@ export const LayoutSettings = ({ settings }: { settings: DeckSettingsProps }) =>
   const { t } = useTranslation(DECK_PLUGIN);
 
   return (
-    <>
+    <DeprecatedFormContainer>
       <DeprecatedFormInput label={t('select new plank positioning label')}>
         <Select.Root
           value={settings.newPlankPositioning ?? 'start'}
@@ -72,12 +72,12 @@ export const LayoutSettings = ({ settings }: { settings: DeckSettingsProps }) =>
           />
         </DeprecatedFormInput>
       )}
-      <DeprecatedFormInput label={t('settings custom slots')}>
-        <Input.Switch checked={settings.customSlots} onCheckedChange={(checked) => (settings.customSlots = checked)} />
+      <DeprecatedFormInput label={t('settings enable ide-style statusbar label')}>
+        <Input.Switch
+          checked={settings.enableIdeStyleStatusbar}
+          onCheckedChange={(checked) => (settings.enableIdeStyleStatusbar = checked)}
+        />
       </DeprecatedFormInput>
-      <DeprecatedFormInput label={t('settings flat deck')}>
-        <Input.Switch checked={settings.flatDeck} onCheckedChange={(checked) => (settings.flatDeck = checked)} />
-      </DeprecatedFormInput>
-    </>
+    </DeprecatedFormContainer>
   );
 };

package/src/components/fragments.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { mx } from '@dxos/react-ui-theme';
+
+export const soloInlinePadding =
+  'pis-[calc(env(safe-area-inset-left)+.25rem)] pie-[calc(env(safe-area-inset-left)+.25rem)]';
+
+const sidebarToggleStyles = 'bs-[--rail-item] is-[--rail-item] absolute block-end-2 z-[1] !bg-deck lg:hidden';
+
+export const fixedSidebarToggleStyles = mx(sidebarToggleStyles, 'inline-start-2');
+
+export const fixedComplementarySidebarToggleStyles = mx(sidebarToggleStyles, 'inline-end-2');

package/src/components/index.ts

@@ -3,6 +3,4 @@
 //
 
 export * from './DeckLayout';
-export * from './DeckContext';
-export * from './LayoutContext';
 export * from './LayoutSettings';

package/src/events.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Events } from '@dxos/app-framework';
+
+import { DECK_PLUGIN } from './meta';
+
+export namespace DeckEvents {
+  export const SetupComplementaryPanels = Events.createStateEvent(`${DECK_PLUGIN}/setup-complementary-panels`);
+  export const StateReady = Events.createStateEvent(`${DECK_PLUGIN}/state-ready`);
+}

package/src/hooks/useMainSize.ts

@@ -5,9 +5,9 @@
 import { useMainContext } from '@dxos/react-ui';
 
 export const useMainSize = () => {
-  const { navigationSidebarOpen, complementarySidebarOpen } = useMainContext('DeckPluginPlank');
+  const { navigationSidebarState, complementarySidebarState } = useMainContext('DeckPluginPlank');
   return {
-    'data-sidebar-inline-start-state': navigationSidebarOpen ? 'open' : 'closed',
-    'data-sidebar-inline-end-state': complementarySidebarOpen ? 'open' : 'closed',
+    'data-sidebar-inline-start-state': navigationSidebarState,
+    'data-sidebar-inline-end-state': complementarySidebarState,
   };
 };

package/src/hooks/useNode.ts

@@ -34,7 +34,9 @@ export const useNode = <T = any>(graph: Graph, id?: string, timeout?: number): N
         if (node) {
           setNodeState(node);
         }
-      } catch {}
+      } catch {
+        // TODO(ZaymonFC): This leaves the resolved node in an invalid state in the case of a timeout.
+      }
     });
 
     return () => cancelAnimationFrame(frame);

package/src/index.ts

@@ -2,8 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { DeckPlugin } from './DeckPlugin';
-
-export default DeckPlugin;
-
+export { DeckCapabilities } from './capabilities';
+export { DeckEvents } from './events';
 export * from './DeckPlugin';
+export * from './meta';