@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.11-main.1caa3af

package/src/components/TextEditor/MarkdownEditor.stories.tsx

@@ -0,0 +1,428 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { EditorView } from '@codemirror/view';
+import { faker } from '@faker-js/faker';
+import { ArrowSquareOut } from '@phosphor-icons/react';
+import defaultsDeep from 'lodash.defaultsdeep';
+import React, { type FC, StrictMode, useRef, useState } from 'react';
+import { createRoot } from 'react-dom/client';
+
+import { TextObject } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { fixedInsetFlexLayout, getSize, groupSurface, mx } from '@dxos/react-ui-theme';
+import { withTheme } from '@dxos/storybook-utils';
+
+import { MarkdownEditor, type TextEditorProps, type TextEditorRef } from './TextEditor';
+import {
+  autocomplete,
+  blast,
+  code,
+  comments,
+  defaultOptions,
+  hr,
+  image,
+  listener,
+  link,
+  mention,
+  table,
+  tasklist,
+  tooltip,
+  typewriter,
+  type CommentsOptions,
+  type TooltipOptions,
+  type LinkOptions,
+  mermaid,
+} from './extensions';
+import { type CommentRange, useTextModel } from '../../hooks';
+
+// Extensions:
+// TODO(burdon): Table of contents.
+// TODO(burdon): Front-matter
+
+faker.seed(101);
+
+const str = (...lines: string[]) => lines.join('\n');
+
+const num = () => faker.number.int({ min: 0, max: 9999 }).toLocaleString();
+
+// prettier-ignore
+const text = {
+  tasks: str(
+    '## Tasks',
+    '',
+    '- [x] decorator',
+    '- [ ] checkbox',
+    '  - [ ] state',
+    '  - [ ] indent',
+    '  - [x] style',
+    '',
+  ),
+
+  list: str(
+    '## List',
+    '',
+    '- new york',
+    '- london',
+    '- tokyo',
+    '',
+  ),
+
+  numbered: str(
+    '## Numbered',
+    '',
+    '1. one',
+    '2. two',
+    '3. three',
+    ''
+  ),
+
+  code: str(
+    '## Code',
+    '',
+    '```',
+    'const x = 100;',
+    '```',
+    '',
+    '```tsx',
+    'const Component = () => {',
+    '  const x = 100;',
+    '',
+    '  return () => <div>Test</div>;',
+    '};',
+    '```',
+    '',
+  ),
+
+  links: str(
+    '## Links',
+    '',
+    'This is a naked link https://dxos.org within a sentence.',
+    '',
+    'Take a look at [DXOS](https://dxos.org) and how to [get started](https://docs.dxos.org/guide/getting-started.html).',
+    '',
+  ),
+
+  table: str(
+    '# Table',
+    '',
+    `| ${faker.lorem.word().padStart(12)} | ${faker.lorem.word().padStart(12)} | ${faker.lorem.word().padStart(12)} |`,
+    `|-${''.padStart(12, '-')}-|-${''.padStart(12, '-')}-|-${''.padStart(12, '-')}-|`,
+    `| ${num().padStart(12)} | ${num().padStart(12)} | ${num().padStart(12)} |`,
+    `| ${num().padStart(12)} | ${num().padStart(12)} | ${num().padStart(12)} |`,
+    `| ${num().padStart(12)} | ${num().padStart(12)} | ${num().padStart(12)} |`,
+    '', // TODO(burdon): Possible GFM parsing bug if no newline?
+  ),
+
+  image: str('# Image', '', '![dxos](https://pbs.twimg.com/profile_banners/1268328127673044992/1684766689/1500x500)'),
+
+  headings: str(
+    ...[1, 2, 3, 4, 5, 6].map((level) => ['#'.repeat(level) + ` Heading ${level}`, faker.lorem.sentences(), '']).flat(),
+  ),
+
+  paragraphs: str(...faker.helpers.multiple(() => [faker.lorem.paragraph(), ''], { count: 3 }).flat()),
+
+  mermaid: str('```mermaid', 'graph TD;', 'A-->B;', 'A-->C;', 'B-->D;', 'C-->D;', '```'),
+
+  footer: str('', '', '', '', '')
+};
+
+const document = str(
+  '# Markdown',
+  '',
+  '> This is a block quote.',
+  '',
+  'This is all about https://dxos.org and related technologies.',
+  '',
+  'This this is **bold**, ~~strikethrough~~, _italic_, and `f(INLINE)`.',
+  '',
+  '---',
+  text.links,
+  '---',
+  text.list,
+  '---',
+  text.tasks,
+  '---',
+  text.numbered,
+  '---',
+  text.code,
+  '---',
+  text.headings,
+  '---',
+  text.table,
+  '---',
+  text.image,
+  text.footer,
+);
+
+const links = [
+  { label: 'DXOS', apply: '[DXOS](https://dxos.org)' },
+  { label: 'GitHub', apply: '[DXOS GitHub](https://github.com/dxos)' },
+  { label: 'Automerge', apply: '[Automerge](https://automerge.org/)' },
+  { label: 'IPFS', apply: '[Protocol Labs](https://docs.ipfs.tech)' },
+  { label: 'StackEdit', apply: '[StackEdit](https://stackedit.io/app)' },
+];
+
+const hover =
+  'rounded-sm text-base text-primary-600 hover:text-primary-500 dark:text-primary-300 hover:dark:text-primary-200';
+
+const onTooltipHover: TooltipOptions['onHover'] = (el, url) => {
+  const web = new URL(url);
+  createRoot(el).render(
+    <StrictMode>
+      <a href={url} target='_blank' rel='noreferrer' className={hover}>
+        {web.origin}
+        <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1')} />
+      </a>
+    </StrictMode>,
+  );
+};
+
+const Key: FC<{ char: string }> = ({ char }) => (
+  <span className='flex justify-center items-center w-[24px] h-[24px] rounded text-xs bg-neutral-200 text-black'>
+    {char}
+  </span>
+);
+
+const onCommentsHover: CommentsOptions['onHover'] = (el) => {
+  createRoot(el).render(
+    <StrictMode>
+      <div className='flex items-center gap-2 px-2 py-2 bg-neutral-700 text-white text-xs rounded'>
+        <div>Create comment</div>
+        {/* TODO(burdon): Unify shortcuts. */}
+        <div className='flex gap-1'>
+          <Key char='⌘' />
+          <Key char="'" />
+        </div>
+      </div>
+    </StrictMode>,
+  );
+};
+
+const onLinkRender: LinkOptions['onRender'] = (el, url) => {
+  createRoot(el).render(
+    <StrictMode>
+      <a href={url} target='_blank' rel='noreferrer' className={hover}>
+        <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1 mb-1')} />
+      </a>
+    </StrictMode>,
+  );
+};
+
+type StoryProps = {
+  text?: string;
+  automerge?: boolean;
+} & Pick<TextEditorProps, 'comments' | 'readonly' | 'extensions' | 'slots'>;
+
+const Story = ({ text, automerge, ...props }: StoryProps) => {
+  const ref = useRef<TextEditorRef>(null);
+  const [item] = useState({ text: new TextObject(text, undefined, undefined, { automerge }) });
+  const model = useTextModel({ text: item.text });
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div className={mx(fixedInsetFlexLayout, groupSurface)}>
+      <div className='flex justify-center overflow-y-scroll'>
+        <div className='flex flex-col w-[800px] py-16'>
+          <MarkdownEditor ref={ref} model={model} {...props} />
+          <div className='flex shrink-0 h-[300px]'></div>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/MarkdownEditor',
+  component: MarkdownEditor,
+  decorators: [withTheme],
+  render: Story,
+};
+
+const extensions = [
+  autocomplete({
+    onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
+  }),
+  code(),
+  hr(),
+  image(),
+  link({ onRender: onLinkRender }),
+  table(),
+  tasklist(),
+  tooltip({ onHover: onTooltipHover }),
+];
+
+export const Default = {
+  render: () => <Story text={document} extensions={extensions} />,
+};
+
+export const Readonly = {
+  render: () => <Story text={document} extensions={extensions} readonly />,
+};
+
+export const NoExtensions = {
+  render: () => <Story text={document} />,
+};
+
+// TODO(burdon): Cursor bug if no newline after BR (cursor down just loops back to start of each paragraph).
+export const HorizontalRule = {
+  render: () => (
+    <Story
+      text={str('# Horizontal Rule', '', text.paragraphs, '---', '', text.paragraphs, '---', '', text.paragraphs)}
+      extensions={[hr()]}
+    />
+  ),
+};
+
+export const Tooltips = {
+  render: () => <Story text={str(text.links, text.footer)} extensions={[tooltip({ onHover: onTooltipHover })]} />,
+};
+
+export const Links = {
+  render: () => <Story text={str(text.links, text.footer)} extensions={[link({ onRender: onLinkRender })]} />,
+};
+
+export const Code = {
+  render: () => <Story text={str(text.code, text.footer)} extensions={[code()]} readonly />,
+};
+
+export const Table = {
+  render: () => <Story text={str(text.table, text.footer)} extensions={[table()]} />,
+};
+
+export const Image = {
+  render: () => <Story text={str(text.image, text.footer)} readonly extensions={[image()]} />,
+};
+
+export const Tasklist = {
+  render: () => (
+    <Story
+      text={str(text.tasks, '', text.list, text.footer)}
+      extensions={[
+        tasklist(),
+        listener({
+          onChange: (text) => {
+            console.log(text);
+          },
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Autocomplete = {
+  render: () => (
+    <Story
+      text={str('# Autocomplete', '', 'Press CTRL-SPACE', text.footer)}
+      extensions={[
+        link({ onRender: onLinkRender }),
+        autocomplete({
+          onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
+        }),
+      ]}
+    />
+  ),
+};
+
+const names = ['adam', 'alice', 'alison', 'bob', 'carol', 'charlie', 'sayuri', 'shoko'];
+
+export const Mention = {
+  render: () => (
+    <Story
+      text={str('# Mention', '', 'Type @...', text.footer)}
+      extensions={[
+        mention({
+          onSearch: (text) => names.filter((name) => name.toLowerCase().startsWith(text.toLowerCase())),
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Mermaid = {
+  render: () => <Story text={str('# Mermaid', '', text.mermaid, text.footer)} extensions={[code(), mermaid()]} />,
+};
+
+export const Comments = {
+  render: () => {
+    const [commentsStates, setCommentStates] = useState<CommentRange[]>([]);
+
+    return (
+      <Story
+        text={str('# Comments', '', text.paragraphs, text.footer)}
+        comments={commentsStates}
+        extensions={[
+          comments({
+            onHover: onCommentsHover,
+            onCreate: (relPos) => {
+              const id = PublicKey.random().toHex();
+              setCommentStates((comments) => [...comments, { id, cursor: relPos }]);
+              return id;
+            },
+            onSelect: (state) => {
+              const debug = false;
+              if (debug) {
+                console.log(
+                  'update',
+                  JSON.stringify({
+                    active: state.active?.slice(0, 8),
+                    closest: state.closest?.slice(0, 8),
+                    ranges: state.ranges.length,
+                  }),
+                );
+              }
+            },
+          }),
+        ]}
+      />
+    );
+  },
+};
+
+export const Typewriter = {
+  render: () => <Story text={str('# Typewriter', '', text.paragraphs, text.footer)} extensions={[typewriter()]} />,
+};
+
+export const Blast = {
+  render: () => (
+    <Story
+      text={str('# Blast', '', text.paragraphs, text.code, text.paragraphs)}
+      extensions={[
+        typewriter({
+          items: localStorage.getItem('dxos.composer.extension.demo')?.split(','),
+        }),
+        blast(
+          defaultsDeep(
+            {
+              effect: 2,
+              particleGravity: 0.2,
+              particleShrinkRate: 0.995,
+              color: () => [faker.number.int({ min: 100, max: 200 }), 0, 0],
+              // color: () => [faker.number.int(256), faker.number.int(256), faker.number.int(256)],
+            },
+            defaultOptions,
+          ),
+        ),
+      ]}
+    />
+  ),
+};
+
+export const Diagnostics = {
+  render: () => (
+    <Story
+      text={document}
+      extensions={[
+        // Cursor moved.
+        EditorView.updateListener.of((update) => {
+          console.log('update', update.view.state.selection.main.head);
+        }),
+      ]}
+    />
+  ),
+};

package/src/components/TextEditor/TextEditor.stories.tsx

@@ -3,63 +3,46 @@
 //
 
 import '@dxosTheme';
-import { markdown } from '@codemirror/lang-markdown';
-import { ArrowCircleUp } from '@phosphor-icons/react';
-import React, { StrictMode, useState } from 'react';
-import { createRoot } from 'react-dom/client';
+
+import defaultsDeep from 'lodash.defaultsdeep';
+import React, { useRef, useState } from 'react';
 
 import { TextObject } from '@dxos/echo-schema';
-import { fixedInsetFlexLayout, getSize, groupSurface, inputSurface, mx } from '@dxos/react-ui-theme';
+import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { TextEditor } from './TextEditor';
-import { createHyperlinkTooltip, hyperlinkDecoration } from './extensions';
+import { defaultSlots, TextEditor, type TextEditorProps, type TextEditorRef, type TextEditorSlots } from './TextEditor';
+import { textTheme } from './themes';
 import { useTextModel } from '../../hooks';
 
-const text = [
-  '',
-  '',
-  'This is all about [DXOS](https://dxos.org); read more [here](https://docs.dxos.org/guide/getting-started.html).',
+const initialText = [
+  '# TextEditor',
   '',
+  'This is the basic plain text editor within minimal formatting.',
+  'You can add custom styles and create custom extensions.',
+  'Or use the MarkdownEditor to edit documents.',
   '',
+  'https://dxos.org',
 ].join('\n');
 
-const hyperLinkTooltip = () =>
-  createHyperlinkTooltip((el, url) => {
-    const web = new URL(url);
-    createRoot(el).render(
-      <StrictMode>
-        <div className='flex gap-1 items-center'>
-          <ArrowCircleUp className={mx(getSize(6), 'text-blue-500')} />
-          <p className='pr-1'>{web.origin}</p>
-        </div>
-      </StrictMode>,
-    );
-  });
-
-const Story = ({ automerge }: { automerge?: boolean }) => {
-  const [item] = useState({ text: new TextObject(text, undefined, undefined, { useAutomergeBackend: !!automerge }) });
+const Story = ({
+  text,
+  automerge,
+  ...props
+}: { text?: string; automerge?: boolean } & Pick<TextEditorProps, 'extensions' | 'slots'>) => {
+  const ref = useRef<TextEditorRef>(null);
+  const [item] = useState({ text: new TextObject(text, undefined, undefined, { automerge }) });
   const model = useTextModel({ text: item.text });
   if (!model) {
-    return <></>;
+    return null;
   }
 
   return (
     <div className={mx(fixedInsetFlexLayout, groupSurface)}>
-      <div className='flex justify-center p-8'>
-        <div className='w-[800px]'>
-          <TextEditor
-            model={model}
-            extensions={[
-              markdown(),
-              hyperlinkDecoration({ link: false }),
-              hyperLinkTooltip(),
-              // EditorView.domEventHandlers({
-              //   mousedown: (e, view) => {},
-              // }),
-            ]}
-            slots={{ root: { className: mx(inputSurface, 'p-2') } }}
-          />
+      <div className='flex justify-center overflow-y-scroll'>
+        <div className='flex flex-col w-[800px] py-16'>
+          <TextEditor ref={ref} model={model} {...props} />
+          <div className='flex shrink-0 h-[300px]'></div>
         </div>
       </div>
     </div>
@@ -67,13 +50,44 @@ const Story = ({ automerge }: { automerge?: boolean }) => {
 };
 
 export default {
+  title: 'react-ui-editor/TextEditor',
   component: TextEditor,
   decorators: [withTheme],
   render: Story,
 };
 
-export const Default = {};
+export const Default = {
+  render: () => (
+    <Story
+      slots={defaultsDeep(
+        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
+        defaultSlots,
+      )}
+    />
+  ),
+};
+
+export const Text = {
+  render: () => (
+    <Story
+      text={initialText}
+      slots={defaultsDeep(
+        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
+        defaultSlots,
+      )}
+    />
+  ),
+};
 
 export const Automerge = {
-  render: () => <Story automerge />,
+  render: () => (
+    <Story
+      automerge
+      text={initialText}
+      slots={defaultsDeep(
+        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
+        defaultSlots,
+      )}
+    />
+  ),
 };