@dxos/react-ui-editor 0.8.4-main.d05673bc65 → 0.8.4-main.dfabb4ec29

package/src/components/EditorToolbar/EditorToolbar.tsx

@@ -9,16 +9,18 @@ import React, { memo, useMemo } from 'react';
 import { type Node } from '@dxos/app-graph';
 import { ElevationProvider, type ThemedClassName } from '@dxos/react-ui';
 import { type ActionGraphProps, Menu, type MenuAction, MenuBuilder, useMenuActions } from '@dxos/react-ui-menu';
-import { type EditorViewMode } from '@dxos/ui-editor';
+import { type EditorViewMode } from '@dxos/ui-editor/types';
 
-import { createLists } from './actions';
-import { createBlocks } from './blocks';
-import { createFormatting } from './formatting';
-import { createHeadings } from './headings';
-import { createImageUpload } from './image';
-import { createSearch } from './search';
-import { type EditorToolbarState } from './useEditorToolbar';
-import { createViewMode } from './view-mode';
+import { addBlocks } from './blocks';
+import { addFormatting } from './formatting';
+import { addHeadings } from './headings';
+import { addImageUpload } from './image';
+import { addLists } from './lists';
+import { addSearch } from './search';
+import { type EditorToolbarState } from './types';
+import { addViewMode } from './view-mode';
+
+// TODO(burdon): Enable toolbar variants (e.g., markdown, code).
 
 export type EditorToolbarFeatureFlags = Partial<{
   showHeadings: boolean;
@@ -49,12 +51,12 @@ export type EditorToolbarProps = ThemedClassName<
 >;
 
 export const EditorToolbar = memo(({ classNames, role, attendableId, onAction, ...props }: EditorToolbarProps) => {
-  const menuProps = useEditorToolbarActionGraph(props);
+  const menuActions = useMarkdownMenuActions(props);
 
   return (
     <ElevationProvider elevation={role === 'section' ? 'positioned' : 'base'}>
-      <Menu.Root {...menuProps} attendableId={attendableId} onAction={onAction}>
-        <Menu.Toolbar classNames={classNames} textBlockWidth />
+      <Menu.Root {...menuActions} attendableId={attendableId} onAction={onAction}>
+        <Menu.Toolbar classNames={classNames} />
       </Menu.Root>
     </ElevationProvider>
   );
@@ -63,13 +65,13 @@ export const EditorToolbar = memo(({ classNames, role, attendableId, onAction, .
 type ToolbarActionsProps = Pick<EditorToolbarActionGraphProps, 'state' | 'getView' | 'customActions'> &
   EditorToolbarFeatureFlags;
 
+// TODO(burdon): Some actions should toggle the state (e.g., toggle bullets on/off depending on the current state).
 // TODO(wittjosiah): Toolbar re-rendering is causing this graph to be recreated and breaking reactivity in some cases.
 //   E.g. for toolbar dropdowns which use active icon, the icon is not updated when the active item changes.
 //   This is currently only happening in the markdown plugin usage and should be reproduced in an editor story.
-// TODO(burdon): Some actions should toggle the state (e.g., toggle bullets on/off depending on the current state).
-const useEditorToolbarActionGraph = ({ state, getView, customActions, ...features }: ToolbarActionsProps) => {
+const useMarkdownMenuActions = ({ state, getView, customActions, ...features }: ToolbarActionsProps) => {
   const menuCreator = useMemo(
-    () => createToolbarActions({ state, getView, customActions, ...features }),
+    () => createMarkdownActions({ state, getView, customActions, ...features }),
     [
       state,
       getView,
@@ -87,7 +89,7 @@ const useEditorToolbarActionGraph = ({ state, getView, customActions, ...feature
   return useMenuActions(menuCreator);
 };
 
-const createToolbarActions = ({
+const createMarkdownActions = ({
   state,
   getView,
   customActions,
@@ -96,37 +98,16 @@ const createToolbarActions = ({
   return Atom.make((get) => {
     // Subscribe to state changes.
     const stateSnapshot = get(state);
-
-    const builder = MenuBuilder.make();
-
-    if (features?.showHeadings ?? true) {
-      builder.subgraph(createHeadings(stateSnapshot, getView));
-    }
-    if (features?.showFormatting ?? true) {
-      builder.subgraph(createFormatting(stateSnapshot, getView));
-    }
-    if (features?.showLists ?? true) {
-      builder.subgraph(createLists(stateSnapshot, getView));
-    }
-    if (features?.showBlocks ?? true) {
-      builder.subgraph(createBlocks(stateSnapshot, getView));
-    }
-    if (features?.onImageUpload) {
-      builder.subgraph(createImageUpload(features.onImageUpload!));
-    }
-
-    builder.separator('gap');
-
-    if (customActions) {
-      builder.subgraph(get(customActions));
-    }
-    if (features?.showSearch ?? true) {
-      builder.subgraph(createSearch(getView));
-    }
-    if (features?.onViewModeChange) {
-      builder.subgraph(createViewMode(stateSnapshot, features.onViewModeChange!));
-    }
-
-    return builder.build();
+    return MenuBuilder.make()
+      .subgraph(features?.showHeadings !== false && addHeadings(stateSnapshot, getView))
+      .subgraph(features?.showFormatting !== false && addFormatting(stateSnapshot, getView))
+      .subgraph(features?.showLists !== false && addLists(stateSnapshot, getView))
+      .subgraph(features?.showBlocks !== false && addBlocks(stateSnapshot, getView))
+      .subgraph(features?.onImageUpload && addImageUpload(features.onImageUpload))
+      .separator('gap')
+      .subgraph(customActions && get(customActions))
+      .subgraph(features?.showSearch !== false && addSearch(getView))
+      .subgraph(features?.onViewModeChange && addViewMode(stateSnapshot, features.onViewModeChange))
+      .build();
   });
 };

package/src/components/EditorToolbar/blocks.ts

@@ -4,56 +4,64 @@
 
 import { type EditorView } from '@codemirror/view';
 
-import { type Node } from '@dxos/app-graph';
-import { type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
+import { type ActionGroupBuilderFn, type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
 import { addBlockquote, addCodeblock, insertTable, removeBlockquote, removeCodeblock } from '@dxos/ui-editor';
 
-import { createEditorAction, createEditorActionGroup } from './actions';
-import { type EditorToolbarState } from './useEditorToolbar';
+import { translationKey } from '#translations';
 
-const createBlockGroupAction = (value: string) =>
-  createEditorActionGroup('block', {
-    variant: 'toggleGroup',
-    selectCardinality: 'single',
-    value,
-  } as ToolbarMenuActionGroupProperties);
+import { type EditorToolbarState } from './types';
 
-const createBlockActions = (value: string, getView: () => EditorView, blankLine?: boolean) =>
-  Object.entries({
-    blockquote: 'ph--quotes--regular',
-    codeblock: 'ph--code-block--regular',
-    table: 'ph--table--regular',
-  }).map(([type, icon]) => {
-    const checked = type === value;
-    return createEditorAction(type, { checked, ...(type === 'table' && { disabled: !!blankLine }), icon }, () => {
-      const view = getView();
-      if (!view) {
-        return;
-      }
+const blockTypes = {
+  blockquote: 'ph--quotes--regular',
+  codeblock: 'ph--code-block--regular',
+  table: 'ph--table--regular',
+};
 
-      switch (type) {
-        case 'blockquote':
-          checked ? removeBlockquote(view) : addBlockquote(view);
-          break;
-        case 'codeblock':
-          checked ? removeCodeblock(view) : addCodeblock(view);
-          break;
-        case 'table':
-          insertTable(view);
-          break;
-      }
-    });
-  });
+/** Add block actions to the builder. */
+export const addBlocks =
+  (state: EditorToolbarState, getView: () => EditorView): ActionGroupBuilderFn =>
+  (builder) => {
+    const value = state?.blockQuote ? 'blockquote' : (state.blockType ?? '');
+    builder.group(
+      'block',
+      {
+        label: ['block.label', { ns: translationKey }],
+        iconOnly: true,
+        variant: 'toggleGroup',
+        selectCardinality: 'single',
+        value,
+      } as ToolbarMenuActionGroupProperties,
+      (group) => {
+        for (const [type, icon] of Object.entries(blockTypes)) {
+          const checked = type === value;
+          group.action(
+            type,
+            {
+              label: [`block.${type}.label`, { ns: translationKey }],
+              checked,
+              ...(type === 'table' && { disabled: !!state.blankLine }),
+              icon,
+            },
+            () => {
+              const view = getView();
+              if (!view) {
+                return;
+              }
 
-export const createBlocks = (state: EditorToolbarState, getView: () => EditorView) => {
-  const value = state?.blockQuote ? 'blockquote' : (state.blockType ?? '');
-  const blockGroupAction = createBlockGroupAction(value);
-  const blockActions = createBlockActions(value, getView, state.blankLine);
-  return {
-    nodes: [blockGroupAction as Node.NodeArg<any>, ...blockActions],
-    edges: [
-      { source: 'root', target: 'block', relation: 'child' },
-      ...blockActions.map(({ id }) => ({ source: blockGroupAction.id, target: id, relation: 'child' })),
-    ],
+              switch (type) {
+                case 'blockquote':
+                  checked ? removeBlockquote(view) : addBlockquote(view);
+                  break;
+                case 'codeblock':
+                  checked ? removeCodeblock(view) : addCodeblock(view);
+                  break;
+                case 'table':
+                  insertTable(view);
+                  break;
+              }
+            },
+          );
+        }
+      },
+    );
   };
-};

package/src/components/EditorToolbar/formatting.ts

@@ -4,12 +4,12 @@
 
 import { type EditorView } from '@codemirror/view';
 
-import { type Node } from '@dxos/app-graph';
-import { type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
+import { type ActionGroupBuilderFn, type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
 import { type Formatting, Inline, addLink, removeLink, setStyle } from '@dxos/ui-editor';
 
-import { createEditorAction, createEditorActionGroup } from './actions';
-import { type EditorToolbarState } from './useEditorToolbar';
+import { translationKey } from '#translations';
+
+import { type EditorToolbarState } from './types';
 
 const formats = {
   strong: 'ph--text-b--regular',
@@ -19,47 +19,46 @@ const formats = {
   link: 'ph--link--regular',
 };
 
-const createFormattingGroup = (formatting: Formatting) =>
-  createEditorActionGroup('formatting', {
-    variant: 'toggleGroup',
-    selectCardinality: 'multiple',
-    value: Object.keys(formats).filter((key) => !!formatting[key as keyof Formatting]),
-  } as ToolbarMenuActionGroupProperties);
-
-const createFormattingActions = (formatting: Formatting, getView: () => EditorView) =>
-  Object.entries(formats).map(([type, icon]) => {
-    const checked = !!formatting[type as keyof Formatting];
-    return createEditorAction(type, { checked, icon }, () => {
-      const view = getView();
-      if (!view) {
-        return;
-      }
+/** Add formatting actions to the builder. */
+export const addFormatting =
+  (state: EditorToolbarState, getView: () => EditorView): ActionGroupBuilderFn =>
+  (builder) => {
+    const formatting: Formatting = state;
+    builder.group(
+      'formatting',
+      {
+        label: ['formatting.label', { ns: translationKey }],
+        iconOnly: true,
+        variant: 'toggleGroup',
+        selectCardinality: 'multiple',
+        value: Object.keys(formats).filter((key) => !!formatting[key as keyof Formatting]),
+      } as ToolbarMenuActionGroupProperties,
+      (group) => {
+        for (const [type, icon] of Object.entries(formats)) {
+          const checked = !!formatting[type as keyof Formatting];
+          group.action(type, { label: [`formatting.${type}.label`, { ns: translationKey }], checked, icon }, () => {
+            const view = getView();
+            if (!view) {
+              return;
+            }
 
-      if (type === 'link') {
-        checked ? removeLink(view) : addLink()(view);
-        return;
-      }
+            if (type === 'link') {
+              checked ? removeLink(view) : addLink()(view);
+              return;
+            }
 
-      const inlineType =
-        type === 'strong'
-          ? Inline.Strong
-          : type === 'emphasis'
-            ? Inline.Emphasis
-            : type === 'strikethrough'
-              ? Inline.Strikethrough
-              : Inline.Code;
-      setStyle(inlineType, !checked)(view);
-    });
-  });
-
-export const createFormatting = (state: EditorToolbarState, getView: () => EditorView) => {
-  const formattingGroupAction = createFormattingGroup(state);
-  const formattingActions = createFormattingActions(state, getView);
-  return {
-    nodes: [formattingGroupAction as Node.NodeArg<any>, ...formattingActions],
-    edges: [
-      { source: 'root', target: 'formatting', relation: 'child' },
-      ...formattingActions.map(({ id }) => ({ source: formattingGroupAction.id, target: id, relation: 'child' })),
-    ],
+            setStyle(
+              type === 'strong'
+                ? Inline.Strong
+                : type === 'emphasis'
+                  ? Inline.Emphasis
+                  : type === 'strikethrough'
+                    ? Inline.Strikethrough
+                    : Inline.Code,
+              !checked,
+            )(view);
+          });
+        }
+      },
+    );
   };
-};

package/src/components/EditorToolbar/headings.ts

@@ -4,49 +4,22 @@
 
 import { type EditorView } from '@codemirror/view';
 
-import { type Node } from '@dxos/app-graph';
-import { type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
+import { type ActionGroupBuilderFn, type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
 import { setHeading } from '@dxos/ui-editor';
 
-import { translationKey } from '../../translations';
+import { translationKey } from '#translations';
 
-import { createEditorAction, createEditorActionGroup } from './actions';
-import { type EditorToolbarState } from './useEditorToolbar';
+import { type EditorToolbarState } from './types';
 
-const createHeadingGroupAction = (value: string) =>
-  createEditorActionGroup(
-    'heading',
-    {
-      variant: 'dropdownMenu',
-      applyActive: true,
-      selectCardinality: 'single',
-      // TODO(wittjosiah): Remove? Not sure this does anything.
-      value,
-    } as ToolbarMenuActionGroupProperties,
-    'ph--text-h--regular',
-  );
-
-const createHeadingActions = (currentLevel: string, getView: () => EditorView) =>
-  Object.entries({
-    0: 'ph--paragraph--regular',
-    1: 'ph--text-h-one--regular',
-    2: 'ph--text-h-two--regular',
-    3: 'ph--text-h-three--regular',
-    4: 'ph--text-h-four--regular',
-    5: 'ph--text-h-five--regular',
-    6: 'ph--text-h-six--regular',
-  }).map(([levelStr, icon]) => {
-    const level = parseInt(levelStr);
-    return createEditorAction(
-      `heading--${levelStr}`,
-      {
-        label: ['heading level label', { count: level, ns: translationKey }],
-        icon,
-        checked: levelStr === currentLevel,
-      },
-      () => setHeading(level)(getView()),
-    );
-  });
+const headingIcons: Record<string, string> = {
+  0: 'ph--paragraph--regular',
+  1: 'ph--text-h-one--regular',
+  2: 'ph--text-h-two--regular',
+  3: 'ph--text-h-three--regular',
+  4: 'ph--text-h-four--regular',
+  5: 'ph--text-h-five--regular',
+  6: 'ph--text-h-six--regular',
+};
 
 const computeHeadingValue = (state: EditorToolbarState) => {
   const blockType = state ? state.blockType : 'paragraph';
@@ -54,15 +27,36 @@ const computeHeadingValue = (state: EditorToolbarState) => {
   return heading ? heading[1] : blockType === 'paragraph' || !blockType ? '0' : '';
 };
 
-export const createHeadings = (state: EditorToolbarState, getView: () => EditorView) => {
-  const headingValue = computeHeadingValue(state);
-  const headingGroupAction = createHeadingGroupAction(headingValue);
-  const headingActions = createHeadingActions(headingValue, getView);
-  return {
-    nodes: [headingGroupAction as Node.NodeArg<any>, ...headingActions],
-    edges: [
-      { source: 'root', target: 'heading', relation: 'child' },
-      ...headingActions.map(({ id }) => ({ source: headingGroupAction.id, target: id, relation: 'child' })),
-    ],
+/** Add heading actions to the builder. */
+export const addHeadings =
+  (state: EditorToolbarState, getView: () => EditorView): ActionGroupBuilderFn =>
+  (builder) => {
+    const headingValue = computeHeadingValue(state);
+    builder.group(
+      'heading',
+      {
+        label: ['heading.label', { ns: translationKey }],
+        icon: 'ph--text-h--regular',
+        iconOnly: true,
+        variant: 'dropdownMenu',
+        applyActive: true,
+        selectCardinality: 'single',
+        // TODO(wittjosiah): Remove? Not sure this does anything.
+        value: headingValue,
+      } as ToolbarMenuActionGroupProperties,
+      (group) => {
+        for (const [levelStr, icon] of Object.entries(headingIcons)) {
+          const level = parseInt(levelStr);
+          group.action(
+            `heading--${levelStr}`,
+            {
+              label: ['heading-level.label', { count: level, ns: translationKey }],
+              icon,
+              checked: levelStr === headingValue,
+            },
+            () => setHeading(level)(getView()),
+          );
+        }
+      },
+    );
   };
-};

package/src/components/EditorToolbar/image.ts

@@ -2,26 +2,21 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type Node } from '@dxos/app-graph';
+import { type ActionGroupBuilderFn } from '@dxos/react-ui-menu';
 
-import { createEditorAction } from './actions';
+import { translationKey } from '#translations';
 
-const createImageUploadAction = (onImageUpload: () => void) =>
-  createEditorAction(
-    'image',
-    {
-      testId: 'editor.toolbar.image',
-      icon: 'ph--image-square--regular',
-    },
-    onImageUpload,
-  );
-
-export const createImageUpload = (
-  onImageUpload: () => void,
-): {
-  nodes: Node.NodeArg<any>[];
-  edges: Array<{ source: string; target: string; relation: 'child' }>;
-} => ({
-  nodes: [createImageUploadAction(onImageUpload)],
-  edges: [{ source: 'root', target: 'image', relation: 'child' }],
-});
+/** Add image upload action to the builder. */
+export const addImageUpload =
+  (onImageUpload: () => void): ActionGroupBuilderFn =>
+  (builder) => {
+    builder.action(
+      'image',
+      {
+        label: ['image.label', { ns: translationKey }],
+        testId: 'editor.toolbar.image',
+        icon: 'ph--image-square--regular',
+      },
+      onImageUpload,
+    );
+  };

package/src/components/EditorToolbar/index.ts

@@ -2,7 +2,6 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './EditorToolbar';
+export * from './types';
 
-export { createEditorAction, createEditorActionGroup } from './actions';
-export { type EditorToolbarState, useEditorToolbar } from './useEditorToolbar';
+export * from './EditorToolbar';

package/src/components/EditorToolbar/lists.ts

@@ -0,0 +1,58 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type EditorView } from '@codemirror/view';
+
+import { type ActionGroupBuilderFn, type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
+import { List, addList, removeList } from '@dxos/ui-editor';
+
+import { translationKey } from '#translations';
+
+import { type EditorToolbarState } from './types';
+
+const listStyles = {
+  bullet: 'ph--list-bullets--regular',
+  ordered: 'ph--list-numbers--regular',
+  task: 'ph--list-checks--regular',
+};
+
+/** Add list actions to the builder. */
+export const addLists =
+  (state: EditorToolbarState, getView: () => EditorView): ActionGroupBuilderFn =>
+  (builder) => {
+    const value = state.listStyle ?? '';
+    builder.group(
+      'list',
+      {
+        label: ['list.label', { ns: translationKey }],
+        iconOnly: true,
+        variant: 'toggleGroup',
+        selectCardinality: 'single',
+        value,
+      } as ToolbarMenuActionGroupProperties,
+      (group) => {
+        for (const [listStyle, icon] of Object.entries(listStyles)) {
+          const checked = value === listStyle;
+          group.action(
+            `list-${listStyle}`,
+            { label: [`list.${listStyle}.label`, { ns: translationKey }], checked, icon },
+            () => {
+              const view = getView();
+              if (!view) {
+                return;
+              }
+
+              const listType =
+                listStyle === 'ordered' ? List.Ordered : listStyle === 'bullet' ? List.Bullet : List.Task;
+              if (checked) {
+                removeList(listType)(view);
+              } else {
+                addList(listType)(view);
+              }
+            },
+          );
+        }
+      },
+    );
+  };

package/src/components/EditorToolbar/search.ts

@@ -5,26 +5,21 @@
 import { openSearchPanel } from '@codemirror/search';
 import { type EditorView } from '@codemirror/view';
 
-import { type Node } from '@dxos/app-graph';
+import { type ActionGroupBuilderFn } from '@dxos/react-ui-menu';
 
-import { createEditorAction } from './actions';
+import { translationKey } from '#translations';
 
-const createSearchAction = (getView: () => EditorView) =>
-  createEditorAction(
-    'search',
-    {
-      testId: 'editor.toolbar.search',
-      icon: 'ph--magnifying-glass--regular',
-    },
-    () => openSearchPanel(getView()),
-  );
-
-export const createSearch = (
-  getView: () => EditorView,
-): {
-  nodes: Node.NodeArg<any>[];
-  edges: Array<{ source: string; target: string; relation: 'child' }>;
-} => ({
-  nodes: [createSearchAction(getView)],
-  edges: [{ source: 'root', target: 'search', relation: 'child' }],
-});
+/** Add search action to the builder. */
+export const addSearch =
+  (getView: () => EditorView): ActionGroupBuilderFn =>
+  (builder) => {
+    builder.action(
+      'search',
+      {
+        label: ['search.label', { ns: translationKey }],
+        testId: 'editor.toolbar.search',
+        icon: 'ph--magnifying-glass--regular',
+      },
+      () => openSearchPanel(getView()),
+    );
+  };

package/src/components/EditorToolbar/types.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Formatting } from '@dxos/ui-editor';
+import { type EditorViewMode } from '@dxos/ui-editor/types';
+
+export type EditorToolbarState = Formatting & { viewMode?: EditorViewMode };