@dxos/plugin-deck 0.8.4-main.d05673bc65 → 0.8.4-main.d9fc60f731

package/src/components/DeckLayout/Popover.tsx

@@ -1,142 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { createContext } from '@radix-ui/react-context';
-import React, { type PropsWithChildren, useCallback, useEffect, useRef, useState } from 'react';
-
-import { Surface, useOperationInvoker } from '@dxos/app-framework/ui';
-import { LayoutOperation } from '@dxos/app-toolkit';
-import { useObjectNavigate } from '@dxos/app-toolkit/ui';
-import { Popover, type PopoverContentInteractOutsideEvent, toLocalizedString, useTranslation } from '@dxos/react-ui';
-import { Card } from '@dxos/react-ui';
-
-import { useDeckState } from '../../hooks';
-import { meta } from '../../meta';
-
-export type DeckPopoverRootProps = PropsWithChildren<{}>;
-
-const DEBOUNCE_DELAY = 40;
-
-type DeckPopoverContextValue = {
-  setOpen: (open: boolean) => void;
-};
-
-const [DeckPopoverProvider, useDeckPopoverContext] = createContext<DeckPopoverContextValue>('DeckPopover');
-
-export const PopoverRoot = ({ children }: DeckPopoverRootProps) => {
-  const { state } = useDeckState();
-  const virtualRef = useRef<HTMLButtonElement | null>(null);
-  const [virtualIter, setVirtualIter] = useState(0);
-  const [open, setOpen] = useState(false);
-  const debounceRef = useRef<NodeJS.Timeout | null>(null);
-
-  // TODO(thure): This is a workaround for the race condition between displaying a Popover and either rendering
-  //  the anchor further down the tree or measuring the virtual trigger's client rect.
-  useEffect(() => {
-    setOpen(false);
-    if (state.popoverOpen) {
-      if (debounceRef.current) {
-        clearTimeout(debounceRef.current);
-      }
-      if (state.popoverAnchor && virtualRef.current !== state.popoverAnchor) {
-        virtualRef.current = state.popoverAnchor ?? null;
-        setVirtualIter((iter) => iter + 1);
-      }
-      debounceRef.current = setTimeout(() => setOpen(true), DEBOUNCE_DELAY);
-    }
-  }, [state.popoverOpen, state.popoverAnchorId, state.popoverAnchor, state.popoverContent]);
-
-  return (
-    <DeckPopoverProvider setOpen={setOpen}>
-      <Popover.Root modal={false} open={open}>
-        {state.popoverAnchor && <Popover.VirtualTrigger key={virtualIter} virtualRef={virtualRef} />}
-        {children}
-      </Popover.Root>
-    </DeckPopoverProvider>
-  );
-};
-
-// Extracts the subject from popover content if it has one, otherwise returns the content as-is.
-const getPopoverSubject = (content: unknown): unknown =>
-  content && typeof content === 'object' && 'subject' in content ? (content as { subject: unknown }).subject : content;
-
-export const PopoverContent = () => {
-  const { t } = useTranslation(meta.id);
-  const { state, updateEphemeral } = useDeckState();
-  const { setOpen } = useDeckPopoverContext('PopoverContent');
-  const { invokeSync } = useOperationInvoker();
-  const handleNavigate = useObjectNavigate(getPopoverSubject(state.popoverContent));
-
-  const handleClose = useCallback(() => {
-    setOpen(false);
-    updateEphemeral((state) => ({
-      ...state,
-      popoverOpen: false,
-      popoverAnchor: undefined,
-      popoverAnchorId: undefined,
-      popoverSide: undefined,
-    }));
-  }, [updateEphemeral]);
-
-  const handleInteractOutside = useCallback(
-    (event: KeyboardEvent | PopoverContentInteractOutsideEvent) => {
-      if (
-        // TODO(thure): CodeMirror should not focus itself when it updates.
-        event.type === 'dismissableLayer.focusOutside' &&
-        (event.currentTarget as HTMLElement | undefined)?.classList.contains('cm-content')
-      ) {
-        event.preventDefault();
-      } else {
-        handleClose();
-      }
-    },
-    [handleClose],
-  );
-
-  return (
-    <Popover.Portal>
-      <Popover.Content
-        side={state.popoverSide}
-        sticky='always'
-        hideWhenDetached
-        onInteractOutside={handleInteractOutside}
-        onEscapeKeyDown={handleInteractOutside}
-      >
-        <Popover.Viewport>
-          {/* TODO(burdon): Set/disable column context. */}
-          {state.popoverKind === 'base' && <Surface.Surface role='popover' data={state.popoverContent} limit={1} />}
-          {state.popoverKind === 'card' && (
-            <Card.Root border={false} classNames='dx-card-popover'>
-              <Card.Toolbar>
-                {/* TODO(wittjosiah): Cleaner way to handle no drag handle in toolbar? */}
-                {state.popoverContentRef ? (
-                  <Card.ToolbarIconButton
-                    icon='ph--arrow-square-out--regular'
-                    iconOnly
-                    label={t('open item label')}
-                    onClick={() => {
-                      invokeSync(LayoutOperation.Open, {
-                        subject: [state.popoverContentRef!],
-                      });
-                    }}
-                  />
-                ) : (
-                  <div />
-                )}
-                {state.popoverTitle ? (
-                  <Card.Title onClick={handleNavigate}>{toLocalizedString(state.popoverTitle, t)}</Card.Title>
-                ) : (
-                  <span />
-                )}
-                <Card.CloseIconButton onClick={handleClose} />
-              </Card.Toolbar>
-              <Surface.Surface role='card--content' data={state.popoverContent} limit={1} />
-            </Card.Root>
-          )}
-        </Popover.Viewport>
-        <Popover.Arrow />
-      </Popover.Content>
-    </Popover.Portal>
-  );
-};

