@dxos/react-ui-editor 0.8.3-staging.0fa589b → 0.8.4-main.1068cf700f

package/src/stories/Theme.stories.tsx

@@ -0,0 +1,61 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+
+import { useThemeContext } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { createBasicExtensions, createThemeExtensions } from '@dxos/ui-editor';
+
+import { Editor } from '../components';
+
+const createText = (monospace?: boolean) =>
+  [`${monospace ? 'monospace' : 'body'}`, 'Hello world', '0123456789'].join('\n');
+
+const DefaultStory = () => {
+  const { themeMode } = useThemeContext();
+  const [ext1, ext2] = useMemo(
+    () => [
+      //
+      [
+        createBasicExtensions({ placeholder: 'Enter text', search: true }),
+        createThemeExtensions({ themeMode, monospace: false }),
+      ],
+      [
+        createBasicExtensions({ placeholder: 'Enter text', search: true }),
+        createThemeExtensions({ themeMode, monospace: true }),
+      ],
+    ],
+    [],
+  );
+
+  return (
+    <div className='is-full grid grid-cols-2 gap-2'>
+      <Editor.Root>
+        <Editor.Content classNames='p-2' extensions={ext1} initialValue={createText(false)} />
+      </Editor.Root>
+      <Editor.Root>
+        <Editor.Content classNames='p-2' extensions={ext2} initialValue={createText(true)} />
+      </Editor.Root>
+    </div>
+  );
+};
+
+const meta: Meta<typeof DefaultStory> = {
+  title: 'ui/react-ui-editor/Theme',
+  component: DefaultStory,
+  decorators: [withTheme(), withLayout()],
+  parameters: {
+    layout: 'fullscreen',
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};

package/src/stories/components/EditorStory.tsx

@@ -3,68 +3,72 @@
 //
 
 import { type EditorView } from '@codemirror/view';
-import React, { type ReactNode, forwardRef, useEffect, useState, useImperativeHandle, useMemo } from 'react';
+import React, { type ReactNode, forwardRef, useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
 
-import { Expando } from '@dxos/echo-schema';
+import { Obj } from '@dxos/echo';
+import { TestSchema } from '@dxos/echo/testing';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
-import { live } from '@dxos/live-object';
-import { createDocAccessor, createObject } from '@dxos/react-client/echo';
-import { useForwardedRef, useThemeContext } from '@dxos/react-ui';
+import { log } from '@dxos/log';
+import { useMergeRefs, useThemeContext } from '@dxos/react-ui';
 import { useAttentionAttributes } from '@dxos/react-ui-attention';
 import { JsonFilter } from '@dxos/react-ui-syntax-highlighter';
-import { mx } from '@dxos/react-ui-theme';
-import { isNonNullable } from '@dxos/util';
-
-import { editorSlots, editorGutter } from '../../defaults';
 import {
   type DebugNode,
   type ThemeExtensionsOptions,
-  createDataExtensions,
   createBasicExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   debugTree,
-} from '../../extensions';
-import { useTextEditor, type UseTextEditorProps } from '../../hooks';
+  decorateMarkdown,
+  editorSlots,
+} from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
+import { isNonNullable } from '@dxos/util';
+
+import { type EditorController, createEditorController } from '../../components';
+import { type UseTextEditorProps, useTextEditor } from '../../hooks';
 
 // Type definitions.
 export type DebugMode = 'raw' | 'tree' | 'raw+tree';
 
 const defaultId = 'editor-' + PublicKey.random().toHex().slice(0, 8);
 
-export type StoryProps = Pick<UseTextEditorProps, 'scrollTo' | 'selection' | 'extensions'> &
+export type StoryProps = Pick<UseTextEditorProps, 'id' | 'scrollTo' | 'selection' | 'extensions'> &
   Pick<ThemeExtensionsOptions, 'slots'> & {
-    id?: string;
     debug?: DebugMode;
     debugCustom?: (view: EditorView) => ReactNode;
     text?: string;
-    object?: Expando;
+    object?: Obj.Obj<TestSchema.Expando>;
     readOnly?: boolean;
     placeholder?: string;
     lineNumbers?: boolean;
+    monospace?: boolean;
     onReady?: (view: EditorView) => void;
   };
 
-export const EditorStory = forwardRef<EditorView | undefined, StoryProps>(
-  ({ debug, debugCustom, text, extensions: _extensions, ...props }, forwardedRef) => {
-    const attentionAttrs = useAttentionAttributes('testing');
+export const EditorStory = forwardRef<EditorController, StoryProps>(
+  ({ debug, debugCustom, text, extensions: extensionsProp, ...props }, forwardedRef) => {
+    const controllerRef = useRef<EditorController>(null);
+    const mergedRef = useMergeRefs([controllerRef, forwardedRef]);
+
+    const attentionAttrs = useAttentionAttributes('test-panel');
     const [tree, setTree] = useState<DebugNode>();
-    const [object] = useState(createObject(live(Expando, { content: text ?? '' })));
-    const viewRef = useForwardedRef(forwardedRef);
-    const view = viewRef.current;
+    const [object] = useState(Obj.make(TestSchema.Expando, { content: text ?? '' }));
+
     const extensions = useMemo(
-      () => (debug ? [_extensions, debugTree(setTree)].filter(isNonNullable) : _extensions),
-      [debug, _extensions],
+      () => (debug ? [extensionsProp, debugTree(setTree)].filter(isNonNullable) : extensionsProp),
+      [debug, extensionsProp],
     );
 
+    const view = controllerRef.current?.view;
     return (
-      <div className={mx('w-full h-full grid overflow-hidden', debug && 'grid-cols-2 lg:grid-cols-[1fr_600px]')}>
-        <EditorComponent ref={viewRef} object={object} text={text} extensions={extensions} {...props} />
+      <div className={mx('is-full bs-full grid overflow-hidden', debug && 'grid-cols-2 lg:grid-cols-[1fr_600px]')}>
+        <EditorComponent ref={mergedRef} object={object} text={text} extensions={extensions} {...props} />
 
         {debug && (
           <div
-            className='grid h-full auto-rows-fr border-l border-separator divide-y divide-separator overflow-hidden'
+            className='grid bs-full auto-rows-fr border-l border-separator divide-y divide-separator overflow-hidden'
             {...attentionAttrs}
           >
             {view && debugCustom?.(view)}
@@ -84,7 +88,7 @@ export const EditorStory = forwardRef<EditorView | undefined, StoryProps>(
 /**
  * Default story component.
  */
-export const EditorComponent = forwardRef<EditorView | undefined, StoryProps>(
+const EditorComponent = forwardRef<EditorController, StoryProps>(
   (
     {
       id = defaultId,
@@ -93,6 +97,7 @@ export const EditorComponent = forwardRef<EditorView | undefined, StoryProps>(
       readOnly,
       placeholder = 'New document.',
       lineNumbers,
+      monospace,
       scrollTo,
       selection,
       extensions,
@@ -111,18 +116,21 @@ export const EditorComponent = forwardRef<EditorView | undefined, StoryProps>(
         selection,
         initialValue: text,
         extensions: [
-          createDataExtensions({ id, text: createDocAccessor(object, ['content']) }),
-          createBasicExtensions({ readOnly, placeholder, lineNumbers, scrollPastEnd: true }),
-          createMarkdownExtensions({ themeMode }),
-          createThemeExtensions({ themeMode, syntaxHighlighting: true, slots }),
-          editorGutter,
+          createBasicExtensions({ readOnly, placeholder, lineNumbers, scrollPastEnd: true, search: true }),
+          createThemeExtensions({ monospace, themeMode, syntaxHighlighting: true, slots }),
+          createMarkdownExtensions(),
+          decorateMarkdown(),
           extensions || [],
         ],
       }),
       [id, object, extensions, themeMode],
     );
 
-    useImperativeHandle(forwardedRef, () => view, [view]);
+    // External controller.
+    useImperativeHandle(forwardedRef, () => {
+      log.info('view updated', { id });
+      return createEditorController(view);
+    }, [id, view]);
 
     useEffect(() => {
       if (view) {

package/src/stories/components/util.tsx

@@ -8,8 +8,6 @@ import React, { type FC } from 'react';
 
 import { faker } from '@dxos/random';
 import { Icon } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
-
 import {
   type EditorSelectionState,
   decorateMarkdown,
@@ -18,15 +16,17 @@ import {
   image,
   linkTooltip,
   table,
-} from '../../extensions';
-import { str } from '../../testing';
-import { createRenderer } from '../../util';
+} from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
+
+import { createRenderer, str } from '../../util';
 
 export const num = () => faker.number.int({ min: 0, max: 9999 }).toLocaleString();
 
 export const img = '![dxos](https://dxos.network/dxos-logotype-blue.png)';
 
 export const code = str(
+  // prettier-ignore
   '// Code',
   'const Component = () => {',
   '  const x = 100;',
@@ -38,7 +38,7 @@ export const code = str(
 // Content blocks for stories
 export const content = {
   tasks: str(
-    //
+    // prettier-ignore
     '### TaskList',
     '',
     `- [x] ${faker.lorem.sentences()}`,
@@ -50,7 +50,7 @@ export const content = {
   ),
 
   bullets: str(
-    //
+    // prettier-ignore
     '### BulletList',
     '',
     `- ${faker.lorem.sentences()}`,
@@ -62,7 +62,7 @@ export const content = {
   ),
 
   numbered: str(
-    //
+    // prettier-ignore
     '### OrderedList (part 1)',
     '',
     `1. ${faker.lorem.sentences()}`,
@@ -81,11 +81,34 @@ export const content = {
 
   typescript: code,
 
-  codeblocks: str('### Code', '', '```bash', '$ ls -las', '```', '', '```tsx', code, '```', ''),
+  codeblocks: str(
+    // prettier-ignore
+    '### Code',
+    '',
+    '```bash',
+    '$ ls -las',
+    '```',
+    '',
+    '```tsx',
+    code,
+    '```',
+    '',
+  ),
 
-  comment: str('<!--', 'A comment', '-->', '', 'No comment.', 'Partial comment. <!-- comment. -->'),
+  comment: str(
+    // prettier-ignore
+    '### Comment',
+    '',
+    '<!--',
+    'A comment',
+    '-->',
+    '',
+    'Partial comment. <!-- comment. -->',
+    '',
+  ),
 
   links: str(
+    // prettier-ignore
     '### Links',
     '',
     'This is a naked link https://dxos.org within a sentence.',
@@ -97,6 +120,7 @@ export const content = {
   ),
 
   table: str(
+    // prettier-ignore
     '### Tables',
     '',
     `| ${faker.lorem.word().padStart(12)} | ${faker.lorem.word().padStart(12)} | ${faker.lorem.word().padStart(12)} |`,
@@ -113,9 +137,16 @@ export const content = {
     ...[1, 2, 3, 4, 5, 6].map((level) => ['#'.repeat(level) + ` Heading ${level}`, faker.lorem.sentences(), '']).flat(),
   ),
 
-  formatting: str('### Formatting', '', 'This this is **bold**, ~~strikethrough~~, _italic_, and `f(INLINE)`.', ''),
+  formatting: str(
+    // prettier-ignore
+    '### Formatting',
+    '',
+    'This this is **bold**, ~~strikethrough~~, _italic_, and `f(INLINE)`.',
+    '',
+  ),
 
   blockquotes: str(
+    // prettier-ignore
     '### Blockquotes',
     '',
     '> This is a block quote.',
@@ -154,6 +185,7 @@ export const text = str(
   '---',
   '## Misc',
   content.codeblocks,
+  content.comment,
   content.table,
   content.image,
   content.footer,

package/src/translations.ts

@@ -2,9 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
-export const translationKey = 'react-ui-editor';
+import { type Resource } from '@dxos/react-ui';
 
-export default [
+export const translationKey = '@dxos/react-ui-editor';
+
+export const translations = [
   {
     'en-US': {
       [translationKey]: {
@@ -22,17 +24,17 @@ export default [
         'selection overlaps existing comment label': 'Selection overlaps existing comment',
         'select text to comment label': 'Select text to comment',
         'image label': 'Insert image',
-        'heading label': 'Heading level',
         'table label': 'Create table',
+        'heading label': 'Heading level',
         'heading level label_zero': 'Paragraph',
         'heading level label_one': 'Heading level {{count}}',
         'heading level label_other': 'Heading level {{count}}',
+        'search label': 'Search',
         'view mode label': 'Editor view',
-        'preview mode label': 'Live preview',
+        'preview mode label': 'Markdown',
         'readonly mode label': 'Read only',
-        'search label': 'Search',
-        'source mode label': 'Source',
+        'source mode label': 'Plain text',
       },
     },
   },
-];
+] as const satisfies Resource[];

package/src/util/index.ts

@@ -1,9 +1,5 @@
 //
-// Copyright 2024 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-export * from './cursor';
-export * from './debug';
-export * from './dom';
-export * from './facet';
 export * from './react';

package/src/util/react.tsx

@@ -6,9 +6,13 @@ import React, { type FC, type ReactNode } from 'react';
 import { createRoot } from 'react-dom/client';
 
 import { ThemeProvider, Tooltip } from '@dxos/react-ui';
-import { defaultTx } from '@dxos/react-ui-theme';
+import { type RenderCallback } from '@dxos/ui-editor';
+import { defaultTx } from '@dxos/ui-theme';
 
-import { type RenderCallback } from '../types';
+/**
+ * @deprecated Use `trim` from `@dxos/util`.
+ */
+export const str = (...lines: string[]) => lines.join('\n');
 
 /** @deprecated */
 // TODO(wittjosiah): Replace with portals which are lighter weight and inherit context from the main react tree.
@@ -22,7 +26,7 @@ export const renderRoot = <T extends Element>(root: T, node: ReactNode): T => {
  * @deprecated
  */
 export const createRenderer =
-  <Props extends object>(Component: FC<Props>): RenderCallback<Props> =>
+  <TProps extends object>(Component: FC<TProps>): RenderCallback<TProps> =>
   (el, props) => {
     renderRoot(
       el,

package/dist/lib/browser/testing/index.mjs

@@ -1,6 +0,0 @@
-// packages/ui/react-ui-editor/src/testing/util.ts
-var str = (...lines) => lines.join("\n");
-export {
-  str
-};
-//# sourceMappingURL=index.mjs.map

package/dist/lib/browser/testing/index.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../../src/testing/util.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nexport const str = (...lines: string[]) => lines.join('\\n');\n"],
-  "mappings": ";AAIO,IAAMA,MAAM,IAAIC,UAAoBA,MAAMC,KAAK,IAAA;",
-  "names": ["str", "lines", "join"]
-}