@dxos/plugin-deck 0.8.4-main.70d3990 → 0.8.4-main.74a063c4e0

package/src/components/DeckLayout/ContentEmpty.tsx

@@ -1,31 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { Surface, useCapability } from '@dxos/app-framework/react';
-
-import { DeckCapabilities } from '../../capabilities';
-import { useBreakpoints } from '../../hooks';
-import { getMode } from '../../types';
-import { layoutAppliesTopbar } from '../../util';
-import { fixedSidebarToggleStyles } from '../fragments';
-import { ToggleSidebarButton } from '../Sidebar';
-
-export const ContentEmpty = () => {
-  const breakpoint = useBreakpoints();
-  const { deck } = useCapability(DeckCapabilities.MutableDeckState);
-  const layoutMode = getMode(deck);
-  const topbar = layoutAppliesTopbar(breakpoint, layoutMode);
-  return (
-    <div
-      role='none'
-      className='grid place-items-center p-8 relative bg-deckSurface'
-      data-testid='layoutPlugin.firstRunMessage'
-    >
-      <Surface role='keyshortcuts' />
-      {!topbar && <ToggleSidebarButton variant='default' classNames={fixedSidebarToggleStyles} />}
-    </div>
-  );
-};

package/src/components/DeckLayout/DeckLayout.stories.tsx

@@ -1,63 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { Events, IntentPlugin, SettingsPlugin, defineModule, definePlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { AttentionPlugin } from '@dxos/plugin-attention';
-import { GraphPlugin } from '@dxos/plugin-graph';
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { DeckStateFactory, LayoutIntentResolver } from '../../capabilities';
-import { meta as pluginMeta } from '../../meta';
-import { translations } from '../../translations';
-
-import { DeckLayout } from './DeckLayout';
-
-const meta = {
-  title: 'plugins/plugin-deck/DeckLayout',
-  component: DeckLayout,
-  render: (args) => <DeckLayout {...args} />,
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [
-        AttentionPlugin(),
-        SettingsPlugin(),
-        IntentPlugin(),
-        GraphPlugin(),
-        definePlugin(
-          {
-            id: 'example.com/plutin/testing',
-            name: 'Testing',
-          },
-          () => [
-            defineModule({
-              id: `${pluginMeta.id}/module/deck-state`,
-              activatesOn: Events.AppGraphReady,
-              activate: () => DeckStateFactory(),
-            }),
-            defineModule({
-              id: `${pluginMeta.id}/module/layout-intent-resolver`,
-              activatesOn: Events.SetupIntentResolver,
-              activate: LayoutIntentResolver,
-            }),
-          ],
-        )(),
-      ],
-    }),
-  ],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof DeckLayout>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {};

package/src/components/DeckLayout/DeckLayout.tsx

@@ -1,32 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useCapability } from '@dxos/app-framework/react';
-
-import { DeckCapabilities } from '../../capabilities';
-
-import { ActiveNode } from './ActiveNode';
-import { DeckMain } from './DeckMain';
-import { Dialog } from './Dialog';
-import { PopoverContent, PopoverRoot } from './Popover';
-import { Toaster, type ToasterProps } from './Toast';
-
-export type DeckLayoutProps = Pick<ToasterProps, 'onDismissToast'>;
-
-export const DeckLayout = ({ onDismissToast }: DeckLayoutProps) => {
-  const context = useCapability(DeckCapabilities.MutableDeckState);
-  const { toasts } = context;
-
-  return (
-    <PopoverRoot>
-      <ActiveNode />
-      <DeckMain />
-      <PopoverContent />
-      <Dialog />
-      <Toaster toasts={toasts} onDismissToast={onDismissToast} />
-    </PopoverRoot>
-  );
-};

package/src/components/DeckLayout/DeckMain.tsx

