@dxos/plugin-simple-layout 0.8.4-main.21d9917 → 0.8.4-main.2244d791bb

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

@@ -0,0 +1,144 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom } from '@effect-atom/atom-react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+import { type Mock, expect, fn, screen, userEvent, within } from 'storybook/test';
+
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { type ActionGraphProps, createMenuAction } from '@dxos/react-ui-menu';
+import { withRegistry } from '@dxos/storybook-utils';
+
+import { translations } from '../../translations';
+import { MobileLayout } from '../MobileLayout';
+
+import { AppBar, type AppBarProps } from './AppBar';
+
+const buildEmptyActions = (): ActionGraphProps => ({ nodes: [], edges: [] });
+
+const buildDefaultActions = (): ActionGraphProps => {
+  const result: ActionGraphProps = { nodes: [], edges: [] };
+  const actions = [
+    createMenuAction('action-edit', () => console.log('Edit'), {
+      icon: 'ph--pencil--regular',
+      label: 'Edit',
+    }),
+    createMenuAction('action-share', () => console.log('Share'), {
+      icon: 'ph--share--regular',
+      label: 'Share',
+    }),
+    createMenuAction('action-delete', () => console.log('Delete'), {
+      icon: 'ph--trash--regular',
+      label: 'Delete',
+    }),
+  ];
+  result.nodes.push(...actions);
+  result.edges.push(...actions.map((a) => ({ source: 'root', target: a.id })));
+  return result;
+};
+
+type StoryProps = Omit<AppBarProps, 'actions'> & {
+  actions: ActionGraphProps;
+};
+
+const DefaultStory = ({ actions: actionsProp, ...props }: StoryProps) => {
+  const actions = useMemo(() => Atom.make(actionsProp).pipe(Atom.keepAlive), [actionsProp]);
+  return (
+    <MobileLayout.Root>
+      <AppBar {...props} actions={actions} />
+    </MobileLayout.Root>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-simple-layout/AppBar',
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({
+      layout: 'column',
+      classNames: 'relative',
+    }),
+    withRegistry,
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<StoryProps>;
+
+export const Default: Story = {
+  tags: ['test'],
+  args: {
+    actions: buildDefaultActions(),
+    title: 'Document Title',
+    showBackButton: true,
+    onAction: fn(),
+    onBack: fn(),
+  },
+  play: async ({ args, canvasElement }) => {
+    const canvas = within(canvasElement);
+
+    // Verify the banner renders with the correct title.
+    await expect(canvas.getByRole('banner')).toBeInTheDocument();
+    await expect(canvas.getByText('Document Title')).toBeInTheDocument();
+
+    // Test back button click.
+    const backButton = canvas.getByRole('button', { name: /back/i });
+    await expect(backButton).toBeInTheDocument();
+    await userEvent.click(backButton);
+    await expect(args.onBack).toHaveBeenCalledTimes(1);
+
+    // Test actions menu opens and action fires.
+    const menuTrigger = canvas.getByRole('button', { name: /actions/i });
+    await expect(menuTrigger).toBeInTheDocument();
+    await userEvent.click(menuTrigger);
+
+    // Wait for menu to open and click an action (menu items render in a portal).
+    const editAction = await screen.findByRole('menuitem', { name: /edit/i });
+    await userEvent.click(editAction);
+    await expect(args.onAction).toHaveBeenCalledTimes(1);
+    await expect((args.onAction as Mock).mock.calls[0][0]).toHaveProperty('id', 'action-edit');
+  },
+};
+
+export const NoBackButton: Story = {
+  args: {
+    actions: buildDefaultActions(),
+    title: 'Home',
+    showBackButton: false,
+    onAction: (action) => console.log('Action:', action.id),
+  },
+};
+
+export const LongTitle: Story = {
+  args: {
+    actions: buildDefaultActions(),
+    title: 'This is a very long document title that should be truncated when it exceeds the available space',
+    showBackButton: true,
+    onBack: () => console.log('Back clicked'),
+    onAction: (action) => console.log('Action:', action.id),
+  },
+};
+
+export const NoActions: Story = {
+  args: {
+    actions: buildEmptyActions(),
+    title: 'Empty Document',
+    showBackButton: true,
+    onBack: () => console.log('Back clicked'),
+    onAction: (action) => console.log('Action:', action.id),
+  },
+};
+
+export const Empty: Story = {
+  args: {
+    actions: buildEmptyActions(),
+  },
+};

package/src/components/SimpleLayout/AppBar.tsx

@@ -0,0 +1,97 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom, useAtomValue } from '@effect-atom/atom-react';
+import React, { Fragment } from 'react';
+
+import { IconButton, Popover, type ThemedClassName, Toolbar, useTranslation } from '@dxos/react-ui';
+import {
+  type ActionExecutor,
+  type ActionGraphProps,
+  DropdownMenu,
+  MenuProvider,
+  useMenuActions,
+} from '@dxos/react-ui-menu';
+import { mx, osTranslations } from '@dxos/ui-theme';
+
+import { meta } from '../../meta';
+import { useMobileLayout } from '../MobileLayout';
+
+const APP_BAR_NAME = 'SimpleLayout.AppBar';
+
+export type AppBarProps = ThemedClassName<{
+  /** Title/label to display in the banner. */
+  title?: string;
+  /** Action graph atom for the dropdown menu. */
+  actions: Atom.Atom<ActionGraphProps>;
+  /** Whether to show the back button. */
+  showBackButton?: boolean;
+  /** Popover anchor ID for the dropdown trigger. */
+  popoverAnchorId?: string;
+  /** Action executor callback. */
+  onAction?: ActionExecutor;
+  /** Callback when back button is clicked. */
+  onBack?: () => void;
+}>;
+
+/**
+ * AppBar component that renders a title, optional back button, and actions dropdown.
+ */
+export const AppBar = ({
+  classNames,
+  title,
+  actions,
+  showBackButton,
+  popoverAnchorId,
+  onAction,
+  onBack,
+}: AppBarProps) => {
+  const { t } = useTranslation(meta.id);
+  const menu = useMenuActions(actions);
+  const actionsValue = useAtomValue(actions);
+  const hasActions = actionsValue.nodes.length > 0;
+  const { keyboardOpen } = useMobileLayout(APP_BAR_NAME);
+
+  // Fall back to app name if no title provided.
+  const displayTitle = title ?? t('current app name', { ns: osTranslations });
+
+  // Wrap the menu trigger with Popover.Anchor when the popoverAnchorId is set.
+  const AnchorRoot = popoverAnchorId ? Popover.Anchor : Fragment;
+
+  return (
+    <Toolbar.Root
+      role='banner'
+      classNames={mx('grid grid-cols-[var(--rail-size)_1fr_var(--rail-size)] items-center', 'density-fine', classNames)}
+    >
+      {keyboardOpen ? (
+        <IconButton variant='ghost' icon='ph--x--regular' iconOnly label={t('done label')} />
+      ) : showBackButton ? (
+        <IconButton variant='ghost' icon='ph--caret-left--regular' iconOnly label={t('back label')} onClick={onBack} />
+      ) : (
+        <div />
+      )}
+      <h1 className='text-center truncate font-thin uppercase'>{displayTitle}</h1>
+      {hasActions ? (
+        <AnchorRoot>
+          <MenuProvider {...menu} onAction={onAction}>
+            <DropdownMenu.Root caller={meta.id}>
+              <DropdownMenu.Trigger asChild>
+                <IconButton
+                  variant='ghost'
+                  icon='ph--dots-three-vertical--regular'
+                  iconOnly
+                  label={t('actions menu label')}
+                />
+              </DropdownMenu.Trigger>
+            </DropdownMenu.Root>
+          </MenuProvider>
+        </AnchorRoot>
+      ) : (
+        <span />
+      )}
+    </Toolbar.Root>
+  );
+};
+
+AppBar.displayName = APP_BAR_NAME;

package/src/components/SimpleLayout/Drawer.tsx

@@ -0,0 +1,102 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { Surface } from '@dxos/app-framework/ui';
+import { useAppGraph } from '@dxos/app-toolkit/ui';
+import { type Node, useNode } from '@dxos/plugin-graph';
+import { Layout } from '@dxos/react-ui';
+import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
+import { MenuProvider, ToolbarMenu, useMenuActions } from '@dxos/react-ui-menu';
+
+import { useCompanions, useDrawerActions, useSimpleLayoutState } from '../../hooks';
+import { ContentError } from '../ContentError';
+import { ContentLoading } from '../ContentLoading';
+
+const DRAWER_NAME = 'SimpleLayout.Drawer';
+
+/**
+ * Companion drawer component.
+ */
+export const Drawer = () => {
+  const { graph } = useAppGraph();
+  const { state: layoutState } = useSimpleLayoutState();
+
+  const placeholder = useMemo(() => <ContentLoading />, []);
+
+  // Get all companions for the current active (primary) item.
+  const activeId = layoutState.active ?? layoutState.workspace;
+  const companions = useCompanions(activeId);
+  const { companionId, variant } = useSelectedCompanion(companions, layoutState.companionVariant);
+
+  // Get node for the selected companion.
+  const node = useNode(graph, companionId);
+  const parentNode = useNode(graph, activeId);
+
+  // Build Surface data for the companion content.
+  const data = useMemo(() => {
+    return (
+      node && {
+        attendableId: companionId,
+        subject: node.data,
+        companionTo: parentNode?.data,
+        properties: node.properties,
+        variant,
+      }
+    );
+  }, [companionId, node, parentNode, variant]);
+
+  // Get drawer actions (tabs + toolbar buttons).
+  const { actions, onAction } = useDrawerActions(DRAWER_NAME);
+  const menu = useMenuActions(actions);
+
+  return (
+    <Layout.Main toolbar>
+      <MenuProvider {...menu} onAction={onAction} alwaysActive>
+        <ToolbarMenu density='coarse' />
+      </MenuProvider>
+      <Surface.Surface role='article' data={data} limit={1} fallback={ContentError} placeholder={placeholder} />
+    </Layout.Main>
+  );
+};
+
+Drawer.displayName = DRAWER_NAME;
+
+/** Parse entry ID to extract primary ID and variant. */
+const parseEntryId = (entryId: string) => {
+  const [id, variant] = entryId.split(ATTENDABLE_PATH_SEPARATOR);
+  return { id, variant };
+};
+
+/**
+ * Resolves which companion to show based on variant preference.
+ * Falls back to first available if preferred variant not available.
+ */
+const useSelectedCompanion = (companions: Node.Node[], preferredVariant?: string) => {
+  const selectedCompanion = useMemo(() => {
+    if (companions.length === 0) {
+      return undefined;
+    }
+
+    // Try to find companion matching the preferred variant.
+    if (preferredVariant) {
+      const preferred = companions.find((c) => {
+        const { variant } = parseEntryId(c.id);
+        return variant === preferredVariant;
+      });
+      if (preferred) {
+        return preferred;
+      }
+    }
+
+    // Fallback to first companion.
+    return companions[0];
+  }, [companions, preferredVariant]);
+
+  const companionId = selectedCompanion?.id;
+  const { variant } = parseEntryId(companionId ?? '');
+
+  return { selectedCompanion, companionId, variant };
+};

package/src/components/SimpleLayout/Main.tsx

@@ -2,80 +2,80 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { useCallback, useMemo } from 'react';
+import React, { useMemo } from 'react';
 
-import { Surface, useAppGraph } from '@dxos/app-framework/react';
-import { log } from '@dxos/log';
+import { Surface } from '@dxos/app-framework/ui';
+import { useAppGraph } from '@dxos/app-toolkit/ui';
 import { useNode } from '@dxos/plugin-graph';
-import { Main as NaturalMain } from '@dxos/react-ui';
-import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
-import { Mosaic } from '@dxos/react-ui-mosaic';
+import { useAttentionAttributes } from '@dxos/react-ui-attention';
 import { mx } from '@dxos/ui-theme';
 
-import { useSimpleLayoutState } from '../../hooks';
+import { useAppBarProps, useNavbarActions, useSimpleLayoutState } from '../../hooks';
 import { ContentError } from '../ContentError';
 import { ContentLoading } from '../ContentLoading';
+import { useLoadDescendents } from '../hooks';
+import { useMobileLayout } from '../MobileLayout/MobileLayout';
 
-import { Banner } from './Banner';
+import { AppBar } from './AppBar';
 import { NavBar } from './NavBar';
 
+const MAIN_NAME = 'SimpleLayout.Main';
+
 /**
- * Main root component.
+ * Main content component.
  */
 export const Main = () => {
   const { state } = useSimpleLayoutState();
   const id = state.active ?? state.workspace;
-  const showNavBar = !state.isPopover;
-  const { graph } = useAppGraph();
-  const node = useNode(graph, id);
+  const attentionAttrs = useAttentionAttributes(id);
+  const { keyboardOpen } = useMobileLayout(MAIN_NAME);
+  const { actions, onAction } = useNavbarActions();
+  const appBarProps = useAppBarProps();
 
   const placeholder = useMemo(() => <ContentLoading />, []);
 
+  const { graph } = useAppGraph();
+  const node = useNode(graph, id);
   const data = useMemo(() => {
-    const { variant } = parseEntryId(id);
     return (
       node && {
         attendableId: id,
         subject: node.data,
         properties: node.properties,
         popoverAnchorId: state.popoverAnchorId,
-        variant,
       }
     );
   }, [id, node, node?.data, node?.properties, state.popoverAnchorId]);
 
-  const handleActiveIdChange = useCallback((nextActiveId: string | null) => {
-    log.info('navigate', { nextActiveId });
-  }, []);
+  // Ensures that children are loaded so that they are available to navigate to.
+  useLoadDescendents(id);
+
+  // TODO(burdon): BUG: When showing ANY statusbar the size progressively shrinks when the keyboard opens/closes.
+  const showNavBar = !keyboardOpen && !state.isPopover && state.drawerState === 'closed';
 
   return (
-    <Mosaic.Root>
-      <NaturalMain.Root complementarySidebarState='closed' navigationSidebarState='closed'>
-        <NaturalMain.Content
-          bounce
-          classNames={mx(
-            'dx-mobile-main dx-mobile-main-scroll-area--flush',
-            'grid bs-full overflow-hidden',
-            showNavBar ? 'grid-rows-[min-content_1fr_min-content]' : 'grid-rows-[min-content_1fr]',
-          )}
-        >
-          <Banner classNames='border-be border-separator' node={node} />
-          <article className='contents'>
-            <Surface key={id} role='article' data={data} limit={1} fallback={ContentError} placeholder={placeholder} />
-          </article>
-          {showNavBar && (
-            <NavBar classNames='border-bs border-separator' activeId={id} onActiveIdChange={handleActiveIdChange} />
-          )}
-        </NaturalMain.Content>
-      </NaturalMain.Root>
-    </Mosaic.Root>
+    <div
+      role='none'
+      className={mx(
+        'bs-full grid overflow-hidden bg-toolbarSurface',
+        showNavBar ? 'grid-rows-[var(--rail-action)_1fr_var(--toolbar-size)]' : 'grid-rows-[var(--rail-action)_1fr]',
+      )}
+      {...attentionAttrs}
+    >
+      <AppBar {...appBarProps} />
+      <article className='bs-full overflow-hidden bg-baseSurface'>
+        <Surface.Surface
+          key={id}
+          role='article'
+          data={data}
+          limit={1}
+          fallback={ContentError}
+          placeholder={placeholder}
+        />
+      </article>
+      {showNavBar && <NavBar classNames='border-bs border-subduedSeparator' actions={actions} onAction={onAction} />}
+    </div>
   );
 };
 
-// TODO(wittjosiah): Factor out. Copied from deck plugin.
-const parseEntryId = (entryId: string) => {
-  const [id, variant] = entryId.split(ATTENDABLE_PATH_SEPARATOR);
-  return { id, variant };
-};
-
-Main.displayName = 'SimpleLayout.Main';
+Main.displayName = MAIN_NAME;

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

@@ -2,58 +2,163 @@
 // Copyright 2025 DXOS.org
 //
 
+import { Atom } from '@effect-atom/atom-react';
 import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+import { type Mock, expect, fn, screen, userEvent, within } from 'storybook/test';
 
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { corePlugins } from '@dxos/plugin-testing';
 import { withTheme } from '@dxos/react-ui/testing';
+import { type ActionGraphProps, createGapSeparator, createMenuAction, createMenuItemGroup } from '@dxos/react-ui-menu';
+import { withRegistry } from '@dxos/storybook-utils';
 
 import { translations } from '../../translations';
 
 import { NavBar } from './NavBar';
 
+const MAIN_MENU_GROUP_ID = 'navbar-main-menu';
+
+const buildEmptyActions = (): ActionGraphProps => ({ nodes: [], edges: [] });
+
+const buildCompanionOnlyActions = (): ActionGraphProps => {
+  const result: ActionGraphProps = { nodes: [], edges: [] };
+  const companions = [
+    createMenuAction('companion-browse', () => console.log('Browse'), {
+      icon: 'ph--house--regular',
+      label: 'Browse',
+      iconOnly: true,
+    }),
+    createMenuAction('companion-notifications', () => console.log('Notifications'), {
+      icon: 'ph--bell--regular',
+      label: 'Notifications',
+      iconOnly: true,
+    }),
+    createMenuAction('companion-profile', () => console.log('Profile'), {
+      icon: 'ph--user--regular',
+      label: 'Profile',
+      iconOnly: true,
+    }),
+  ];
+  result.nodes.push(...companions);
+  result.edges.push(...companions.map((c) => ({ source: 'root', target: c.id })));
+  return result;
+};
+
+const buildDefaultActions = (): ActionGraphProps => {
+  const result: ActionGraphProps = { nodes: [], edges: [] };
+  const gapSeparator = createGapSeparator('navbar-gap');
+  const mainMenuGroup = createMenuItemGroup(MAIN_MENU_GROUP_ID, {
+    variant: 'dropdownMenu',
+    icon: 'ph--plus--regular',
+    iconOnly: true,
+    label: 'Main menu',
+    testId: 'simpleLayoutPlugin.addSpace',
+  });
+  const companions = [
+    createMenuAction('companion-browse', () => console.log('Browse'), {
+      icon: 'ph--house--regular',
+      label: 'Browse',
+      iconOnly: true,
+    }),
+    createMenuAction('companion-notifications', () => console.log('Notifications'), {
+      icon: 'ph--bell--regular',
+      label: 'Notifications',
+      iconOnly: true,
+    }),
+  ];
+  const menuActions = [
+    createMenuAction('action-create-space', () => console.log('Create space'), {
+      icon: 'ph--planet--regular',
+      label: 'Create space',
+    }),
+    createMenuAction('action-join-space', () => console.log('Join space'), {
+      icon: 'ph--sign-in--regular',
+      label: 'Join space',
+    }),
+    createMenuAction('action-settings', () => console.log('Settings'), {
+      icon: 'ph--gear--regular',
+      label: 'Settings',
+    }),
+  ];
+  result.nodes.push(...companions, ...gapSeparator.nodes, mainMenuGroup, ...menuActions);
+  result.edges.push(
+    ...companions.map((c) => ({ source: 'root', target: c.id })),
+    ...gapSeparator.edges,
+    { source: 'root', target: mainMenuGroup.id },
+    ...menuActions.map((action) => ({ source: MAIN_MENU_GROUP_ID, target: action.id })),
+  );
+  return result;
+};
+
 const meta = {
   title: 'plugins/plugin-simple-layout/NavBar',
   component: NavBar,
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [...corePlugins()],
-    }),
-  ],
+  decorators: [withTheme(), withRegistry],
   parameters: {
     layout: 'fullscreen',
     translations,
   },
