@dxos/react-ui-editor 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

package/src/components/EditorToolbar/EditorToolbar.tsx

@@ -2,123 +2,112 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Rx } from '@effect-rx/rx-react';
+import { type EditorView } from '@codemirror/view';
+import { Atom } from '@effect-atom/atom-react';
 import React, { memo, useMemo } from 'react';
 
-import { rxFromSignal, type NodeArg } from '@dxos/app-graph';
-import { ElevationProvider } from '@dxos/react-ui';
-import { MenuProvider, ToolbarMenu, createGapSeparator, useMenuActions } from '@dxos/react-ui-menu';
+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/types';
 
-import { createBlocks } from './blocks';
-import { createFormatting } from './formatting';
-import { createHeadings } from './headings';
-import { createImageUpload } from './image';
-import { createLists } from './lists';
-import { createSearch } from './search';
-import { type EditorToolbarActionGraphProps, type EditorToolbarFeatureFlags, type EditorToolbarProps } from './util';
-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';
 
-const createToolbar = ({
-  getView,
-  state,
-  customActions,
-  ...features
-}: EditorToolbarFeatureFlags & Pick<EditorToolbarActionGraphProps, 'getView' | 'state' | 'customActions'>): Rx.Rx<{
-  nodes: NodeArg<any>[];
-  edges: { source: string; target: string }[];
-}> => {
-  return Rx.make((get) => {
-    const nodes = [];
-    const edges = [];
-    if (features.headings ?? true) {
-      const headings = get(rxFromSignal(() => createHeadings(state, getView)));
-      nodes.push(...headings.nodes);
-      edges.push(...headings.edges);
-    }
-    if (features.formatting ?? true) {
-      const formatting = get(rxFromSignal(() => createFormatting(state, getView)));
-      nodes.push(...formatting.nodes);
-      edges.push(...formatting.edges);
-    }
-    if (features.lists ?? true) {
-      const lists = get(rxFromSignal(() => createLists(state, getView)));
-      nodes.push(...lists.nodes);
-      edges.push(...lists.edges);
-    }
-    if (features.blocks ?? true) {
-      const blocks = get(rxFromSignal(() => createBlocks(state, getView)));
-      nodes.push(...blocks.nodes);
-      edges.push(...blocks.edges);
-    }
-    if (features.image) {
-      const image = get(rxFromSignal(() => createImageUpload(features.image!)));
-      nodes.push(...image.nodes);
-      edges.push(...image.edges);
-    }
-    const editorToolbarGap = createGapSeparator();
-    nodes.push(...editorToolbarGap.nodes);
-    edges.push(...editorToolbarGap.edges);
-    if (customActions) {
-      const custom = get(customActions);
-      nodes.push(...custom.nodes);
-      edges.push(...custom.edges);
-    }
-    if (features.search ?? true) {
-      const search = get(rxFromSignal(() => createSearch(getView)));
-      nodes.push(...search.nodes);
-      edges.push(...search.edges);
-    }
-    if (features.viewMode) {
-      const viewMode = get(rxFromSignal(() => createViewMode(state, features.viewMode!)));
-      nodes.push(...viewMode.nodes);
-      edges.push(...viewMode.edges);
-    }
-    return { nodes, edges };
-  });
+// TODO(burdon): Enable toolbar variants (e.g., markdown, code).
+
+export type EditorToolbarFeatureFlags = Partial<{
+  showHeadings: boolean;
+  showFormatting: boolean;
+  showLists: boolean;
+  showBlocks: boolean;
+  showSearch: boolean;
+
+  // TODO(wittjosiah): Factor out (depends on plugin-level capabilities.)
+  onImageUpload: () => void;
+  onViewModeChange: (mode: EditorViewMode) => void;
+}>;
+
+export type EditorToolbarActionGraphProps = {
+  state: Atom.Atom<EditorToolbarState>;
+  getView: () => EditorView;
+  // TODO(wittjosiah): Control positioning.
+  customActions?: Atom.Atom<ActionGraphProps>;
 };
 
+export type EditorToolbarProps = ThemedClassName<
+  {
+    role?: string;
+    attendableId?: string;
+    /** Handler for executing actions. Required when customActions use Operation.invoke. */
+    onAction?: (action: MenuAction, params: Node.InvokeProps) => void;
+  } & (EditorToolbarActionGraphProps & EditorToolbarFeatureFlags)
+>;
+
+export const EditorToolbar = memo(({ classNames, role, attendableId, onAction, ...props }: EditorToolbarProps) => {
+  const menuActions = useMarkdownMenuActions(props);
+
+  return (
+    <ElevationProvider elevation={role === 'section' ? 'positioned' : 'base'}>
+      <Menu.Root {...menuActions} attendableId={attendableId} onAction={onAction}>
+        <Menu.Toolbar classNames={classNames} />
+      </Menu.Root>
+    </ElevationProvider>
+  );
+});
+
+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.
-const useEditorToolbarActionGraph = (props: EditorToolbarProps) => {
+const useMarkdownMenuActions = ({ state, getView, customActions, ...features }: ToolbarActionsProps) => {
   const menuCreator = useMemo(
-    () =>
-      createToolbar({
-        getView: props.getView,
-        state: props.state,
-        customActions: props.customActions,
-        headings: props.headings,
-        formatting: props.formatting,
-        lists: props.lists,
-        blocks: props.blocks,
-        image: props.image,
-        search: props.search,
-        viewMode: props.viewMode,
-      }),
+    () => createMarkdownActions({ state, getView, customActions, ...features }),
     [
-      props.getView,
-      props.state,
-      props.customActions,
-      props.headings,
-      props.formatting,
-      props.lists,
-      props.blocks,
-      props.image,
-      props.search,
-      props.viewMode,
+      state,
+      getView,
+      customActions,
+      features?.showHeadings,
+      features?.showFormatting,
+      features?.showLists,
+      features?.showBlocks,
+      features?.showSearch,
+      features?.onImageUpload,
+      features?.onViewModeChange,
     ],
   );
 
   return useMenuActions(menuCreator);
 };
 
-export const EditorToolbar = memo(({ classNames, attendableId, role, ...props }: EditorToolbarProps) => {
-  const menuProps = useEditorToolbarActionGraph(props);
-  return (
-    <ElevationProvider elevation={role === 'section' ? 'positioned' : 'base'}>
-      <MenuProvider {...menuProps} attendableId={attendableId}>
-        <ToolbarMenu classNames={classNames} textBlockWidth />
-      </MenuProvider>
-    </ElevationProvider>
-  );
-});
+const createMarkdownActions = ({
+  state,
+  getView,
+  customActions,
+  ...features
+}: ToolbarActionsProps): Atom.Atom<ActionGraphProps> => {
+  return Atom.make((get) => {
+    // Subscribe to state changes.
+    const stateSnapshot = get(state);
+    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,59 +4,64 @@
 
 import { type EditorView } from '@codemirror/view';
 
-import { type NodeArg } 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, type EditorToolbarState } from './util';
-import { removeBlockquote, addBlockquote, removeCodeblock, addCodeblock, insertTable } from '../../extensions';
+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,
-      () => {
-        const view = getView();
-        if (!view) {
-          return;
-        }
+const blockTypes = {
+  blockquote: 'ph--quotes--regular',
+  codeblock: 'ph--code-block--regular',
+  table: 'ph--table--regular',
+};
+
+/** 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;
+              }
 
-        switch (type) {
-          case 'blockquote':
-            checked ? removeBlockquote(view) : addBlockquote(view);
-            break;
-          case 'codeblock':
-            checked ? removeCodeblock(view) : addCodeblock(view);
-            break;
-          case 'table':
-            insertTable(view);
-            break;
+              switch (type) {
+                case 'blockquote':
+                  checked ? removeBlockquote(view) : addBlockquote(view);
+                  break;
+                case 'codeblock':
+                  checked ? removeCodeblock(view) : addCodeblock(view);
+                  break;
+                case 'table':
+                  insertTable(view);
+                  break;
+              }
+            },
+          );
         }
       },
-      { checked, ...(type === 'table' && { disabled: !!blankLine }), icon },
     );
-  });
-
-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 NodeArg<any>, ...blockActions],
-    edges: [
-      { source: 'root', target: 'block' },
-      ...blockActions.map(({ id }) => ({ source: blockGroupAction.id, target: id })),
-    ],
   };
-};

package/src/components/EditorToolbar/formatting.ts

@@ -4,11 +4,12 @@
 
 import { type EditorView } from '@codemirror/view';
 
-import { type NodeArg } 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, type EditorToolbarState } from './util';
-import { addLink, Inline, removeLink, setStyle, type Formatting } from '../../extensions';
+import { translationKey } from '#translations';
+
+import { type EditorToolbarState } from './types';
 
 const formats = {
   strong: 'ph--text-b--regular',
@@ -18,51 +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);
+/** 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;
+            }
 
-const createFormattingActions = (formatting: Formatting, getView: () => EditorView) =>
-  Object.entries(formats).map(([type, icon]) => {
-    const checked = !!formatting[type as keyof Formatting];
-    return createEditorAction(
-      type,
-      () => {
-        const view = getView();
-        if (!view) {
-          return;
-        }
+            if (type === 'link') {
+              checked ? removeLink(view) : addLink()(view);
+              return;
+            }
 
-        if (type === 'link') {
-          checked ? removeLink(view) : addLink()(view);
-          return;
+            setStyle(
+              type === 'strong'
+                ? Inline.Strong
+                : type === 'emphasis'
+                  ? Inline.Emphasis
+                  : type === 'strikethrough'
+                    ? Inline.Strikethrough
+                    : Inline.Code,
+              !checked,
+            )(view);
+          });
         }
-
-        const inlineType =
-          type === 'strong'
-            ? Inline.Strong
-            : type === 'emphasis'
-              ? Inline.Emphasis
-              : type === 'strikethrough'
-                ? Inline.Strikethrough
-                : Inline.Code;
-        setStyle(inlineType, !checked)(view);
       },
-      { checked, icon },
     );
-  });
-
-export const createFormatting = (state: EditorToolbarState, getView: () => EditorView) => {
-  const formattingGroupAction = createFormattingGroup(state);
-  const formattingActions = createFormattingActions(state, getView);
-  return {
-    nodes: [formattingGroupAction as NodeArg<any>, ...formattingActions],
-    edges: [
-      { source: 'root', target: 'formatting' },
-      ...formattingActions.map(({ id }) => ({ source: formattingGroupAction.id, target: id })),
-    ],
   };
-};

package/src/components/EditorToolbar/headings.ts

@@ -4,57 +4,59 @@
 
 import { type EditorView } from '@codemirror/view';
 
-import { type NodeArg } 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 { createEditorAction, createEditorActionGroup, type EditorToolbarState } from './util';
-import { setHeading } from '../../extensions';
-import { translationKey } from '../../translations';
+import { translationKey } from '#translations';
 
-const createHeadingGroupAction = (value: string) =>
-  createEditorActionGroup(
-    'heading',
-    {
-      variant: 'dropdownMenu',
-      applyActive: true,
-      selectCardinality: 'single',
-      value,
-    } as ToolbarMenuActionGroupProperties,
-    'ph--text-h--regular',
-  );
+import { type EditorToolbarState } from './types';
 
-const createHeadingActions = (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}`, () => setHeading(level)(getView()), {
-      label: ['heading level label', { count: level, ns: translationKey }],
-      icon,
-    });
-  });
+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';
-  const header = blockType && /heading(\d)/.exec(blockType);
-  return header ? header[1] : blockType === 'paragraph' || !blockType ? '0' : '';
+  const heading = blockType && /heading(\d)/.exec(blockType);
+  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(getView);
-  return {
-    nodes: [headingGroupAction as NodeArg<any>, ...headingActions],
-    edges: [
-      { source: 'root', target: 'heading' },
-      ...headingActions.map(({ id }) => ({ source: headingGroupAction.id, target: id })),
-    ],
+/** 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,15 +2,21 @@
 // Copyright 2025 DXOS.org
 //
 
-import { createEditorAction } from './util';
+import { type ActionGroupBuilderFn } from '@dxos/react-ui-menu';
 
-const createImageUploadAction = (onImageUpload: () => void) =>
-  createEditorAction('image', onImageUpload, {
-    testId: 'editor.toolbar.image',
-    icon: 'ph--image-square--regular',
-  });
+import { translationKey } from '#translations';
 
-export const createImageUpload = (onImageUpload: () => void) => ({
-  nodes: [createImageUploadAction(onImageUpload)],
-  edges: [{ source: 'root', target: 'image' }],
-});
+/** 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,11 +2,6 @@
 // Copyright 2024 DXOS.org
 //
 
+export * from './types';
+
 export * from './EditorToolbar';
-export {
-  type EditorToolbarState,
-  type EditorToolbarActionGraphProps,
-  useEditorToolbarState,
-  createEditorAction,
-  createEditorActionGroup,
-} from './util';