@dxos/plugin-simple-layout 0.8.4-main.9735255 → 0.8.4-main.abd8ff62ef

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 { type ActionGraphProps, createMenuAction } from '@dxos/react-ui-menu';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+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.menu', () => console.log('Edit'), {
+      icon: 'ph--pencil--regular',
+      label: 'Edit',
+    }),
+    createMenuAction('action-share.menu', () => console.log('Share'), {
+      icon: 'ph--share--regular',
+      label: 'Share',
+    }),
+    createMenuAction('action-delete.menu', () => console.log('Delete'), {
+      icon: 'ph--trash--regular',
+      label: 'Delete',
+    }),
+  ];
+  result.nodes.push(...actions);
+  result.edges.push(...actions.map((a) => ({ source: 'root', target: a.id, relation: 'child' })));
+  return result;
+};
+
+type DefaultStoryProps = Omit<AppBarProps, 'actions'> & {
+  actions: ActionGraphProps;
+};
+
+const DefaultStory = ({ actions: actionsProp, ...props }: DefaultStoryProps) => {
+  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/components/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<DefaultStoryProps>;
+
+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.menu');
+  },
+};
+
+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,94 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom, useAtomValue } from '@effect-atom/atom-react';
+import React, { Fragment } from 'react';
+
+import { IconButton, Popover, Toolbar, useTranslation } from '@dxos/react-ui';
+import { type ActionExecutor, type ActionGraphProps, Menu, useMenuActions } from '@dxos/react-ui-menu';
+import { composable, composableProps, osTranslations } from '@dxos/ui-theme';
+
+import { meta } from '#meta';
+
+import { useMobileLayout } from '../MobileLayout';
+
+const APP_BAR_NAME = 'SimpleLayout.AppBar';
+
+export type AppBarProps = {
+  /** 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 = composable<HTMLDivElement, AppBarProps>(
+  ({ classNames, title, actions, showBackButton, popoverAnchorId, onAction, onBack, ...props }, forwardedRef) => {
+    const { t } = useTranslation(meta.id);
+    const menuActions = 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
+        {...composableProps(props, {
+          role: 'banner',
+          classNames: 'grid grid-cols-[var(--dx-rail-size)_1fr_var(--dx-rail-size)] items-center dx-density-fine',
+        })}
+        ref={forwardedRef}
+      >
+        {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>
+            <Menu.Root {...menuActions} caller={meta.id} onAction={onAction}>
+              <Menu.Trigger asChild>
+                <IconButton
+                  variant='ghost'
+                  icon='ph--dots-three-vertical--regular'
+                  iconOnly
+                  label={t('actions-menu.label')}
+                />
+              </Menu.Trigger>
+              <Menu.Content />
+            </Menu.Root>
+          </AnchorRoot>
+        ) : (
+          <span />
+        )}
+      </Toolbar.Root>
+    );
+  },
+);
+
+AppBar.displayName = APP_BAR_NAME;

package/src/components/SimpleLayout/Drawer.tsx

@@ -2,17 +2,18 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { useCallback, useMemo } from 'react';
+import React, { useMemo } from 'react';
 
-import { Surface, useAppGraph } from '@dxos/app-framework/react';
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface, useAppGraph } from '@dxos/app-toolkit/ui';
 import { type Node, useNode } from '@dxos/plugin-graph';
-import { IconButton, Main as NaturalMain, Toolbar, toLocalizedString, useTranslation } from '@dxos/react-ui';
-import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
+import { ErrorFallback, Panel } from '@dxos/react-ui';
+import { getLinkedVariant } from '@dxos/react-ui-attention';
+import { Menu, useMenuActions } from '@dxos/react-ui-menu';
 
-import { useCompanions, useSimpleLayoutState } from '../../hooks';
-import { meta } from '../../meta';
-import { ContentError } from '../ContentError';
-import { ContentLoading } from '../ContentLoading';
+import { useCompanions, useDrawerActions, useSimpleLayoutState } from '#hooks';
+
+import { Loading } from '../Loading';
 
 const DRAWER_NAME = 'SimpleLayout.Drawer';
 
@@ -20,105 +21,60 @@ const DRAWER_NAME = 'SimpleLayout.Drawer';
  * Companion drawer component.
  */
 export const Drawer = () => {
-  const { t } = useTranslation(meta.id);
-  const { state, updateState } = useSimpleLayoutState();
   const { graph } = useAppGraph();
+  const { state: layoutState } = useSimpleLayoutState();
 
-  const placeholder = useMemo(() => <ContentLoading />, []);
+  const placeholder = useMemo(() => <Loading />, []);
 
   // Get all companions for the current active (primary) item.
-  const activeId = state.active ?? state.workspace;
+  const activeId = layoutState.active ?? layoutState.workspace;
   const companions = useCompanions(activeId);
-  const { companionId, variant } = useSelectedCompanion(companions, state.companionVariant);
+  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,
-      }
-    );
+  const data = useMemo<AppSurface.ArticleData | undefined>(() => {
+    if (!node || !companionId) {
+      return undefined;
+    }
+    return {
+      attendableId: companionId,
+      subject: node.data,
+      companionTo: parentNode?.data,
+      properties: node.properties,
+      variant,
+    };
   }, [companionId, node, parentNode, variant]);
 