@@ -1,281 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { untracked } from '@preact/signals-core';
-import React, { Fragment, type UIEvent, useCallback, useEffect, useMemo, useRef } from 'react';
-
-import { Capabilities, LayoutAction, createIntent } from '@dxos/app-framework';
-import { useCapability, useIntentDispatcher, usePluginManager } from '@dxos/app-framework/react';
-import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { Main, type MainProps, useMediaQuery, useOnTransition } from '@dxos/react-ui';
-import { DEFAULT_HORIZONTAL_SIZE, Stack, StackContext } from '@dxos/react-ui-stack';
-import { mainPaddingTransitions, mx } from '@dxos/react-ui-theme';
-
-import { DeckCapabilities } from '../../capabilities';
-import { useBreakpoints, useHoistStatusbar } from '../../hooks';
-import { meta } from '../../meta';
-import { type DeckSettingsProps, getMode } from '../../types';
-import { calculateOverscroll, layoutAppliesTopbar } from '../../util';
-import { fixedComplementarySidebarToggleStyles, fixedSidebarToggleStyles } from '../fragments';
-import { Plank } from '../Plank';
-import { ComplementarySidebar, Sidebar, ToggleComplementarySidebarButton, ToggleSidebarButton } from '../Sidebar';
-
-import { ContentEmpty } from './ContentEmpty';
-import { StatusBar } from './StatusBar';
-import { Topbar } from './Topbar';
-
-export const DeckMain = () => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const settings = useCapability(Capabilities.SettingsStore).getStore<DeckSettingsProps>(meta.id)?.value;
-  const context = useCapability(DeckCapabilities.MutableDeckState);
-  const { sidebarState, complementarySidebarState, complementarySidebarPanel, deck } = context;
-  const { active, activeCompanions, fullscreen, solo, plankSizing } = deck;
-  const layoutMode = getMode(deck);
-  const breakpoint = useBreakpoints();
-  const topbar = layoutAppliesTopbar(breakpoint, layoutMode);
-  const hoistStatusbar = useHoistStatusbar(breakpoint, layoutMode);
-  const pluginManager = usePluginManager();
-
-  const scrollLeftRef = useRef<number>(null);
-  const deckRef = useRef<HTMLDivElement>(null);
-
-  // Ensure the first plank is attended when the deck is first rendered.
-  useEffect(() => {
-    // NOTE: Not `useAttended` so that the layout component is not re-rendered when the attended list changes.
-    const attended = untracked(() => {
-      const attention = pluginManager.context.getCapability(AttentionCapabilities.Attention);
-      return attention.current;
-    });
-    const firstId = solo ?? active[0];
-    if (attended.length === 0 && firstId) {
-      // TODO(wittjosiah): Focusing the type button is a workaround.
-      //   If the plank is directly focused on first load the focus ring appears.
-      document.querySelector<HTMLElement>(`article[data-attendable-id="${firstId}"] button`)?.focus();
-    }
-  }, []);
-
-  // Not using `breakpoint` to avoid firing when breakpoint changes between tablet and desktop.
-  // `ssr: false` to avoid using fallback values and flashing into solo mode on startup.
-  const [isNotMobile] = useMediaQuery('md');
-  const shouldRevert = useRef(false);
-  useEffect(() => {
-    if (!isNotMobile && getMode(deck) === 'deck') {
-      // NOTE: Not `useAttended` so that the layout component is not re-rendered when the attended list changes.
-      const attended = untracked(() => {
-        const attention = pluginManager.context.getCapability(AttentionCapabilities.Attention);
-        return attention.current;
-      });
-
-      shouldRevert.current = true;
-      void dispatch(
-        createIntent(LayoutAction.SetLayoutMode, { part: 'mode', subject: attended[0], options: { mode: 'solo' } }),
-      );
-    } else if (isNotMobile && getMode(deck) === 'solo' && shouldRevert.current) {
-      void dispatch(createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { revert: true } }));
-    }
-  }, [isNotMobile, deck, dispatch]);
-
-  // When deck is disabled in settings, set to solo mode if the current layout mode is deck.
-  // TODO(thure): Applying this as an effect should be avoided over emitting the intent only when the setting changes.
-  useEffect(() => {
-    if (!settings?.enableDeck && layoutMode === 'deck') {
-      void dispatch(
-        createIntent(LayoutAction.SetLayoutMode, { part: 'mode', subject: active[0], options: { mode: 'solo' } }),
-      );
-    }
-  }, [settings?.enableDeck, dispatch, active, layoutMode]);
-
-  /**
-   * Clear scroll restoration state if the window is resized.
-   */
-  const handleResize = useCallback(() => {
-    scrollLeftRef.current = null;
-  }, []);
-
-  useEffect(() => {
-    window.addEventListener('resize', handleResize);
-    return () => window.removeEventListener('resize', handleResize);
-  }, [handleResize]);
-
-  const restoreScroll = useCallback(() => {
-    if (deckRef.current && scrollLeftRef.current != null) {
-      deckRef.current.scrollLeft = scrollLeftRef.current;
-    }
-  }, []);
-  useOnTransition(layoutMode, (mode) => mode !== 'deck', 'deck', restoreScroll);
-
-  /**
-   * Save scroll position as the user scrolls.
-   */
-  const handleScroll = useCallback(
-    (event: UIEvent) => {
-      if (!solo && event.currentTarget === event.target) {
-        scrollLeftRef.current = (event.target as HTMLDivElement).scrollLeft;
-      }
-    },
-    [solo],
-  );
-
-  const isEmpty = !solo && active.length === 0;
-
-  const padding = useMemo(() => {
-    if (!solo && settings?.overscroll === 'centering') {
-      return calculateOverscroll(active.length);
-    }
-    return {};
-  }, [solo, settings?.overscroll, deck]);
-
-  const mainPosition = useMemo(
-    () => [
-      'grid !block-start-[env(safe-area-inset-top)]',
-      topbar && '!block-start-[calc(env(safe-area-inset-top)+var(--rail-size))]',
-      hoistStatusbar && 'lg:block-end-[--statusbar-size]',
-    ],
-    [topbar, hoistStatusbar],
-  );
-
-  const { order, itemsCount }: { order: Record<string, number>; itemsCount: number } = useMemo(() => {
-    return active.reduce(
-      (acc: { order: Record<string, number>; itemsCount: number }, entryId) => {
-        acc.order[entryId] = acc.itemsCount + 1;
-        acc.itemsCount += activeCompanions?.[entryId] ? 3 : 2;
-        return acc;
-      },
-      { order: {}, itemsCount: 0 },
-    );
-  }, [active, activeCompanions]);
-
-  return (
-    <Main.Root
-      navigationSidebarState={fullscreen ? 'closed' : context.sidebarState}
-      complementarySidebarState={fullscreen ? 'closed' : context.complementarySidebarState}
-      onNavigationSidebarStateChange={(next) => (context.sidebarState = next)}
-      onComplementarySidebarStateChange={(next) => (context.complementarySidebarState = next)}
-    >
-      {/* Left sidebar. */}
-      <Sidebar />
-
-      {/* Right sidebar. */}
-      <ComplementarySidebar current={complementarySidebarPanel} />
-
-      {/* Dialog overlay to dismiss dialogs. */}
-      <Main.Overlay />
-
-      {/* No content. */}
-      {isEmpty && (
-        <Main.Content bounce handlesFocus classNames={mainPosition}>
-          <ContentEmpty />
-        </Main.Content>
-      )}
-
-      {/* Solo/deck mode. */}
-      {!isEmpty && (
-        <Main.Content
-          bounce
-          handlesFocus
-          classNames={mainPosition}
-          style={
-            {
-              '--main-spacing': settings?.encapsulatedPlanks ? '0.75rem' : '0',
-              '--dx-main-sidebarWidth':
-                sidebarState === 'expanded'
-                  ? 'var(--nav-sidebar-size)'
-                  : sidebarState === 'collapsed'
-                    ? 'var(--l0-size)'
-                    : '0',
-              '--dx-main-complementaryWidth':
-                complementarySidebarState === 'expanded'
-                  ? 'var(--complementary-sidebar-size)'
-                  : complementarySidebarState === 'collapsed'
-                    ? 'var(--rail-size)'
-                    : '0',
-              '--dx-main-contentFirstWidth': `${plankSizing[active[0] ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
-              '--dx-main-contentLastWidth': `${plankSizing[active[(active.length ?? 1) - 1] ?? 'never'] ?? DEFAULT_HORIZONTAL_SIZE}rem`,
-            } as MainProps['style']
-          }
-        >
-          {/* Deck mode. */}
-          <div
-            role='none'
-            className={!solo ? 'relative bg-deckSurface overflow-hidden' : 'sr-only'}
-            {...(solo && { inert: true })}
-          >
-            {!topbar && !fullscreen && <ToggleSidebarButton classNames={fixedSidebarToggleStyles} />}
-            {!topbar && !fullscreen && (
-              <ToggleComplementarySidebarButton classNames={fixedComplementarySidebarToggleStyles} />
-            )}
-            <Stack
-              ref={deckRef}
-              orientation='horizontal'
-              size='contain'
-              itemsCount={itemsCount - 1}
-              classNames={[
-                'absolute inset-block-[--main-spacing] -inset-inline-px bs-[calc(100%-2*var(--main-spacing))]',
-                mainPaddingTransitions,
-              ]}
-              style={padding}
-              onScroll={handleScroll}
-            >
-              {active.map((entryId) => (
-                <Fragment key={entryId}>
-                  <PlankSeparator order={order[entryId] - 1} encapsulate={!!settings?.enableDeck} />
-                  <Plank
-                    id={entryId}
-                    companionId={activeCompanions?.[entryId]}
-                    part='deck'
-                    order={order[entryId]}
-                    active={active}
-                    layoutMode={layoutMode}
-                    settings={settings}
-                  />
-                </Fragment>
-              ))}
-            </Stack>
-          </div>
-          {/* Solo mode. */}
-          <div
-            role='none'
-            className={solo ? 'relative overflow-hidden bg-deckSurface' : 'sr-only'}
-            {...(!solo && { inert: true })}
-          >
-            {!topbar && !fullscreen && <ToggleSidebarButton classNames={fixedSidebarToggleStyles} />}
-            {!topbar && !fullscreen && (
-              <ToggleComplementarySidebarButton classNames={fixedComplementarySidebarToggleStyles} />
-            )}
-            <StackContext.Provider
-              value={{
-                orientation: 'horizontal',
-                size: 'contain',
-                rail: true,
-              }}
-            >
-              <Plank
-                id={solo}
-                companionId={solo ? activeCompanions?.[solo] : undefined}
-                part='solo'
-                layoutMode={layoutMode}
-                settings={settings}
-              />
-            </StackContext.Provider>
-          </div>
-        </Main.Content>
-      )}
-
-      {/* Topbar. */}
-      {topbar && <Topbar />}
-
-      {/* Status bar. */}
-      {hoistStatusbar && <StatusBar showHints={settings?.showHints} />}
-    </Main.Root>
-  );
-};
-
-const PlankSeparator = ({ order, encapsulate }: { order: number; encapsulate?: boolean }) =>
-  order > 0 ? (
-    <span
-      role='separator'
-      className={mx('row-span-2 bg-deckSurface', encapsulate ? 'is-0' : 'is-4')}
-      style={{ gridColumn: order }}
-    />
-  ) : null;

package/src/components/DeckLayout/Fallback.tsx

@@ -1,28 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useTranslation } from '@dxos/react-ui';
-import { errorText, mx } from '@dxos/react-ui-theme';
-
-import { meta } from '../../meta';
-
-export const Fallback = () => {
-  const { t } = useTranslation(meta.id);
-
-  return (
-    <div role='none' className='min-bs-screen is-full flex items-center justify-center p-8'>
-      <p
-        role='alert'
-        className={mx(
-          errorText,
-          'border border-roseFill rounded-md flex items-center justify-center p-8 font-normal text-lg',
-        )}
-      >
-        {t('plugin error message')}
-      </p>
-    </div>
-  );
-};

package/src/components/DeckLayout/Popover.tsx

@@ -1,95 +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, useCapability } from '@dxos/app-framework/react';
-import { Popover, type PopoverContentInteractOutsideEvent } from '@dxos/react-ui';
-
-import { DeckCapabilities } from '../../capabilities';
-
-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 layout = useCapability(DeckCapabilities.MutableDeckState);
-  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 (layout.popoverOpen) {
-      if (debounceRef.current) {
-        clearTimeout(debounceRef.current);
-      }
-      if (layout.popoverAnchor && virtualRef.current !== layout.popoverAnchor) {
-        virtualRef.current = layout.popoverAnchor ?? null;
-        setVirtualIter((iter) => iter + 1);
-      }
-      debounceRef.current = setTimeout(() => setOpen(true), DEBOUNCE_DELAY);
-    }
-  }, [layout.popoverOpen, layout.popoverAnchorId, layout.popoverAnchor, layout.popoverContent]);
-
-  return (
-    <DeckPopoverProvider setOpen={setOpen}>
-      <Popover.Root modal={false} open={open}>
-        {layout.popoverAnchor && <Popover.VirtualTrigger key={virtualIter} virtualRef={virtualRef} />}
-        {children}
-      </Popover.Root>
-    </DeckPopoverProvider>
-  );
-};
-
-export const PopoverContent = () => {
-  const layout = useCapability(DeckCapabilities.MutableDeckState);
-  const { setOpen } = useDeckPopoverContext('PopoverContent');
-
-  const handleClose = 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 {
-        setOpen(false);
-        layout.popoverOpen = false;
-        layout.popoverAnchor = undefined;
-        layout.popoverAnchorId = undefined;
-        layout.popoverSide = undefined;
-      }
-    },
-    [setOpen],
-  );
-
-  return (
-    <Popover.Portal>
-      <Popover.Content
-        side={layout.popoverSide}
-        sticky='always'
-        hideWhenDetached
-        onInteractOutside={handleClose}
-        onEscapeKeyDown={handleClose}
-      >
-        <Popover.Viewport>
-          <Surface role='card--popover' data={layout.popoverContent} limit={1} />
-        </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,54 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { AttentionPlugin } from '@dxos/plugin-attention';
-import { GraphPlugin } from '@dxos/plugin-graph';
-import { withTheme } from '@dxos/react-ui/testing';
-import { Stack } from '@dxos/react-ui-stack';
-
-import { DeckStateFactory } from '../../capabilities';
-import { translations } from '../../translations';
-
-import { Plank } from './Plank';
-
-const meta = {
-  title: 'plugins/plugin-deck/Plank',
-  component: Plank,
-  render: (args) => {
-    return (
-      <Stack orientation='horizontal'>
-        <Plank {...args} />
-      </Stack>
-    );
-  },
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [AttentionPlugin(), SettingsPlugin(), IntentPlugin(), GraphPlugin()],
-      capabilities: () => DeckStateFactory(),
-    }),
-  ],
-  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',
-  },
-};