@dxos/plugin-deck 0.6.12-staging.e11e696 → 0.6.13-main.548ca8d

package/src/components/DeckLayout/ComplementarySidebar.tsx

@@ -2,9 +2,15 @@
 // Copyright 2024 DXOS.org
 //
 
-import React from 'react';
+import React, { useMemo } from 'react';
 
-import { type LayoutParts, SLUG_PATH_SEPARATOR, Surface } from '@dxos/app-framework';
+import {
+  type LayoutParts,
+  NavigationAction,
+  SLUG_PATH_SEPARATOR,
+  Surface,
+  useIntentDispatcher,
+} from '@dxos/app-framework';
 import { useGraph } from '@dxos/plugin-graph';
 import { Main } from '@dxos/react-ui';
 import { useAttended } from '@dxos/react-ui-attention';
@@ -15,6 +21,7 @@ import { NodePlankHeading } from './NodePlankHeading';
 import { PlankContentError } from './PlankError';
 import { PlankLoading } from './PlankLoading';
 import { useNode, useNodeActionExpander } from '../../hooks';
+import { DECK_PLUGIN } from '../../meta';
 import { useLayout } from '../LayoutContext';
 
 export type ComplementarySidebarProps = {
@@ -23,15 +30,50 @@ export type ComplementarySidebarProps = {
   flatDeck?: boolean;
 };
 
-export const ComplementarySidebar = ({ context, layoutParts, flatDeck }: ComplementarySidebarProps) => {
+const panels = ['comments', 'settings', 'debug'] as const;
+
+const nodes = [
+  { id: 'comments', icon: 'ph--chat-text--regular' },
+  { id: 'settings', icon: 'ph--gear--regular' },
+  { id: 'debug', icon: 'ph--bug--regular' },
+];
+
+type Panel = (typeof panels)[number];
+const getPanel = (part?: string): Panel => {
+  if (part && panels.findIndex((panel) => panel === part) !== -1) {
+    return part as Panel;
+  } else {
+    return 'settings';
+  }
+};
+
+export const ComplementarySidebar = ({ layoutParts, flatDeck }: ComplementarySidebarProps) => {
   const { popoverAnchorId } = useLayout();
   const attended = useAttended();
-  const id = attended[0] ? `${attended[0]}${SLUG_PATH_SEPARATOR}${context}` : undefined;
+  const part = getPanel(layoutParts.complementary?.[0].id);
+  const id = attended[0] ? `${attended[0]}${SLUG_PATH_SEPARATOR}${part}` : undefined;
   const { graph } = useGraph();
   const node = useNode(graph, id);
-
+  const dispatch = useIntentDispatcher();
   useNodeActionExpander(node);
 
+  const actions = useMemo(
+    () =>
+      nodes.map(({ id, icon }) => ({
+        id: `complementary-${id}`,
+        data: () => {
+          void dispatch({ action: NavigationAction.OPEN, data: { activeParts: { complementary: id } } });
+        },
+        properties: {
+          label: [`${id} label`, { ns: DECK_PLUGIN }],
+          icon,
+          menuItemType: 'toggle',
+          isChecked: part === id,
+        },
+      })),
+    [part],
+  );
+
   return (
     <Main.ComplementarySidebar>
       <div role='none' className={mx(deckGrid, 'grid-cols-1 bs-full')}>
@@ -42,12 +84,13 @@ export const ComplementarySidebar = ({ context, layoutParts, flatDeck }: Complem
           layoutPart='complementary'
           popoverAnchorId={popoverAnchorId}
           flatDeck={flatDeck}
+          actions={actions}
         />
-        {/* TODO(wittjosiah): Render some placeholder when node is undefined. */}
+        {/* TODO(wittjosiah): Render placeholder when node is undefined. */}
         {node && (
           <Surface
-            role='article'
-            data={{ subject: node.properties.object, part: 'complementary', popoverAnchorId }}
+            role={`complementary--${part}`}
+            data={{ subject: node.properties.object, popoverAnchorId }}
             limit={1}
             fallback={PlankContentError}
             placeholder={<PlankLoading />}

package/src/components/DeckLayout/DeckLayout.tsx

@@ -5,14 +5,7 @@
 import { Sidebar as MenuIcon } from '@phosphor-icons/react';
 import React, { useCallback, useEffect, useMemo, useRef, type UIEvent } from 'react';
 
-import {
-  type LayoutEntry,
-  type LayoutParts,
-  Surface,
-  type Toast as ToastSchema,
-  firstIdInPart,
-  usePlugin,
-} from '@dxos/app-framework';
+import { type LayoutParts, Surface, type Toast as ToastSchema, firstIdInPart, usePlugin } from '@dxos/app-framework';
 import { Button, Dialog, Main, Popover, useOnTransition, useTranslation } from '@dxos/react-ui';
 import { useAttended } from '@dxos/react-ui-attention';
 import { Deck } from '@dxos/react-ui-deck';
@@ -37,7 +30,7 @@ export type DeckLayoutProps = {
   toasts: ToastSchema[];
   flatDeck?: boolean;
   overscroll: Overscroll;
-  showHintsFooter: boolean;
+  showHints: boolean;
   slots?: {
     wallpaper?: { classNames?: string };
   };
@@ -49,7 +42,7 @@ export const DeckLayout = ({
   toasts,
   flatDeck,
   overscroll,
-  showHintsFooter,
+  showHints,
   slots,
   onDismissToast,
 }: DeckLayoutProps) => {
@@ -128,16 +121,7 @@ export const DeckLayout = ({
     }
   }, [layoutMode, firstAttendedId]);
 
-  // TODO(burdon): Needs cleaning up.
-  const parts: LayoutEntry[] = useMemo(() => {
-    const parts = [...(layoutParts.main ?? [])];
-    for (const part of layoutParts.solo ?? []) {
-      if (!parts.find((entry) => entry.id === part.id)) {
-        parts.push(part);
-      }
-    }
-    return parts;
-  }, [layoutParts.main, layoutParts.solo]);
+  const isEmpty = layoutParts.main?.length === 0 && layoutParts.solo?.length === 0;
 
   const padding = useMemo(() => {
     if (layoutMode === 'deck' && overscroll === 'centering') {
@@ -201,14 +185,14 @@ export const DeckLayout = ({
         <Main.Overlay />
 
         {/* No content. */}
-        {parts.length === 0 && (
+        {isEmpty && (
           <Main.Content handlesFocus>
             <ContentEmpty />
           </Main.Content>
         )}
 
         {/* Solo/deck mode. */}
-        {parts.length !== 0 && (
+        {!isEmpty && (
           <Main.Content bounce classNames='grid block-end-[--statusbar-size]' handlesFocus>
             <div role='none' className='relative'>
               <Deck.Root
@@ -218,12 +202,20 @@ export const DeckLayout = ({
                 onScroll={handleScroll}
                 ref={deckRef}
               >
-                {parts.map((layoutEntry) => (
+                <Plank
+                  entry={layoutParts.solo?.[0] ?? { id: 'unknown-solo' }}
+                  layoutParts={layoutParts}
+                  part='solo'
+                  layoutMode={layoutMode}
+                  flatDeck={flatDeck}
+                  searchEnabled={!!searchPlugin}
+                />
+                {layoutParts.main?.map((layoutEntry) => (
                   <Plank
                     key={layoutEntry.id}
                     entry={layoutEntry}
                     layoutParts={layoutParts}
-                    part={layoutMode === 'solo' && layoutEntry.id === layoutParts.solo?.[0]?.id ? 'solo' : 'main'}
+                    part='main'
                     layoutMode={layoutMode}
                     flatDeck={flatDeck}
                     searchEnabled={!!searchPlugin}
@@ -234,15 +226,8 @@ export const DeckLayout = ({
           </Main.Content>
         )}
 
-        <StatusBar />
-
-        {/* Help hints. */}
-        {/* TODO(burdon): Need to make room for this in status bar. */}
-        {showHintsFooter && (
-          <div className='fixed bottom-0 left-0 right-0 h-[32px] z-[1] flex justify-center'>
-            <Surface role='hints' limit={1} />
-          </div>
-        )}
+        {/* Footer status. */}
+        <StatusBar showHints={showHints} />
 
         {/* Global popovers. */}
         <Popover.Portal>

package/src/components/DeckLayout/NodePlankHeading.tsx

@@ -17,7 +17,7 @@ import {
 } from '@dxos/app-framework';
 import { type Node, useGraph } from '@dxos/plugin-graph';
 import { Icon, Popover, toLocalizedString, useMediaQuery, useTranslation } from '@dxos/react-ui';
-import { PlankHeading } from '@dxos/react-ui-deck';
+import { PlankHeading, type PlankHeadingAction } from '@dxos/react-ui-deck';
 import { TextTooltip } from '@dxos/react-ui-text-tooltip';
 
 import { DECK_PLUGIN } from '../../meta';
@@ -30,6 +30,7 @@ export const NodePlankHeading = ({
   popoverAnchorId,
   pending,
   flatDeck,
+  actions = [],
 }: {
   node?: Node;
   id?: string;
@@ -38,6 +39,7 @@ export const NodePlankHeading = ({
   popoverAnchorId?: string;
   pending?: boolean;
   flatDeck?: boolean;
+  actions?: PlankHeadingAction[];
 }) => {
   const { t } = useTranslation(DECK_PLUGIN);
   const { graph } = useGraph();
@@ -78,7 +80,7 @@ export const NodePlankHeading = ({
             related={layoutPart === 'complementary'}
             attendableId={attendableId}
             triggerLabel={t('actions menu label')}
-            actions={graph.actions(node)}
+            actions={[actions, graph.actions(node)].filter((a) => a.length > 0)}
             onAction={(action) =>
               typeof action.data === 'function' && action.data?.({ node: action as Node, caller: DECK_PLUGIN })
             }

package/src/components/DeckLayout/Plank.tsx

@@ -78,7 +78,7 @@ export const Plank = ({ entry, layoutParts, part, flatDeck, searchEnabled, layou
   }, [scrollIntoView, layoutMode]);
 
   const isSolo = layoutMode === 'solo' && part === 'solo';
-  const isSuppressed = layoutMode === 'solo' && part !== 'solo';
+  const isSuppressed = (layoutMode === 'solo' && part !== 'solo') || (layoutMode === 'deck' && part === 'solo');
 
   const sizeAttrs = useMainSize();
 

package/src/components/DeckLayout/StatusBar.tsx

@@ -9,10 +9,18 @@ import { mainPadding, mx } from '@dxos/react-ui-theme';
 
 import { useMainSize } from '../../hooks';
 
-export const StatusBar = () => {
+export const StatusBar = ({ showHints }: { showHints?: boolean }) => {
   const sizeAttrs = useMainSize();
   return (
-    <div role='none' {...sizeAttrs} className={mx('fixed block-end-0 inset-inline-0 z-[2]', mainPadding)}>
+    <div
+      role='none'
+      {...sizeAttrs}
+      className={mx(
+        'fixed flex justify-between block-end-0 inset-inline-0 items-center border-bs border-separator z-[2]',
+        mainPadding,
+      )}
+    >
+      <div role='none'>{showHints && <Surface role='hints' limit={1} />}</div>
       <Surface role='status-bar' limit={1} />
     </div>
   );

package/src/components/LayoutSettings.tsx

@@ -61,25 +61,22 @@ export const LayoutSettings = ({ settings }: { settings: DeckSettingsProps }) =>
           </Select.Portal>
         </Select.Root>
       </SettingsValue>
-      <SettingsValue label={t('settings show footer label')}>
-        <Input.Switch checked={settings.showFooter} onCheckedChange={(checked) => (settings.showFooter = !!checked)} />
+      <SettingsValue label={t('settings show hints label')}>
+        <Input.Switch checked={settings.showHints} onCheckedChange={(checked) => (settings.showHints = checked)} />
       </SettingsValue>
       {!isSocket && (
         <SettingsValue label={t('settings native redirect label')}>
           <Input.Switch
             checked={settings.enableNativeRedirect}
-            onCheckedChange={(checked) => (settings.enableNativeRedirect = !!checked)}
+            onCheckedChange={(checked) => (settings.enableNativeRedirect = checked)}
           />
         </SettingsValue>
       )}
       <SettingsValue label={t('settings custom slots')}>
-        <Input.Switch
-          checked={settings.customSlots}
-          onCheckedChange={(checked) => (settings.customSlots = !!checked)}
-        />
+        <Input.Switch checked={settings.customSlots} onCheckedChange={(checked) => (settings.customSlots = checked)} />
       </SettingsValue>
       <SettingsValue label={t('settings flat deck')}>
-        <Input.Switch checked={settings.flatDeck} onCheckedChange={(checked) => (settings.flatDeck = !!checked)} />
+        <Input.Switch checked={settings.flatDeck} onCheckedChange={(checked) => (settings.flatDeck = checked)} />
       </SettingsValue>
     </>
   );

package/src/meta.ts

@@ -2,9 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type PluginMeta } from '@dxos/app-framework';
+
 export const DECK_PLUGIN = 'dxos.org/plugin/deck';
 
 export default {
   id: DECK_PLUGIN,
   name: 'Deck',
-};
+} satisfies PluginMeta;

package/src/translations.ts

@@ -16,7 +16,7 @@ export default [
         'content fallback description':
           'No plugin had a response for the address you navigated to. Double-check the URL, and ensure you’ve enabled a plugin that supports the object.',
         'toggle fullscreen label': 'Toggle fullscreen',
-        'settings show footer label': 'Show footer (experimental)',
+        'settings show hints label': 'Show hints',
         'settings native redirect label': 'Enable native url redirect (experimental)',
         'settings custom slots': 'Theme option (experimental)',
         'settings new plank position start label': 'Start',
@@ -41,6 +41,8 @@ export default [
         'settings overscroll centering label': 'Centering',
         'settings overscroll none label': 'None',
         'settings flat deck': 'Flatten deck appearance',
+        'comments label': 'Show Comments',
+        'settings label': 'Show Settings',
       },
     },
   },

package/src/types.ts

@@ -20,7 +20,7 @@ export const OverscrollOptions = ['none', 'centering'] as const;
 export type Overscroll = (typeof OverscrollOptions)[number];
 
 export type DeckSettingsProps = {
-  showFooter: boolean;
+  showHints: boolean;
   customSlots: boolean;
   flatDeck: boolean;
   enableNativeRedirect: boolean;

package/dist/lib/browser/chunk-YVHGFQQR.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nexport const DECK_PLUGIN = 'dxos.org/plugin/deck';\n\nexport default {\n  id: DECK_PLUGIN,\n  name: 'Deck',\n};\n"],
-  "mappings": ";AAIO,IAAMA,cAAc;AAE3B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;",
-  "names": ["DECK_PLUGIN", "id", "name"]
-}