-  // Handle tab click to switch companions.
-  const handleTabClick = useCallback(
-    (companion: Node.Node) => {
-      const [, companionVariant] = companion.id.split(ATTENDABLE_PATH_SEPARATOR);
-      updateState((s) => ({ ...s, companionVariant }));
-    },
-    [updateState],
-  );
-
-  // Handle expand/collapse toggle.
-  const handleToggleExpand = useCallback(() => {
-    updateState((s) => ({
-      ...s,
-      drawerState: s.drawerState === 'full' ? 'expanded' : 'full',
-    }));
-  }, [updateState]);
-
-  // Handle close.
-  const handleClose = useCallback(() => {
-    updateState((s) => ({ ...s, drawerState: 'closed' }));
-  }, [updateState]);
-
-  const drawerState = state.drawerState ?? 'closed';
-  if (drawerState === 'closed') {
-    return null;
-  }
-
-  const isFullyExpanded = drawerState === 'full';
+  // Get drawer actions (tabs + toolbar buttons).
+  const { actions, onAction } = useDrawerActions(DRAWER_NAME);
+  const menuActions = useMenuActions(actions);
 
   return (
-    <NaturalMain.Drawer label={t('drawer label')}>
-      <Toolbar.Root>
-        {/* TODO(thure): IMPORTANT: This is a tablist; it should be implemented as such. */}
-        <div role='tablist' className='flex-1 min-is-0 overflow-x-auto scrollbar-none flex gap-1'>
-          {/* TODO(burdon): Factor out in common with NavBar. */}
-          {companions.map((companion) => (
-            <IconButton
-              key={companion.id}
-              role='tab'
-              aria-selected={companionId === companion.id}
-              icon={companion.properties.icon}
-              iconOnly
-              label={toLocalizedString(companion.properties.label, t)}
-              variant={companionId === companion.id ? 'primary' : 'ghost'}
-              onClick={() => handleTabClick(companion)}
-            />
-          ))}
-        </div>
-        <Toolbar.Separator variant='gap' />
-        <Toolbar.IconButton
-          icon={isFullyExpanded ? 'ph--arrow-down--regular' : 'ph--arrow-up--regular'}
-          iconOnly
-          label={isFullyExpanded ? t('collapse drawer label') : t('expand drawer label')}
-          onClick={handleToggleExpand}
+    <Panel.Root>
+      <Panel.Toolbar>
+        <Menu.Root {...menuActions} alwaysActive onAction={onAction}>
+          <Menu.Toolbar />
+        </Menu.Root>
+      </Panel.Toolbar>
+      <Panel.Content>
+        <Surface.Surface
+          type={AppSurface.Article}
+          data={data}
+          limit={1}
+          fallback={ErrorFallback}
+          placeholder={placeholder}
         />
-        <Toolbar.IconButton icon='ph--x--regular' iconOnly label={t('close drawer label')} onClick={handleClose} />
-      </Toolbar.Root>
-      {/* TODO(burdon): Fix containment. */}
-      <Surface role='article' data={data} limit={1} fallback={ContentError} placeholder={placeholder} />
-    </NaturalMain.Drawer>
+      </Panel.Content>
+    </Panel.Root>
   );
 };
 
 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.