package/src/components/DeckLayout/Topbar.tsx

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

package/src/components/Plank/Plank.stories.tsx

@@ -1,64 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { Capability, Plugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { AppActivationEvents } from '@dxos/app-toolkit';
-import { corePlugins } from '@dxos/plugin-testing';
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
-import { Stack } from '@dxos/react-ui-stack';
-
-import { DeckState } from '../../capabilities';
-import { meta as pluginMeta } from '../../meta';
-import { translations } from '../../translations';
-
-import { Plank } from './Plank';
-
-const TestPlugin = Plugin.define(pluginMeta).pipe(
-  Plugin.addModule({
-    id: Capability.getModuleTag(DeckState),
-    activatesOn: AppActivationEvents.AppGraphReady,
-    activate: () => DeckState(),
-  }),
-  Plugin.make,
-);
-
-const meta = {
-  title: 'plugins/plugin-deck/components/Plank',
-  component: Plank,
-  render: (args) => {
-    return (
-      <Stack orientation='horizontal'>
-        <Plank {...args} />
-      </Stack>
-    );
-  },
-  decorators: [
-    withTheme(),
-    withLayout({ layout: 'fullscreen' }),
-    withPluginManager({
-      plugins: [...corePlugins(), TestPlugin()],
-    }),
-  ],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof Plank>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-// TODO(burdon): Need to define surface provider?
-export const Default: Story = {
-  args: {
-    id: 'plank-1',
-    part: 'solo',
-    layoutMode: 'deck',
-  },
-};

package/src/components/Plank/Plank.tsx

@@ -1,307 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { useFocusFinders } from '@fluentui/react-tabster';
-import React, {
-  type KeyboardEvent,
-  type PropsWithChildren,
-  memo,
-  useCallback,
-  useLayoutEffect,
-  useMemo,
-  useRef,
-} from 'react';
-
-import { Surface, useOperationInvoker } from '@dxos/app-framework/ui';
-import { LayoutOperation, getCompanionVariant } from '@dxos/app-toolkit';
-import { useAppGraph } from '@dxos/app-toolkit/ui';
-import { debounce } from '@dxos/async';
-import { type Node, useNode } from '@dxos/plugin-graph';
-import { useAttentionAttributes } from '@dxos/react-ui-attention';
-import { StackItem, railGridHorizontal } from '@dxos/react-ui-stack';
-import { mainIntrinsicSize, mx } from '@dxos/ui-theme';
-
-import { useCompanions, useDeckState, useMainSize, useSelectedCompanion } from '../../hooks';
-import {
-  DeckOperation,
-  type DeckSettingsProps,
-  type LayoutMode,
-  PLANK_COMPANION_TYPE,
-  type ResolvedPart,
-} from '../../types';
-
-import { PlankError, PlankErrorFallback } from './PlankError';
-import { PlankHeading } from './PlankHeading';
-import { PlankLoading } from './PlankLoading';
-
-const UNKNOWN_ID = 'unknown_id';
-
-//
-// Plank
-//
-
-export type PlankProps = Pick<PlankComponentProps, 'layoutMode' | 'part' | 'path' | 'order' | 'active' | 'settings'> & {
-  id?: string;
-  companionVariant?: string;
-};
-
-// TODO(burdon): Factor out conditional rendering.
-//   Remove this wrapper component and render the entire set of planks in the deck with conditional visibility
-//   to obviate mounting and unmounting when switching between solo and companion mode?
-// NOTE(thure, in reply): Whether any surface should be rendered and hidden is a performance matter — remember that
-//  article surfaces contain full experiences, so being able to unmount them will yield relatively large performance
-//  benefits. I think where we anticipate users will definitely want to quickly switch between showing and hiding entire
-//  articles, over the (again probably large) performance benefit that unmounting them would confer, we can mount and
-//  hide them, but I think that scenario in its most unambiguous form is probably rare. You could extrapolate
-//  the scenario to include all "potential" planks such as companions, which we could keep mounted and hidden, but I
-//  don't think the resulting performance would be acceptable. I think the real issue is "perceived performance" which
-//  has mitigations that are in between mounting and un-mounting since both of those have tradeoffs; we may need one or more
-//  "partially-mounted" experiences, like loading skeletons at the simple end, or screenshots of "sleeping" planks at
-//  the advanced end.
-
-/**
- * A Plank is the main container for surfaces within a Deck.
- * It may be paired with a companion plank that enables the user to select one of multiple companion surfaces.
- */
-export const Plank = memo(({ id = UNKNOWN_ID, companionVariant, ...props }: PlankProps) => {
-  const { graph } = useAppGraph();
-  const node = useNode(graph, id);
-  const companions = useCompanions(id);
-  const { companionId } = useSelectedCompanion(companions, companionVariant);
-  const resolvedCompanionId = companionVariant ? companionId : undefined;
-  const currentCompanion = companions.find(({ id }) => id === resolvedCompanionId);
-  const hasCompanion = !!(resolvedCompanionId && currentCompanion);
-
-  return (
-    <PlankContainer
-      solo={props.part === 'solo'}
-      companion={hasCompanion}
-      encapsulate={!!props.settings?.encapsulatedPlanks}
-    >
-      <PlankComponent
-        id={id}
-        node={node}
-        companioned={hasCompanion ? 'primary' : undefined}
-        companions={hasCompanion ? [] : companions}
-        {...props}
-        {...(props.part === 'solo' ? { part: 'solo-primary' } : {})}
-      />
-      {hasCompanion && (
-        <PlankComponent
-          id={resolvedCompanionId}
-          node={currentCompanion}
-          primary={node}
-          companions={companions}
-          companioned='companion'
-          {...props}
-          {...(props.part === 'solo' ? { part: 'solo-companion' } : { order: (props.order ?? 0) + 1 })}
-        />
-      )}
-    </PlankContainer>
-  );
-});
-
-//
-// PlankContainer
-//
-
-type PlankContainerProps = PropsWithChildren<{ solo: boolean; companion: boolean; encapsulate: boolean }>;
-
-const PlankContainer = ({ children, solo, companion, encapsulate }: PlankContainerProps) => {
-  const sizeAttrs = useMainSize();
-  if (!solo) {
-    return children;
-  }
-
-  // TODO(burdon): Make resizable.
-  return (
-    <div
-      role='none'
-      data-popover-collision-boundary={true}
-      className={mx(
-        'absolute inset-(--main-spacing) grid',
-        encapsulate && 'border border-separator rounded-sm overflow-hidden',
-        companion && 'grid-cols-[6fr_4fr]', // TODO(burdon): Resize.
-        railGridHorizontal,
-        mainIntrinsicSize,
-      )}
-      {...sizeAttrs}
-    >
-      {children}
-    </div>
-  );
-};
-
-//
-// PlankComponent
-//
-
-type PlankComponentProps = {
-  layoutMode: LayoutMode;
-  id: string;
-  part: ResolvedPart;
-  path?: string[];
-  order?: number;
-  active?: string[];
-  companioned?: 'primary' | 'companion';
-  node?: Node.Node;
-  primary?: Node.Node;
-  companions?: Node.Node[];
-  settings?: DeckSettingsProps;
-};
-
-const PlankComponent = memo(
-  ({
-    layoutMode,
-    id,
-    part,
-    path,
-    order,
-    active,
-    companioned,
-    node,
-    primary,
-    companions,
-    settings,
-  }: PlankComponentProps) => {
-    const { invokePromise } = useOperationInvoker();
-    const { state, deck } = useDeckState();
-    const { popoverAnchorId, scrollIntoView } = state;
-    const { findFirstFocusable } = useFocusFinders();
-    const canResize = layoutMode === 'deck';
-
-    const attentionAttrs = useAttentionAttributes(primary?.id ?? 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 rootElement = useRef<HTMLDivElement | null>(null);
-
-    const variant = node?.type === PLANK_COMPANION_TYPE ? getCompanionVariant(id) : undefined;
-    const sizeKey = id.split('+')[0];
-    const size = deck.plankSizing[sizeKey] as number | undefined;
-
-    const handleSizeChange = useCallback(
-      debounce((nextSize: number) => {
-        return invokePromise(DeckOperation.UpdatePlankSize, { id: sizeKey, size: nextSize });
-      }, 200),
-      [invokePromise, sizeKey],
-    );
-
-    // 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) {
-        switch (event.key) {
-          case 'Escape':
-            rootElement.current?.closest('main')?.focus();
-            break;
-          case 'Enter':
-            rootElement.current && findFirstFocusable(rootElement.current)?.focus();
-            break;
-        }
-      }
-    }, []);
-
-    useLayoutEffect(() => {
-      if (scrollIntoView === id) {
-        layoutMode === 'deck' && rootElement.current?.scrollIntoView({ behavior: 'smooth', inline: 'center' });
-        // Clear the scroll into view state once it has been actioned.
-        void invokePromise(LayoutOperation.ScrollIntoView, { subject: undefined });
-      }
-    }, [id, scrollIntoView, layoutMode, invokePromise]);
-
-    const isSolo = layoutMode.startsWith('solo') && part === 'solo';
-    const isAttendable =
-      (layoutMode.startsWith('solo') && part.startsWith('solo')) || (layoutMode === 'deck' && part === 'deck');
-
-    const sizeAttrs = useMainSize();
-
-    const data = useMemo(
-      () =>
-        node && {
-          attendableId: id,
-          subject: node.data,
-          companionTo: primary?.data,
-          properties: node.properties,
-          variant,
-          path,
-          popoverAnchorId,
-        },
-      [node, node?.data, node?.properties, path, popoverAnchorId, primary?.data, variant],
-    );
-
-    // TODO(wittjosiah): Change prop to accept a component.
-    const placeholder = useMemo(() => <PlankLoading />, []);
-
-    const Root = part.startsWith('solo') ? 'article' : StackItem.Root;
-    const fullscreen = layoutMode === 'solo--fullscreen';
-    const className = mx(
-      'dx-attention-surface relative dx-focus-ring-inset-over-all dx-density-coarse',
-      isSolo && 'absolute inset-0',
-      isSolo && mainIntrinsicSize,
-      railGridHorizontal,
-      part.startsWith('solo') && 'grid',
-      part.startsWith('solo-') && 'grid-rows-subgrid row-span-2 min-w-0',
-      fullscreen && 'grid-rows-1',
-      part === 'deck' && (companioned === 'companion' ? 'border-separator! border-e' : 'border-separator! border-x'),
-      part === 'solo-companion' && 'border-separator! border-s',
-      settings?.encapsulatedPlanks &&
-        !part.startsWith('solo') &&
-        'mx-(--main-spacing) border-separator! border rounded-sm overflow-hidden',
-    );
-
-    return (
-      <Root
-        ref={rootElement}
-        data-testid='deck.plank'
-        data-popover-collision-boundary={true}
-        tabIndex={0}
-        {...(part.startsWith('solo')
-          ? ({ ...sizeAttrs, className } as any)
-          : {
-              item: { id },
-              size,
-              onSizeChange: handleSizeChange,
-              classNames: className,
-              order,
-              role: 'article',
-            })}
-        {...(isAttendable ? attentionAttrs : {})}
-        onKeyDown={handleKeyDown}
-      >
-        {node ? (
-          <>
-            {!fullscreen && (
-              <PlankHeading
-                id={id}
-                part={part.startsWith('solo-') ? 'solo' : part}
-                node={node}
-                layoutMode={layoutMode}
-                deckEnabled={settings?.enableDeck}
-                canIncrementStart={canIncrementStart}
-                canIncrementEnd={canIncrementEnd}
-                popoverAnchorId={popoverAnchorId}
-                primaryId={primary?.id}
-                companioned={companioned}
-                companions={companions}
-              />
-            )}
-            <Surface.Surface
-              key={node.id}
-              role='article'
-              data={data}
-              limit={1}
-              fallback={PlankErrorFallback}
-              placeholder={placeholder}
-            />
-          </>
-        ) : (
-          <PlankError id={id} part={part} />
-        )}
-        {canResize && <StackItem.ResizeHandle />}
-      </Root>
-    );
-  },
-);