-  argTypes: {
-    onActiveIdChange: { action: 'activeIdChanged' },
-  },
 } satisfies Meta<typeof NavBar>;
 
 export default meta;
 
 type Story = StoryObj<typeof meta>;
 
+const DefaultStory = ({ onAction }: { onAction: (action: { id: string }) => void }) => {
+  const actions = useMemo(() => Atom.make(buildDefaultActions()).pipe(Atom.keepAlive), []);
+
+  return <NavBar classNames='border-bs border-separator' actions={actions} onAction={onAction} />;
+};
+
 export const Default: Story = {
+  tags: ['test'],
   args: {
-    activeId: undefined,
+    onAction: fn(),
+  } as any,
+  render: (args: any) => <DefaultStory onAction={args.onAction} />,
+  play: async ({ args, canvasElement }) => {
+    const canvas = within(canvasElement);
+
+    // Verify the navbar renders with the toolbar.
+    await expect(canvas.getByRole('toolbar')).toBeInTheDocument();
+
+    // Test companion action click (Browse button).
+    const browseButton = canvas.getByRole('button', { name: /browse/i });
+    await expect(browseButton).toBeInTheDocument();
+    await userEvent.click(browseButton);
+    await expect(args.onAction).toHaveBeenCalledTimes(1);
+    await expect((args.onAction as Mock).mock.calls[0][0]).toHaveProperty('id', 'companion-browse');
+
+    // Test dropdown menu opens and action fires.
+    const menuTrigger = canvas.getByRole('button', { name: /main menu/i });
+    await expect(menuTrigger).toBeInTheDocument();
+    await userEvent.click(menuTrigger);
+
+    // Wait for menu to open and click an action (menu items render in a portal).
+    const createSpaceAction = await screen.findByRole('menuitem', { name: /create space/i });
+    await userEvent.click(createSpaceAction);
+    await expect(args.onAction).toHaveBeenCalledTimes(2);
+    await expect((args.onAction as Mock).mock.calls[1][0]).toHaveProperty('id', 'action-create-space');
   },
 };
 
-export const BrowseActive: Story = {
-  args: {
-    activeId: 'some-document',
-  },
+const CompanionsOnlyStory = () => {
+  const actions = useMemo(() => Atom.make(buildCompanionOnlyActions()).pipe(Atom.keepAlive), []);
+
+  return <NavBar actions={actions} onAction={(action) => console.log('Action:', action.id)} />;
 };
 
-export const NotificationsActive: Story = {
-  args: {
-    activeId: 'notifications',
-  },
+export const CompanionsOnly: Story = {
+  args: {} as any,
+  render: () => <CompanionsOnlyStory />,
 };
 
-export const ProfileActive: Story = {
-  args: {
-    activeId: 'profile',
-  },
+const EmptyStory = () => {
+  const actions = useMemo(() => Atom.make(buildEmptyActions()).pipe(Atom.keepAlive), []);
+
+  return <NavBar actions={actions} onAction={(action) => console.log('Action:', action.id)} />;
+};
+
+export const Empty: Story = {
+  args: {} as any,
+  render: () => <EmptyStory />,
 };