@@ -131,10 +87,7 @@ const useSelectedCompanion = (companions: Node.Node[], preferredVariant?: string
 
     // Try to find companion matching the preferred variant.
     if (preferredVariant) {
-      const preferred = companions.find((c) => {
-        const { variant } = parseEntryId(c.id);
-        return variant === preferredVariant;
-      });
+      const preferred = companions.find((c) => getLinkedVariant(c.id) === preferredVariant);
       if (preferred) {
         return preferred;
       }
@@ -145,7 +98,7 @@ const useSelectedCompanion = (companions: Node.Node[], preferredVariant?: string
   }, [companions, preferredVariant]);
 
   const companionId = selectedCompanion?.id;
-  const { variant } = parseEntryId(companionId ?? '');
+  const variant = companionId ? getLinkedVariant(companionId) : undefined;
 
   return { selectedCompanion, companionId, variant };
 };

package/src/components/SimpleLayout/Main.tsx

@@ -4,17 +4,18 @@
 
 import React, { useMemo } from 'react';
 
-import { Surface, useAppGraph } from '@dxos/app-framework/react';
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface, useAppGraph } from '@dxos/app-toolkit/ui';
 import { useNode } from '@dxos/plugin-graph';
-import { Main as NaturalMain, useSidebars } from '@dxos/react-ui';
-import { mx } from '@dxos/ui-theme';
+import { ErrorFallback, Panel } from '@dxos/react-ui';
+import { useAttentionAttributes } from '@dxos/react-ui-attention';
 
-import { useSimpleLayoutState } from '../../hooks';
-import { ContentError } from '../ContentError';
-import { ContentLoading } from '../ContentLoading';
-import { useLoadDescendents } from '../hooks';
+import { useAppBarProps, useNavbarActions, useSimpleLayoutState } from '#hooks';
 
-import { Banner } from './Banner';
+import { useExpandPath } from '../hooks';
+import { Loading } from '../Loading';
+import { useMobileLayout } from '../MobileLayout';
+import { AppBar } from './AppBar';
 import { NavBar } from './NavBar';
 
 const MAIN_NAME = 'SimpleLayout.Main';
@@ -24,15 +25,16 @@ const MAIN_NAME = 'SimpleLayout.Main';
  */
 export const Main = () => {
   const { state } = useSimpleLayoutState();
-  const { graph } = useAppGraph();
   const id = state.active ?? state.workspace;
-  const node = useNode(graph, id);
-
-  // Ensures that children are loaded so that they are available to navigate to.
-  useLoadDescendents(id);
+  const attentionAttrs = useAttentionAttributes(id);
+  const { keyboardOpen } = useMobileLayout(MAIN_NAME);
+  const { actions, onAction } = useNavbarActions();
+  const appBarProps = useAppBarProps();
 
-  const placeholder = useMemo(() => <ContentLoading />, []);
+  const placeholder = useMemo(() => <Loading />, []);
 
+  const { graph } = useAppGraph();
+  const node = useNode(graph, id);
   const data = useMemo(() => {
     return (
       node && {
@@ -44,28 +46,32 @@ export const Main = () => {
     );
   }, [id, node, node?.data, node?.properties, state.popoverAnchorId]);
 
-  const { drawerState } = useSidebars(MAIN_NAME);
-  const showNavBar = !state.isPopover && drawerState === 'closed';
+  useExpandPath(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 (
-    <NaturalMain.Content
-      bounce
-      classNames={mx('bs-full', 'pbs-[env(safe-area-inset-top)] pbe-[env(safe-area-inset-bottom)]')}
-    >
-      <div
-        role='none'
-        className={mx(
-          '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='bs-full overflow-hidden'>
-          <Surface key={id} role='article' data={data} limit={1} fallback={ContentError} placeholder={placeholder} />
-        </article>
-        {showNavBar && <NavBar classNames='border-bs border-separator' activeId={id} />}
-      </div>
-    </NaturalMain.Content>
+    <Panel.Root {...attentionAttrs} className='dx-document'>
+      <Panel.Toolbar asChild>
+        <AppBar {...appBarProps} />
+      </Panel.Toolbar>
+      <Panel.Content role='article' className='bg-base-surface'>
+        <Surface.Surface
+          key={id}
+          type={AppSurface.Article}
+          data={data}
+          limit={1}
+          fallback={ErrorFallback}
+          placeholder={placeholder}
+        />
+      </Panel.Content>
+      {showNavBar && (
+        <Panel.Statusbar asChild>
+          <NavBar actions={actions} onAction={onAction} />
+        </Panel.Statusbar>
+      )}
+    </Panel.Root>
   );
 };