@dxos/plugin-simple-layout 0.8.4-main.69d29f4 → 0.8.4-main.7996785055

package/src/components/SimpleLayout/SimpleLayout.stories.tsx

@@ -5,81 +5,71 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import * as Effect from 'effect/Effect';
 
-import { Capability, Common, Plugin } from '@dxos/app-framework';
+import { ActivationEvents, Capability, Plugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
-import { ClientOperation, ClientPlugin } from '@dxos/plugin-client';
+import { AppActivationEvents } from '@dxos/app-toolkit';
+import { Collection } from '@dxos/echo';
+import { ClientPlugin } from '@dxos/plugin-client';
 import { SearchPlugin } from '@dxos/plugin-search';
 import { SpacePlugin } from '@dxos/plugin-space';
-import { SpaceOperation } from '@dxos/plugin-space/types';
 import { corePlugins } from '@dxos/plugin-testing';
-import { withTheme } from '@dxos/react-ui/testing';
-import { translations as searchTranslation } from '@dxos/react-ui-searchlist';
-import { Collection } from '@dxos/schema';
+import { withLayout } from '@dxos/react-ui/testing';
+import { translations as searchTranslation } from '@dxos/react-ui-search';
 
-import { OperationResolver, type SimpleLayoutStateOptions, State } from '../../capabilities';
+import { ReactRoot, ReactSurface, State } from '../../capabilities';
 import { meta as pluginMeta } from '../../meta';
 import { type SimpleLayoutPluginOptions } from '../../SimpleLayoutPlugin';
 import { translations } from '../../translations';
+import { SimpleLayoutEvents } from '../../types';
 
 import { SimpleLayout } from './SimpleLayout';
 
-const TestPlugin = Plugin.define<SimpleLayoutPluginOptions>(pluginMeta).pipe(
-  Plugin.addModule(({ isPopover = false }) => ({
-    id: Capability.getModuleTag(State),
-    activatesOn: Common.ActivationEvent.Startup,
-    activatesAfter: [Common.ActivationEvent.LayoutReady],
-    activate: () => State({ initialState: { isPopover } } satisfies SimpleLayoutStateOptions),
-  })),
-  Common.Plugin.addOperationResolverModule({ activate: OperationResolver }),
-  Plugin.addModule({
-    id: 'setup',
-    activatesOn: Common.ActivationEvent.OperationInvokerReady,
-    activate: Effect.fnUntraced(function* () {
-      const { invoke } = yield* Capability.get(Common.Capability.OperationInvoker);
-      yield* invoke(ClientOperation.CreateIdentity, {});
-      const { space: work } = yield* invoke(SpaceOperation.Create, { name: 'Work Space' });
-      const { space: sharedProject } = yield* invoke(SpaceOperation.Create, { name: 'Shared Project' });
-
-      // Add collections to Work Space.
-      yield* invoke(SpaceOperation.AddObject, {
-        target: work.db,
-        object: Collection.make({ name: 'Projects', objects: [] }),
-      });
-      yield* invoke(SpaceOperation.AddObject, {
-        target: work.db,
-        object: Collection.make({ name: 'Documents', objects: [] }),
-      });
-
-      // Add collections to Shared Project.
-      yield* invoke(SpaceOperation.AddObject, {
-        target: sharedProject.db,
-        object: Collection.make({ name: 'Tasks', objects: [] }),
-      });
-      yield* invoke(SpaceOperation.AddObject, {
-        target: sharedProject.db,
-        object: Collection.make({ name: 'Notes', objects: [] }),
-      });
-    }),
-  }),
-  Plugin.make,
-);
-
-const createPluginManager = ({ isPopover }: { isPopover: boolean }) => {
+const createPluginManager = ({ isPopover }: { isPopover?: boolean }) => {
   return withPluginManager({
+    setupEvents: [AppActivationEvents.SetupSettings],
     plugins: [
       ...corePlugins(),
       ClientPlugin({
         types: [Collection.Collection],
+        onClientInitialized: ({ client }) =>
+          Effect.gen(function* () {
+            yield* Effect.promise(() => client.halo.createIdentity());
+          }),
       }),
+
       SearchPlugin(),
       SpacePlugin({}),
-      TestPlugin({ isPopover }),
+
+      // TODO(burdon): This should be factored ouf from SimpleLayoutPlugin.
+      Plugin.define<SimpleLayoutPluginOptions>(pluginMeta).pipe(
+        Plugin.addModule(({ isPopover = false }) => ({
+          id: Capability.getModuleTag(State),
+          activatesOn: ActivationEvents.Startup,
+          activatesAfter: [SimpleLayoutEvents.StateReady, AppActivationEvents.LayoutReady],
+          activate: () => State({ initialState: { isPopover } }),
+        })),
+        Plugin.addModule({
+          id: Capability.getModuleTag(ReactRoot),
+          activatesOn: ActivationEvents.Startup,
+          activate: ReactRoot,
+        }),
+        Plugin.addModule({
+          id: Capability.getModuleTag(ReactSurface),
+          activatesOn: ActivationEvents.Startup,
+          activate: ReactSurface,
+        }),
+        Plugin.make,
+      )({ isPopover }),
     ],
   });
 };
 
+/**
+ * NOTE: To expose to iphone on network:
+ * `moon run storybook-react:serve dev -H 0.0.0.0`
+ */
 const meta = {
-  title: 'plugins/plugin-simple-layout/SimpleLayout',
+  title: 'plugins/plugin-simple-layout/components/SimpleLayout',
   component: SimpleLayout,
   parameters: {
     layout: 'fullscreen',
@@ -92,9 +82,9 @@ export default meta;
 type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
-  decorators: [withTheme, createPluginManager({ isPopover: false })],
+  decorators: [withLayout({ layout: 'column', classNames: 'relative' }), createPluginManager({})],
 };
 
 export const Popover: Story = {
-  decorators: [withTheme, createPluginManager({ isPopover: true })],
+  decorators: [withLayout({ layout: 'column', classNames: 'relative' }), createPluginManager({ isPopover: true })],
 };

package/src/components/SimpleLayout/SimpleLayout.tsx

@@ -2,19 +2,57 @@
 // Copyright 2025 DXOS.org
 //
 
-import React from 'react';
+import React, { useLayoutEffect, useRef, useState } from 'react';
 
+import { Splitter, type SplitterMode } from '@dxos/react-ui';
+import { Mosaic } from '@dxos/react-ui-mosaic';
+
+import { useSimpleLayoutState } from '../../hooks';
+import { DebugOverlay } from '../DebugOverlay';
 import { Dialog } from '../Dialog';
+import { MobileLayout } from '../MobileLayout';
 import { PopoverContent, PopoverRoot } from '../Popover';
 
+import { Drawer } from './Drawer';
 import { Main } from './Main';
 
 export const SimpleLayout = () => {
+  const { state } = useSimpleLayoutState();
+  const [keyboardOpen, setKeyboardOpen] = useState(false);
+  const [splitterMode, setSplitterMode] = useState<SplitterMode>('upper');
+
+  const drawerRef = useRef<HTMLDivElement>(null);
+
+  // Restore Splitter mode when keyboard closes.
+  useLayoutEffect(() => {
+    if (!keyboardOpen) {
+      setSplitterMode(state.drawerState === 'closed' ? 'upper' : state.drawerState === 'open' ? 'both' : 'lower');
+    }
+  }, [state.drawerState, keyboardOpen]);
+
   return (
-    <PopoverRoot>
-      <Main />
-      <Dialog />
-      <PopoverContent />
-    </PopoverRoot>
+    <DebugOverlay.Root enabled={false}>
+      <PopoverRoot>
+        <Mosaic.Root classNames='dx-container grid relative'>
+          <MobileLayout.Root
+            classNames='bg-toolbar-surface'
+            onKeyboardOpenChange={(nextKeyboardOpen) => setKeyboardOpen(nextKeyboardOpen)}
+          >
+            <MobileLayout.Panel safe={{ top: true, bottom: splitterMode === 'upper' }}>
+              <Splitter.Root mode={splitterMode} ratio={0.55}>
+                <Splitter.Panel position='upper'>
+                  <Main />
+                </Splitter.Panel>
+                <Splitter.Panel position='lower' ref={drawerRef}>
+                  <Drawer />
+                </Splitter.Panel>
+              </Splitter.Root>
+              <Dialog />
+              <PopoverContent />
+            </MobileLayout.Panel>
+          </MobileLayout.Root>
+        </Mosaic.Root>
+      </PopoverRoot>
+    </DebugOverlay.Root>
   );
 };

package/src/components/SimpleLayout/index.ts

@@ -2,4 +2,7 @@
 // Copyright 2026 DXOS.org
 //
 
+export * from './AppBar';
+export * from './Main';
+export * from './NavBar';
 export * from './SimpleLayout';

package/src/components/hooks.ts

@@ -4,27 +4,23 @@
 
 import { useEffect } from 'react';
 
-import { useAppGraph } from '@dxos/app-framework/react';
+import { expandAttendableId } from '@dxos/react-ui-attention';
+import { useAppGraph } from '@dxos/app-toolkit/ui';
 import { Graph } from '@dxos/plugin-graph';
 
 /**
- * Hook to expand graph nodes two levels deep when directly linked to.
+ * Expand graph nodes along the full path from root to the given node ID.
+ * Walks each progressive prefix, ensuring ancestor nodes are materialized
+ * before attempting to access their children.
  */
-export const useLoadDescendents = (nodeId?: string) => {
+export const useExpandPath = (nodeId?: string) => {
   const { graph } = useAppGraph();
 
   useEffect(() => {
-    const frame = requestAnimationFrame(() => {
-      if (nodeId) {
-        // First level: expand the node itself.
-        Graph.expand(graph, nodeId, 'outbound');
-        // Second level: expand each child.
-        Graph.getConnections(graph, nodeId, 'outbound').forEach((child) => {
-          Graph.expand(graph, child.id, 'outbound');
-        });
+    if (nodeId) {
+      for (const prefix of expandAttendableId(nodeId)) {
+        Graph.expand(graph, prefix, 'child');
       }
-    });
-
-    return () => cancelAnimationFrame(frame);
+    }
   }, [nodeId, graph]);
 };

package/src/components/index.ts

@@ -2,8 +2,10 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './ContentLoading';
+export * from './DebugOverlay';
 export * from './Home';
+export * from './Loading';
+export * from './MobileLayout';
 export * from './Popover';
 export * from './SimpleLayout';
-export * from './Workspace';
+export * from './NavBranch';

package/src/hooks/actions.ts

@@ -0,0 +1,83 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+
+import { type AppCapabilities, getCompanionVariant } from '@dxos/app-toolkit';
+import { Node } from '@dxos/plugin-graph';
+import { type ActionGraphProps } from '@dxos/react-ui-menu';
+import { byPosition } from '@dxos/util';
+
+import { type SimpleLayoutState } from '../types';
+
+// TODO(wittjosiah): Factor out to shared location with plugin-deck.
+export const PLANK_COMPANION_TYPE = 'org.dxos.plugin.deck.plank-companion';
+
+export type CompanionActionsConfig = {
+  /** Prefix for companion action IDs (e.g. 'navbar' or 'drawer') */
+  idPrefix: string;
+  /** Optional: highlight companion with this variant */
+  selectedVariant?: string;
+  /** State updater for toggling the drawer. */
+  updateState: (fn: (state: SimpleLayoutState) => SimpleLayoutState) => void;
+};
+
+/**
+ * Creates action graph nodes and edges for companion actions.
+ * Shared logic between useNavbarActions and useDrawerActions.
+ */
+// TODO(burdon): Use builder pattern.
+export const createCompanionActions = (
+  graph: AppCapabilities.AppGraph['graph'],
+  stateAtom: Atom.Atom<SimpleLayoutState>,
+  get: (atom: Atom.Atom<any>) => any,
+  config: CompanionActionsConfig,
+): Pick<ActionGraphProps, 'nodes' | 'edges'> => {
+  const { idPrefix, selectedVariant, updateState } = config;
+
+  // Derive activeId from state atom.
+  const state = get(stateAtom);
+  const activeId = state.active ?? state.workspace;
+
+  // Get companions from graph connections for activeId.
+  const activeConnections = activeId ? get(graph.connections(activeId, 'child')) : [];
+  const companions = activeConnections
+    .filter((node: Node.Node) => node.type === PLANK_COMPANION_TYPE)
+    .toSorted((a: Node.Node, b: Node.Node) => byPosition(a.properties, b.properties));
+
+  const nodes: ActionGraphProps['nodes'] = [];
+  const edges: ActionGraphProps['edges'] = [];
+
+  companions.forEach((companion: Node.Node) => {
+    const companionVariant = getCompanionVariant(companion.id);
+    const companionAction = {
+      id: `${idPrefix}-companion-${companion.id}`,
+      type: Node.ActionType,
+      properties: {
+        icon: companion.properties.icon ?? 'ph--placeholder--regular',
+        label: companion.properties.label,
+        iconOnly: true,
+        ...(selectedVariant !== undefined && {
+          variant: selectedVariant === companionVariant ? 'primary' : 'ghost',
+        }),
+      },
+      data: () =>
+        Effect.sync(() =>
+          updateState((current) => {
+            const closing = current.companionVariant === companionVariant && current.drawerState !== 'closed';
+            return {
+              ...current,
+              companionVariant: closing ? undefined : companionVariant,
+              drawerState: closing ? 'closed' : 'open',
+            };
+          }),
+        ),
+    };
+    nodes.push(companionAction);
+    edges.push({ source: 'root', target: companionAction.id, relation: 'child' });
+  });
+
+  return { nodes, edges };
+};

package/src/hooks/index.ts

@@ -2,4 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
+export * from './useAppBarProps';
+export * from './useCompanions';
+export * from './actions';
+export * from './useDrawerActions';
+export * from './useNavbarActions';
 export * from './useSimpleLayoutState';

package/src/hooks/useAppBarProps.ts

@@ -0,0 +1,115 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom, useAtomValue } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+import { useCallback, useMemo } from 'react';
+
+import { useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { useAppGraph } from '@dxos/app-toolkit/ui';
+import { Graph, Node, useActionRunner, useNode } from '@dxos/plugin-graph';
+import { toLocalizedString, useTranslation } from '@dxos/react-ui';
+import { type ActionGraphProps } from '@dxos/react-ui-menu';
+
+import { type AppBarProps } from '../components';
+import { meta } from '../meta';
+import { SimpleLayoutState as SimpleLayoutStateCapability } from '../types';
+
+/**
+ * Hook that computes all AppBar props from the app graph.
+ * Derives activeId from state atom. Returns props ready to spread into the AppBar component.
+ */
+export const useAppBarProps = (): Omit<AppBarProps, 'classNames'> => {
+  const { t } = useTranslation(meta.id);
+  const stateAtom = useCapability(SimpleLayoutStateCapability);
+  const state = useAtomValue(stateAtom);
+  const { graph } = useAppGraph();
+  const { invokePromise } = useOperationInvoker();
+  const runAction = useActionRunner();
+
+  // Derive activeId from state.
+  const activeId = state.active ?? state.workspace;
+  const node = useNode(graph, activeId);
+
+  // Compute title from node label.
+  const title = node ? toLocalizedString(node.properties.label, t) : undefined;
+
+  // Build actions atom filtering by disposition.
+  // Derive activeId from state atom so we don't need to recreate this atom when it changes.
+  const actionsAtom = useMemo(
+    () =>
+      Atom.make((get): ActionGraphProps => {
+        const state = get(stateAtom);
+        const activeId = state.active ?? state.workspace;
+        const allActions = activeId ? get(graph.actions(activeId)) : [];
+        const filtered = allActions.filter((action) =>
+          ['list-item', 'list-item-primary', 'heading-list-item'].includes(action.properties.disposition),
+        );
+        const nodes: ActionGraphProps['nodes'] = filtered as ActionGraphProps['nodes'];
+        const edges: ActionGraphProps['edges'] = filtered.map((action) => ({
+          source: 'root',
+          target: action.id,
+          relation: 'child',
+        }));
+
+        // Add alternate-tree action (e.g. Settings) from the workspace node.
+        const workspaceConnections = state.workspace ? get(graph.connections(state.workspace, 'child')) : [];
+        const alternateTreeNode = workspaceConnections.find(
+          (node: Node.Node) => node.properties.disposition === 'alternate-tree',
+        );
+        if (alternateTreeNode && activeId !== alternateTreeNode.id) {
+          const settingsAction = {
+            id: `appbar-settings-${alternateTreeNode.id}`,
+            type: Node.ActionType,
+            data: () => Effect.promise(() => invokePromise(LayoutOperation.Open, { subject: [alternateTreeNode.id] })),
+            properties: {
+              label: alternateTreeNode.properties.label ?? alternateTreeNode.id,
+              icon: alternateTreeNode.properties.icon ?? 'ph--placeholder--regular',
+            },
+          };
+          nodes.push(settingsAction);
+          edges.push({ source: 'root', target: settingsAction.id, relation: 'child' });
+        }
+
+        return { nodes, edges };
+      }),
+    [graph, stateAtom],
+  );
+
+  // Back button logic.
+  const showBackButton = activeId !== undefined && activeId !== Node.RootId;
+
+  const onBack = useCallback(() => {
+    if (state.active) {
+      const isWorkspace = Graph.getNode(graph, state.active).pipe(
+        Option.map((node) => node.properties.disposition === 'workspace'),
+        Option.getOrElse(() => false),
+      );
+
+      // If history is empty and this is a workspace, go to home.
+      if (state.history.length === 0 && isWorkspace) {
+        void invokePromise(LayoutOperation.SwitchWorkspace, { subject: Node.RootId });
+      } else {
+        // Otherwise, close (which will pop from history or clear active).
+        void invokePromise(LayoutOperation.Close, { subject: [state.active] });
+      }
+    } else {
+      void invokePromise(LayoutOperation.SwitchWorkspace, { subject: Node.RootId });
+    }
+  }, [graph, invokePromise, state.active, state.history.length]);
+
+  // Compute popover anchor ID.
+  const popoverAnchorId = node && state.popoverAnchorId === `${meta.id}:${node.id}` ? state.popoverAnchorId : undefined;
+
+  return {
+    title,
+    actions: actionsAtom,
+    showBackButton,
+    popoverAnchorId,
+    onBack: onBack,
+    onAction: runAction,
+  };
+};

package/src/hooks/useCompanions.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { useAppGraph } from '@dxos/app-toolkit/ui';
+import { useConnections } from '@dxos/plugin-graph';
+import { byPosition } from '@dxos/util';
+
+import { PLANK_COMPANION_TYPE } from './actions';
+
+/**
+ * @deprecated Adopt the pattern from useNavbarActions (deriving from graph atoms)
+ *   or merge the Drawer companion display into the NavBar component.
+ */
+export const useCompanions = (nodeId?: string) => {
+  const { graph } = useAppGraph();
+  const nodes = useConnections(graph, nodeId, 'child');
+  const companions = nodes.filter((node) => node.type === PLANK_COMPANION_TYPE);
+  return useMemo(() => companions.toSorted((a, b) => byPosition(a.properties, b.properties)), [companions]);
+};

package/src/hooks/useDrawerActions.ts

@@ -0,0 +1,100 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+import { useMemo } from 'react';
+
+import { useCapability } from '@dxos/app-framework/ui';
+import { useAppGraph } from '@dxos/app-toolkit/ui';
+import { Node, useActionRunner } from '@dxos/plugin-graph';
+import { useTranslation } from '@dxos/react-ui';
+import { type ActionExecutor, type ActionGraphProps, createGapSeparator } from '@dxos/react-ui-menu';
+
+import { useMobileLayout } from '../components';
+import { meta } from '../meta';
+import { SimpleLayoutState as SimpleLayoutStateCapability } from '../types';
+
+import { createCompanionActions } from './actions';
+import { useSimpleLayoutState } from './useSimpleLayoutState';
+
+export type DrawerActions = {
+  /** Action graph atom for the drawer. */
+  actions: Atom.Atom<ActionGraphProps>;
+  /** Action executor callback. */
+  onAction: ActionExecutor;
+};
+
+/**
+ * Builds the drawer actions including companion tabs and toolbar buttons.
+ */
+export const useDrawerActions = (consumerName: string): DrawerActions => {
+  const { t } = useTranslation(meta.id);
+  const stateAtom = useCapability(SimpleLayoutStateCapability);
+  const { graph } = useAppGraph();
+  const runAction = useActionRunner();
+  const { updateState } = useSimpleLayoutState();
+  const { keyboardOpen } = useMobileLayout(consumerName);
+
+  // Create a computed atom that derives everything from graph connections and state.
+  const actionsAtom = useMemo(
+    () =>
+      Atom.make((get): ActionGraphProps => {
+        // Derive drawer state from state atom.
+        const state = get(stateAtom);
+
+        // Add companion tab actions.
+        const { nodes, edges } = createCompanionActions(graph, stateAtom, get, {
+          idPrefix: 'drawer',
+          selectedVariant: state.drawerState !== 'closed' ? state.companionVariant : undefined,
+          updateState,
+        });
+
+        // Add gap separator before toolbar buttons.
+        const gapSeparator = createGapSeparator('drawer-gap');
+        nodes.push(...gapSeparator.nodes);
+        edges.push(...gapSeparator.edges);
+
+        // Add expand/collapse toggle button (hidden when keyboard is open).
+        if (!keyboardOpen) {
+          const isExpanded = state.drawerState === 'expanded';
+          const toggleExpandAction = {
+            id: 'drawer-toggle-expand',
+            type: Node.ActionType,
+            properties: {
+              icon: isExpanded ? 'ph--arrow-down--regular' : 'ph--arrow-up--regular',
+              label: isExpanded ? t('collapse drawer label') : t('expand drawer label'),
+              iconOnly: true,
+            },
+            data: () =>
+              Effect.sync(() => updateState((state) => ({ ...state, drawerState: isExpanded ? 'open' : 'expanded' }))),
+          };
+          nodes.push(toggleExpandAction);
+          edges.push({ source: 'root', target: toggleExpandAction.id, relation: 'child' });
+        }
+
+        // Add close button.
+        const closeAction = {
+          id: 'drawer-close',
+          type: Node.ActionType,
+          properties: {
+            icon: 'ph--x--regular',
+            label: t('close drawer label'),
+            iconOnly: true,
+          },
+          data: () =>
+            Effect.sync(() =>
+              updateState((state) => ({ ...state, drawerState: 'closed', companionVariant: undefined })),
+            ),
+        };
+        nodes.push(closeAction);
+        edges.push({ source: 'root', target: closeAction.id, relation: 'child' });
+
+        return { nodes, edges };
+      }),
+    [graph, stateAtom, updateState, keyboardOpen, t],
+  );
+
+  return { actions: actionsAtom, onAction: runAction };
+};