@dxos/react-ui-editor 0.3.11-main.674a7f9 → 0.3.11-main.6901f09

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/dist/lib/browser/index.mjs +1994 -433
  2. package/dist/lib/browser/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts +1 -2
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts.map +1 -1
  7. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts +1 -1
  8. package/dist/types/src/components/TextEditor/automerge.stories.d.ts.map +1 -1
  9. package/dist/types/src/components/TextEditor/{comments.stories.d.ts → hooks.stories.d.ts} +9 -12
  10. package/dist/types/src/components/TextEditor/hooks.stories.d.ts.map +1 -0
  11. package/dist/types/src/components/Toolbar/Toolbar.d.ts +29 -0
  12. package/dist/types/src/components/Toolbar/Toolbar.d.ts.map +1 -0
  13. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts +25 -0
  14. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts.map +1 -0
  15. package/dist/types/src/components/Toolbar/index.d.ts +2 -0
  16. package/dist/types/src/components/Toolbar/index.d.ts.map +1 -0
  17. package/dist/types/src/components/index.d.ts +1 -0
  18. package/dist/types/src/components/index.d.ts.map +1 -1
  19. package/dist/types/src/extensions/automerge/automerge.d.ts.map +1 -1
  20. package/dist/types/src/extensions/automerge/automerge.spec.d.ts +2 -0
  21. package/dist/types/src/extensions/automerge/automerge.spec.d.ts.map +1 -0
  22. package/dist/types/src/extensions/automerge/automerge.test.d.ts +2 -0
  23. package/dist/types/src/extensions/automerge/automerge.test.d.ts.map +1 -0
  24. package/dist/types/src/extensions/automerge/defs.d.ts +5 -5
  25. package/dist/types/src/extensions/automerge/defs.d.ts.map +1 -1
  26. package/dist/types/src/extensions/automerge/semaphore.d.ts +2 -1
  27. package/dist/types/src/extensions/automerge/semaphore.d.ts.map +1 -1
  28. package/dist/types/src/extensions/automerge/update-automerge.d.ts.map +1 -1
  29. package/dist/types/src/extensions/awareness.d.ts +1 -1
  30. package/dist/types/src/extensions/basic.d.ts +1 -1
  31. package/dist/types/src/extensions/basic.d.ts.map +1 -1
  32. package/dist/types/src/extensions/comments.d.ts +11 -3
  33. package/dist/types/src/extensions/comments.d.ts.map +1 -1
  34. package/dist/types/src/extensions/markdown/bundle.d.ts +2 -2
  35. package/dist/types/src/extensions/markdown/bundle.d.ts.map +1 -1
  36. package/dist/types/src/extensions/markdown/code.d.ts.map +1 -1
  37. package/dist/types/src/extensions/markdown/formatting.d.ts +57 -0
  38. package/dist/types/src/extensions/markdown/formatting.d.ts.map +1 -0
  39. package/dist/types/src/extensions/markdown/formatting.test.d.ts +3 -0
  40. package/dist/types/src/extensions/markdown/formatting.test.d.ts.map +1 -0
  41. package/dist/types/src/extensions/markdown/heading.d.ts.map +1 -1
  42. package/dist/types/src/extensions/markdown/highlight.d.ts.map +1 -1
  43. package/dist/types/src/extensions/markdown/hr.d.ts.map +1 -1
  44. package/dist/types/src/extensions/markdown/index.d.ts +1 -0
  45. package/dist/types/src/extensions/markdown/index.d.ts.map +1 -1
  46. package/dist/types/src/extensions/markdown/link.d.ts.map +1 -1
  47. package/dist/types/src/extensions/markdown/tasklist.d.ts.map +1 -1
  48. package/dist/types/src/hooks/index.d.ts +2 -0
  49. package/dist/types/src/hooks/index.d.ts.map +1 -1
  50. package/dist/types/src/hooks/useActionHandler.d.ts +4 -0
  51. package/dist/types/src/hooks/useActionHandler.d.ts.map +1 -0
  52. package/dist/types/src/hooks/useEditorView.d.ts +17 -0
  53. package/dist/types/src/hooks/useEditorView.d.ts.map +1 -0
  54. package/dist/types/src/hooks/useTextEditor.d.ts +36 -14
  55. package/dist/types/src/hooks/useTextEditor.d.ts.map +1 -1
  56. package/dist/types/src/hooks/useTextModel.d.ts +12 -0
  57. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  58. package/dist/types/src/index.d.ts +1 -1
  59. package/dist/types/src/index.d.ts.map +1 -1
  60. package/dist/types/src/styles/markdown.d.ts +2 -2
  61. package/dist/types/src/styles/markdown.d.ts.map +1 -1
  62. package/dist/types/src/themes/default.d.ts.map +1 -1
  63. package/package.json +40 -27
  64. package/src/components/TextEditor/MarkdownEditor.stories.tsx +15 -21
  65. package/src/components/TextEditor/TextEditor.tsx +27 -16
  66. package/src/components/TextEditor/automerge.stories.tsx +1 -2
  67. package/src/components/TextEditor/hooks.stories.tsx +111 -0
  68. package/src/components/Toolbar/Toolbar.stories.tsx +102 -0
  69. package/src/components/Toolbar/Toolbar.tsx +245 -0
  70. package/src/components/Toolbar/index.ts +5 -0
  71. package/src/components/index.ts +1 -0
  72. package/src/extensions/automerge/automerge.spec.tsx +76 -0
  73. package/src/extensions/automerge/automerge.test.ts +13 -0
  74. package/src/extensions/automerge/automerge.ts +26 -11
  75. package/src/extensions/automerge/cursor.ts +3 -3
  76. package/src/extensions/automerge/defs.ts +9 -9
  77. package/src/extensions/automerge/semaphore.ts +17 -19
  78. package/src/extensions/automerge/update-automerge.ts +12 -6
  79. package/src/extensions/automerge/update-codemirror.ts +5 -5
  80. package/src/extensions/awareness.ts +7 -4
  81. package/src/extensions/basic.ts +15 -13
  82. package/src/extensions/blast.ts +4 -1
  83. package/src/extensions/comments.ts +126 -68
  84. package/src/extensions/markdown/bundle.ts +9 -8
  85. package/src/extensions/markdown/code.ts +95 -49
  86. package/src/extensions/markdown/formatting.test.ts +481 -0
  87. package/src/extensions/markdown/formatting.ts +1198 -0
  88. package/src/extensions/markdown/heading.ts +5 -6
  89. package/src/extensions/markdown/highlight.ts +9 -15
  90. package/src/extensions/markdown/hr.ts +2 -3
  91. package/src/extensions/markdown/index.ts +1 -0
  92. package/src/extensions/markdown/link.ts +13 -4
  93. package/src/extensions/markdown/tasklist.ts +1 -2
  94. package/src/hooks/index.ts +2 -0
  95. package/src/hooks/useActionHandler.ts +93 -0
  96. package/src/hooks/useEditorView.ts +29 -0
  97. package/src/hooks/useTextEditor.ts +143 -19
  98. package/src/hooks/useTextModel.ts +28 -9
  99. package/src/index.ts +1 -1
  100. package/src/styles/markdown.ts +9 -10
  101. package/src/themes/default.ts +11 -8
  102. package/dist/types/src/components/TextEditor/comments.stories.d.ts.map +0 -1
  103. package/src/components/TextEditor/comments.stories.tsx +0 -357
@@ -22,10 +22,10 @@ const buildDecorations = (view: EditorView): DecorationSet => {
22
22
  case 'ATXHeading5':
23
23
  case 'ATXHeading6': {
24
24
  const mark = node.node.getChild('HeaderMark');
25
-
26
- // Check if cursor is inside text.
27
- if (mark && (cursor < node.from || cursor > node.to)) {
28
- builder.add(mark.from, mark.to + 1, Decoration.replace({}));
25
+ if (mark) {
26
+ if (!view.hasFocus || view.state.readOnly || cursor < node.from || cursor > node.to) {
27
+ builder.add(mark.from, mark.to + 1, Decoration.replace({}));
28
+ }
29
29
  }
30
30
  }
31
31
  }
@@ -43,7 +43,6 @@ export const heading = () => {
43
43
  ViewPlugin.fromClass(
44
44
  class {
45
45
  decorations: DecorationSet;
46
-
47
46
  constructor(view: EditorView) {
48
47
  this.decorations = buildDecorations(view);
49
48
  }
@@ -53,7 +52,7 @@ export const heading = () => {
53
52
  }
54
53
  },
55
54
  {
56
- decorations: (v) => v.decorations,
55
+ decorations: (value) => value.decorations,
57
56
  },
58
57
  ),
59
58
  ];
@@ -128,13 +128,13 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
128
128
  // Markdown marks.
129
129
  {
130
130
  tag: [markdownTags.CodeMark, markdownTags.HeaderMark, markdownTags.QuoteMark, markdownTags.EmphasisMark],
131
- class: readonly ? 'hidden' : mark,
131
+ class: mark,
132
132
  },
133
133
 
134
134
  // E.g., code block language (after ```).
135
135
  {
136
136
  tag: [tags.function(tags.variableName), tags.labelName],
137
- class: readonly ? 'hidden' : codeMark,
137
+ class: codeMark,
138
138
  },
139
139
 
140
140
  {
@@ -143,12 +143,12 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
143
143
  },
144
144
 
145
145
  // Headings.
146
- { tag: tags.heading1, class: heading(1, readonly) },
147
- { tag: tags.heading2, class: heading(2, readonly) },
148
- { tag: tags.heading3, class: heading(3, readonly) },
149
- { tag: tags.heading4, class: heading(4, readonly) },
150
- { tag: tags.heading5, class: heading(5, readonly) },
151
- { tag: tags.heading6, class: heading(6, readonly) },
146
+ { tag: tags.heading1, class: heading(1) },
147
+ { tag: tags.heading2, class: heading(2) },
148
+ { tag: tags.heading3, class: heading(3) },
149
+ { tag: tags.heading4, class: heading(4) },
150
+ { tag: tags.heading5, class: heading(5) },
151
+ { tag: tags.heading6, class: heading(6) },
152
152
 
153
153
  // Emphasis.
154
154
  { tag: tags.emphasis, class: italic },
@@ -165,7 +165,7 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
165
165
  // However, since `codeLanguages` is also defined, the `lezer` will not parse fenced code blocks,
166
166
  // when a language is specified. In this case, the syntax highlighting extensions will colorize
167
167
  // the code, but all other CSS properties will be inherited.
168
- // IMPORTANT: Therefore, the fenced code block will use the base editor font.
168
+ // IMPORTANT: Therefore, the fenced code block will use the base editor font unless changed by an extension.
169
169
  {
170
170
  tag: [markdownTags.CodeText, markdownTags.InlineCode],
171
171
  class: code,
@@ -180,12 +180,6 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
180
180
  tag: [markdownTags.TableCell],
181
181
  class: 'font-mono',
182
182
  },
183
-
184
- // Main content, paragraphs, etc.
185
- // {
186
- // tag: [tags.content],
187
- // fontFamily: getToken('fontFamily.body', []).join(','),
188
- // },
189
183
  ],
190
184
  {
191
185
  scope: markdownLanguage,
@@ -51,11 +51,9 @@ const buildDecorations = (view: EditorView): DecorationSet => {
51
51
 
52
52
  export const hr = () => {
53
53
  return [
54
- styles,
55
54
  ViewPlugin.fromClass(
56
55
  class {
57
56
  decorations: DecorationSet;
58
-
59
57
  constructor(view: EditorView) {
60
58
  this.decorations = buildDecorations(view);
61
59
  }
@@ -65,8 +63,9 @@ export const hr = () => {
65
63
  }
66
64
  },
67
65
  {
68
- decorations: (v) => v.decorations,
66
+ decorations: (value) => value.decorations,
69
67
  },
70
68
  ),
69
+ styles,
71
70
  ];
72
71
  };
@@ -4,6 +4,7 @@
4
4
 
5
5
  export * from './bundle';
6
6
  export * from './code';
7
+ export * from './formatting';
7
8
  export * from './heading';
8
9
  export * from './highlight';
9
10
  export * from './hr';
@@ -22,6 +22,7 @@ import { tooltipContent } from '@dxos/react-ui-theme';
22
22
  // https://codemirror.net/try/?c=aW1wb3J0IHsgYmFzaWNTZXR1cCwgRWRpdG9yVmlldyB9IGZyb20gImNvZGVtaXJyb3IiCmltcG9ydCB7IG1hcmtkb3duIH0gZnJvbSAiQGNvZGVtaXJyb3IvbGFuZy1tYXJrZG93biIKaW1wb3J0IHsgc3ludGF4VHJlZSB9IGZyb20gIkBjb2RlbWlycm9yL2xhbmd1YWdlIjsKaW1wb3J0IHsgRWRpdG9yU3RhdGUsIFJhbmdlU2V0QnVpbGRlciwgU3RhdGVGaWVsZCB9IGZyb20gIkBjb2RlbWlycm9yL3N0YXRlIjsKaW1wb3J0IHsgRGVjb3JhdGlvbiwgV2lkZ2V0VHlwZSB9IGZyb20gIkBjb2RlbWlycm9yL3ZpZXciOwoKY2xhc3MgTGluayBleHRlbmRzIFdpZGdldFR5cGUgewogIGNvbnN0cnVjdG9yKHRleHQsIHVybCkgewogICAgc3VwZXIoKQogICAgdGhpcy50ZXh0ID0gdGV4dAogICAgdGhpcy51cmwgPSB1cmwKICB9CiAgZXEob3RoZXIpIHsgcmV0dXJuIHRoaXMudGV4dCA9PSBvdGhlci50ZXh0ICYmIHRoaXMudXJsID09IG90aGVyLnVybCB9CiAgdG9ET00oKSB7CiAgICBsZXQgbGluayA9IGRvY3VtZW50LmNyZWF0ZUVsZW1lbnQoImEiKQogICAgbGluay50ZXh0Q29udGVudCA9IHRoaXMudGV4dAogICAgbGluay5ocmVmID0gdGhpcy51cmwKICAgIHJldHVybiBsaW5rOwogIH0KfQoKbGV0IGRlY29yYXRpb25zRmllbGQgPSBTdGF0ZUZpZWxkLmRlZmluZSh7CiAgY3JlYXRlKCkgewogICAgcmV0dXJuIERlY29yYXRpb24ubm9uZTsKICB9LAogIHVwZGF0ZShfLCB0cikgewogICAgY29uc3QgYnVpbGRlciA9IG5ldyBSYW5nZVNldEJ1aWxkZXIoKTsKICAgIGxldCBjdXJzb3IgPSB0ci5zdGF0ZS5zZWxlY3Rpb24ubWFpbi5oZWFkOwogICAgc3ludGF4VHJlZSh0ci5zdGF0ZSkuaXRlcmF0ZSh7CiAgICAgIGVudGVyOiAobm9kZSkgPT4gewogICAgICAgIGlmICgoY3Vyc29yIDwgbm9kZS5mcm9tIHx8IGN1cnNvciA+IG5vZGUudG8pICYmIG5vZGUubmFtZSA9PSAiTGluayIpIHsKICAgICAgICAgIGxldCBtYXJrcyA9IG5vZGUubm9kZS5nZXRDaGlsZHJlbigiTGlua01hcmsiKTsKICAgICAgICAgIGxldCB0ZXh0ID0gbWFya3MubGVuZ3RoID49IDIgPyB0ci5zdGF0ZS5zbGljZURvYyhtYXJrc1swXS50bywgbWFya3NbMV0uZnJvbSkgOiAiIgoKICAgICAgICAgIGxldCB1cmxOb2RlID0gbm9kZS5ub2RlLmdldENoaWxkKCJVUkwiKTsKICAgICAgICAgIGxldCB1cmwgPSB1cmxOb2RlID8gdHIuc3RhdGUuc2xpY2VEb2ModXJsTm9kZS5mcm9tLCB1cmxOb2RlLnRvKSA6ICIiCiAgICAgICAgICBidWlsZGVyLmFkZChub2RlLmZyb20sIG5vZGUudG8sIERlY29yYXRpb24ucmVwbGFjZSh7CiAgICAgICAgICAgIHdpZGdldDogbmV3IExpbmsodGV4dCwgdXJsKSwKICAgICAgICAgIH0pLAogICAgICAgICAgICAgICAgICAgICApOwogICAgICAgICAgcmV0dXJuIGZhbHNlOwogICAgICAgIH0KICAgICAgICByZXR1cm4gdHJ1ZTsKICAgICAgfSwKICAgIH0pOwogICAgcmV0dXJuIGJ1aWxkZXIuZmluaXNoKCk7CiAgfSwKICBwcm92aWRlOiAoZikgPT4gRWRpdG9yVmlldy5kZWNvcmF0aW9ucy5mcm9tKGYpLAp9KTsKCmxldCB2aWV3ID0gbmV3IEVkaXRvclZpZXcoewogIGRvYzogIiMgSGVsbG8gV29ybGRcblxuW1Rlc3RdKGh0dHBzOi8vZXhhbXBsZS5jb20pXG5cblxuIiwKICBleHRlbnNpb25zOiBbZGVjb3JhdGlvbnNGaWVsZCwgbWFya2Rvd24oKV0sCiAgcGFyZW50OiBkb2N1bWVudC5ib2R5LAp9KTsKCnZpZXcuZm9jdXMoKTs=
23
23
  // https://discuss.codemirror.net/t/link-widget-is-clicked-only-if-editor-is-out-of-focus/7433
24
24
 
25
+ // TODO(burdon): Callback to dynamically lookup title of linked pages.
25
26
  export type LinkOptions = {
26
27
  link?: boolean;
27
28
  onHover?: (el: Element, url: string) => void;
@@ -37,7 +38,6 @@ export const link = (options: LinkOptions = {}): Extension => {
37
38
  ViewPlugin.fromClass(
38
39
  class {
39
40
  decorations: DecorationSet;
40
-
41
41
  constructor(view: EditorView) {
42
42
  this.decorations = buildDecorations(view, options);
43
43
  }
@@ -49,7 +49,7 @@ export const link = (options: LinkOptions = {}): Extension => {
49
49
  }
50
50
  },
51
51
  {
52
- decorations: (v) => v.decorations,
52
+ decorations: (value) => value.decorations,
53
53
  },
54
54
  ),
55
55
  ];
@@ -65,10 +65,12 @@ export const link = (options: LinkOptions = {}): Extension => {
65
65
  for (let i = 0, node: SyntaxNode | null = syntax; !link && node && i < 5; node = node.parent, i++) {
66
66
  link = node.name === 'Link' ? node : null;
67
67
  }
68
+
68
69
  const url = link && link.getChild('URL');
69
70
  if (!url || !link) {
70
71
  return null;
71
72
  }
73
+
72
74
  const urlText = view.state.sliceDoc(url.from, url.to);
73
75
  return {
74
76
  pos: link.from,
@@ -89,7 +91,10 @@ export const link = (options: LinkOptions = {}): Extension => {
89
91
  };
90
92
 
91
93
  class LinkButton extends WidgetType {
92
- constructor(private readonly _url: string, private readonly _onAttach: LinkOptions['onRender']) {
94
+ constructor(
95
+ private readonly _url: string,
96
+ private readonly _onAttach: LinkOptions['onRender'],
97
+ ) {
93
98
  super();
94
99
  }
95
100
 
@@ -105,7 +110,10 @@ class LinkButton extends WidgetType {
105
110
  }
106
111
 
107
112
  class LinkText extends WidgetType {
108
- constructor(private readonly _text: string, private readonly _url?: string) {
113
+ constructor(
114
+ private readonly _text: string,
115
+ private readonly _url?: string,
116
+ ) {
109
117
  super();
110
118
  }
111
119
 
@@ -158,6 +166,7 @@ const buildDecorations = (view: EditorView, options: LinkOptions): DecorationSet
158
166
  return false;
159
167
  }
160
168
 
169
+ // TODO(burdon): Don't expand if moving cursor up/down.
161
170
  if (!view.hasFocus || state.readOnly || cursor < node.from || cursor > node.to) {
162
171
  builder.add(
163
172
  node.from,
@@ -91,7 +91,6 @@ export const tasklist = (options: TasklistOptions = {}) => {
91
91
  ViewPlugin.fromClass(
92
92
  class {
93
93
  decorations: DecorationSet;
94
-
95
94
  constructor(view: EditorView) {
96
95
  this.decorations = buildDecorations(view);
97
96
  }
@@ -103,7 +102,7 @@ export const tasklist = (options: TasklistOptions = {}) => {
103
102
  }
104
103
  },
105
104
  {
106
- decorations: (v) => v.decorations,
105
+ decorations: (value) => value.decorations,
107
106
  },
108
107
  ),
109
108
  styles,
@@ -5,5 +5,7 @@
5
5
  export * from './awareness-provider';
6
6
  export * from './defs';
7
7
 
8
+ export * from './useActionHandler';
9
+ export * from './useEditorView';
8
10
  export * from './useTextEditor';
9
11
  export * from './useTextModel';
@@ -0,0 +1,93 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import type { EditorView } from '@codemirror/view';
6
+
7
+ import type { ToolbarProps } from '../components';
8
+ import {
9
+ createComment,
10
+ insertTable,
11
+ setHeading,
12
+ setStyle,
13
+ toggleStyle,
14
+ addLink,
15
+ removeLink,
16
+ Inline,
17
+ List,
18
+ addList,
19
+ removeList,
20
+ toggleList,
21
+ addBlockquote,
22
+ removeBlockquote,
23
+ addCodeblock,
24
+ removeCodeblock,
25
+ toggleBlockquote,
26
+ } from '../extensions';
27
+
28
+ export const useActionHandler = (view?: EditorView | null): ToolbarProps['onAction'] => {
29
+ return (action) => {
30
+ if (!view) {
31
+ return;
32
+ }
33
+
34
+ let inlineType, listType;
35
+ switch (action.type) {
36
+ case 'heading':
37
+ setHeading(parseInt(action.data))(view);
38
+ break;
39
+
40
+ case 'strong':
41
+ case 'emphasis':
42
+ case 'strikethrough':
43
+ case 'code':
44
+ inlineType =
45
+ action.type === 'strong'
46
+ ? Inline.Strong
47
+ : action.type === 'emphasis'
48
+ ? Inline.Emphasis
49
+ : action.type === 'strikethrough'
50
+ ? Inline.Strikethrough
51
+ : Inline.Code;
52
+ (typeof action.data === 'boolean' ? setStyle(inlineType, action.data) : toggleStyle(inlineType))(view);
53
+ break;
54
+
55
+ case 'list-ordered':
56
+ case 'list-bullet':
57
+ case 'list-tasks':
58
+ listType =
59
+ action.type === 'list-ordered' ? List.Ordered : action.type === 'list-bullet' ? List.Bullet : List.Task;
60
+ (action.data === false
61
+ ? removeList(listType)
62
+ : action.data === true
63
+ ? addList(listType)
64
+ : toggleList(listType))(view);
65
+ break;
66
+
67
+ case 'blockquote':
68
+ (action.data === false ? removeBlockquote : action.data === true ? addBlockquote : toggleBlockquote)(view);
69
+ break;
70
+ case 'codeblock':
71
+ (action.data === false ? removeCodeblock : addCodeblock)(view);
72
+ break;
73
+ case 'table':
74
+ insertTable(view);
75
+ break;
76
+
77
+ case 'link':
78
+ (action.data === false ? removeLink : addLink)(view);
79
+ break;
80
+
81
+ case 'comment':
82
+ createComment(view);
83
+ break;
84
+ }
85
+
86
+ // TODO(burdon): Hack otherwise remains on heading selector.
87
+ setTimeout(() => {
88
+ if (!view.hasFocus) {
89
+ view.focus();
90
+ }
91
+ });
92
+ };
93
+ };
@@ -0,0 +1,29 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { type EditorView } from '@codemirror/view';
6
+ import { type RefCallback, useState } from 'react';
7
+
8
+ /**
9
+ * Hook for accessing the editor view.
10
+ *
11
+ * ```tsx
12
+ * const Test = () => {
13
+ * const [editorRef, editorView] = useEditorView();
14
+ * useEffect(() => {
15
+ * editorView?.focus();
16
+ * }, [editorView]);
17
+ * return <TextEditor ref={editorRef} />;
18
+ * };
19
+ * ```
20
+ */
21
+ export const useEditorView = (): [RefCallback<EditorView | null>, EditorView | null] => {
22
+ const [view, setView] = useState<EditorView | null>(null);
23
+ return [
24
+ (ref: EditorView | null) => {
25
+ setView(ref);
26
+ },
27
+ view,
28
+ ];
29
+ };
@@ -2,28 +2,152 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import { type EditorView } from '@codemirror/view';
6
- import { type RefCallback, useState } from 'react';
5
+ import {
6
+ EditorSelection,
7
+ EditorState,
8
+ type EditorStateConfig,
9
+ type Extension,
10
+ type StateEffect,
11
+ } from '@codemirror/state';
12
+ import { EditorView } from '@codemirror/view';
13
+ import { type RefObject, useEffect, useRef, useState } from 'react';
14
+
15
+ import { log } from '@dxos/log';
16
+ import { type ThemeMode } from '@dxos/react-ui';
17
+ import { isNotFalsy } from '@dxos/util';
18
+
19
+ import { type ThemeStyles } from '..//styles';
20
+ import { defaultTheme } from '../themes';
21
+ import { logChanges } from '../util';
22
+
23
+ export type UseTextEditorOptions = {
24
+ autoFocus?: boolean;
25
+ scrollTo?: StateEffect<any>;
26
+ debug?: boolean;
27
+ } & EditorStateConfig;
28
+
29
+ export type UseTextEditor = {
30
+ parentRef: RefObject<HTMLDivElement>;
31
+ view?: EditorView;
32
+ };
7
33
 
8
34
  /**
9
- * Hook for accessing the editor view.
10
- *
11
- * ```tsx
12
- * const Test = () => {
13
- * const [editorRef, editorView] = useTextEditor();
14
- * useEffect(() => {
15
- * editorView?.focus();
16
- * }, [editorView]);
17
- * return <TextEditor ref={editorRef} />;
18
- * };
19
- * ```
35
+ * Hook for creating editor.
20
36
  */
21
- export const useTextEditor = (): [RefCallback<EditorView | null>, EditorView | null] => {
22
- const [view, setView] = useState<EditorView | null>(null);
37
+ export const useTextEditor = ({
38
+ autoFocus,
39
+ scrollTo,
40
+ debug,
41
+ doc,
42
+ selection,
43
+ extensions,
44
+ }: UseTextEditorOptions = {}): UseTextEditor => {
45
+ const onUpdate = useRef<() => void>();
46
+ const [view, setView] = useState<EditorView>();
47
+ const parentRef = useRef<HTMLDivElement>(null);
48
+ useEffect(() => {
49
+ if (parentRef.current) {
50
+ // https://codemirror.net/docs/ref/#state.EditorStateConfig
51
+ const state = EditorState.create({
52
+ doc,
53
+ selection,
54
+ extensions: [
55
+ // TODO(burdon): Doesn't catch errors in keymap functions.
56
+ EditorView.exceptionSink.of((err) => {
57
+ log.catch(err);
58
+ }),
59
+ extensions,
60
+ EditorView.updateListener.of(() => {
61
+ onUpdate.current?.();
62
+ }),
63
+ ].filter(isNotFalsy),
64
+ });
65
+
66
+ // https://codemirror.net/docs/ref/#view.EditorViewConfig
67
+ const view = new EditorView({
68
+ parent: parentRef.current,
69
+ scrollTo,
70
+ state,
71
+ // NOTE: Uncomment to debug/monitor all transactions.
72
+ // https://codemirror.net/docs/ref/#view.EditorView.dispatch
73
+ dispatchTransactions: (trs, view) => {
74
+ if (debug) {
75
+ logChanges(trs);
76
+ }
77
+ view.update(trs);
78
+ },
79
+ });
80
+
81
+ setView(view);
82
+ }
83
+
84
+ return () => {
85
+ view?.destroy();
86
+ };
87
+ }, [parentRef]);
88
+
89
+ useEffect(() => {
90
+ if (view) {
91
+ // Select end of line if not specified.
92
+ if (!selection && !view.state.selection.main.anchor) {
93
+ selection = EditorSelection.single(view.state.doc.line(1).to);
94
+ }
95
+
96
+ // Set selection after first update (since content may rerender on focus).
97
+ // TODO(burdon): BUG on first render may appear in middle of formatted heading.
98
+ // TODO(burdon): Make invisible until first render?
99
+ if (selection || scrollTo) {
100
+ onUpdate.current = () => {
101
+ onUpdate.current = undefined;
102
+ view.dispatch({ selection, effects: scrollTo && [scrollTo], scrollIntoView: !scrollTo });
103
+ };
104
+ }
105
+
106
+ if (autoFocus) {
107
+ view.focus();
108
+ }
109
+ }
110
+ }, [view, autoFocus, selection, scrollTo]);
111
+
112
+ return { parentRef, view };
113
+ };
114
+
115
+ // TODO(burdon): Factor out extension factories.
116
+
117
+ export type DataExtensionsOptions = {
118
+ readonly?: boolean;
119
+ };
120
+
121
+ // TODO(burdon): Pass in TextObject (remove model).
122
+ export const createDataExtensions = ({ readonly = false } = {}): Extension => {
23
123
  return [
24
- (ref: EditorView | null) => {
25
- setView(ref);
26
- },
27
- view,
124
+ //
125
+ EditorState.readOnly.of(readonly),
126
+ EditorView.editable.of(!readonly),
28
127
  ];
29
128
  };
129
+
130
+ export type ThemeExtensionsOptions = {
131
+ theme?: ThemeStyles;
132
+ themeMode?: ThemeMode;
133
+ lineWrap?: boolean;
134
+ slots?: {
135
+ editor?: {
136
+ className?: string;
137
+ };
138
+ content?: {
139
+ className?: string;
140
+ };
141
+ };
142
+ };
143
+
144
+ export const createThemeExtensions = ({ theme, themeMode, slots }: ThemeExtensionsOptions = {}): Extension => {
145
+ return [
146
+ //
147
+ EditorView.baseTheme(defaultTheme),
148
+ theme && EditorView.theme(theme),
149
+ EditorView.darkTheme.of(themeMode === 'dark'),
150
+ EditorView.editorAttributes.of({ class: slots?.editor?.className ?? '' }),
151
+ EditorView.contentAttributes.of({ class: slots?.content?.className ?? '' }),
152
+ ].filter(isNotFalsy);
153
+ };
@@ -3,18 +3,17 @@
3
3
  //
4
4
 
5
5
  import get from 'lodash.get';
6
- import { useEffect, useState } from 'react';
6
+ import { type Dispatch, type SetStateAction, useEffect, useState } from 'react';
7
7
 
8
8
  import { generateName } from '@dxos/display-name';
9
9
  import { type AutomergeTextCompat, getRawDoc } from '@dxos/echo-schema';
10
10
  import { invariant } from '@dxos/invariant';
11
11
  import { isAutomergeObject, type Space, type TextObject } from '@dxos/react-client/echo';
12
12
  import { type Identity } from '@dxos/react-client/halo';
13
- import { isNotNullOrUndefined } from '@dxos/util';
14
13
 
15
14
  import { SpaceAwarenessProvider } from './awareness-provider';
16
15
  import { type EditorModel, modelState } from './defs';
17
- import { automerge, awareness, AwarenessProvider } from '../extensions';
16
+ import { automerge, awareness } from '../extensions';
18
17
  import { cursorColor } from '../styles';
19
18
 
20
19
  // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
@@ -31,6 +30,22 @@ export const useTextModel = (props: UseTextModelProps): EditorModel | undefined
31
30
  return model;
32
31
  };
33
32
 
33
+ /**
34
+ * For use primarily in stories & tests so the dependence on TextObject can be avoided.
35
+ * @param id
36
+ * @param defaultContent
37
+ */
38
+ export const useInMemoryTextModel = ({
39
+ id,
40
+ defaultContent,
41
+ }: {
42
+ id: string;
43
+ defaultContent?: string;
44
+ }): EditorModel & { setContent: Dispatch<SetStateAction<string>> } => {
45
+ const [content, setContent] = useState(defaultContent ?? '');
46
+ return { id, content, setContent, text: () => content };
47
+ };
48
+
34
49
  const createModel = ({ space, identity, text }: UseTextModelProps) => {
35
50
  invariant(isAutomergeObject(text));
36
51
  const obj = text as any as AutomergeTextCompat;
@@ -49,16 +64,20 @@ const createModel = ({ space, identity, text }: UseTextModelProps) => {
49
64
  peerId: identity?.identityKey.toHex() ?? 'Anonymous',
50
65
  });
51
66
 
67
+ const extensions = [
68
+ //
69
+ modelState.init(() => model),
70
+ automerge({ handle: doc.handle, path: doc.path }),
71
+ ];
72
+ if (awarenessProvider) {
73
+ extensions.push(awareness(awarenessProvider));
74
+ }
75
+
52
76
  const model: EditorModel = {
53
77
  id: obj.id,
54
78
  content: doc,
55
79
  text: () => get(doc.handle.docSync(), doc.path),
56
- extension: [
57
- modelState.init(() => model),
58
- automerge({ handle: doc.handle, path: doc.path }),
59
- awarenessProvider && AwarenessProvider.of(awarenessProvider),
60
- awareness(),
61
- ].filter(isNotNullOrUndefined),
80
+ extension: extensions,
62
81
  peer: identity
63
82
  ? {
64
83
  id: identity.identityKey.toHex(),
package/src/index.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  export { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
6
6
  export { Doc, YText, YXmlFragment } from '@dxos/text-model';
7
7
  export { type Extension } from '@codemirror/state';
8
- export { type EditorView } from '@codemirror/view';
8
+ export { type EditorView, keymap } from '@codemirror/view';
9
9
 
10
10
  export * from './components';
11
11
  export * from './extensions';
@@ -8,18 +8,17 @@ export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
8
8
 
9
9
  // TODO(burdon): Better way to align vertically than negative margin? Font-specific?
10
10
  // https://tailwindcss.com/docs/font-weight
11
- export const headings: Record<HeadingLevel, string[]> = {
12
- 1: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl', '-ml-[10px]'],
13
- 2: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl', '-ml-[8px]'],
14
- 3: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl', '-ml-[7px]'],
15
- 4: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-xl', '-ml-[6px]'],
16
- 5: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-lg', '-ml-[5px]'],
17
- 6: ['mbs-4 mbe-2 font-medium text-inherit no-underline', '-ml-[4px]'],
11
+ export const headings: Record<HeadingLevel, string> = {
12
+ 1: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl',
13
+ 2: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl',
14
+ 3: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl',
15
+ 4: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-xl',
16
+ 5: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-lg',
17
+ 6: 'mbs-4 mbe-2 font-medium text-inherit no-underline',
18
18
  };
19
19
 
20
- export const heading = (level: HeadingLevel, readonly?: boolean) => {
21
- const [style, offset] = headings[level];
22
- return mx(style, readonly && offset);
20
+ export const heading = (level: HeadingLevel) => {
21
+ return headings[level];
23
22
  };
24
23
 
25
24
  export const text = 'text-neutral-800 dark:text-neutral-200';
@@ -49,9 +49,11 @@ export const defaultTheme: ThemeStyles = {
49
49
  '&.cm-focused': {
50
50
  outline: 'none',
51
51
  },
52
+
52
53
  '.cm-scroller': {
53
- overflow: 'visible',
54
+ // overflow: 'visible',
54
55
  fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
56
+ lineHeight: 1.4,
55
57
  },
56
58
 
57
59
  '.cm-content': {
@@ -60,11 +62,11 @@ export const defaultTheme: ThemeStyles = {
60
62
  fontSize: '16px',
61
63
  },
62
64
  '&light .cm-content': {
63
- color: get(tokens, 'extend.colors.neutral.900', 'black'),
65
+ color: get(tokens, 'extend.semanticColors.base.fg.light', 'black'),
64
66
  caretColor: 'black',
65
67
  },
66
68
  '&dark .cm-content': {
67
- color: get(tokens, 'extend.colors.neutral.100', 'white'),
69
+ color: get(tokens, 'extend.semanticColors.base.fg.dark', 'white'),
68
70
  caretColor: 'white',
69
71
  },
70
72
 
@@ -77,8 +79,11 @@ export const defaultTheme: ThemeStyles = {
77
79
  '&dark .cm-cursor, &dark .cm-dropCursor': {
78
80
  borderLeft: '2px solid white',
79
81
  },
80
- '.cm-placeholder': {
81
- fontWeight: 100,
82
+ '&light .cm-placeholder': {
83
+ color: get(tokens, 'extend.semanticColors.description.light', 'rgba(0,0,0,.2)'),
84
+ },
85
+ '&dark .cm-placeholder': {
86
+ color: get(tokens, 'extend.semanticColors.description.dark', 'rgba(255,255,255,.2)'),
82
87
  },
83
88
 
84
89
  //
@@ -86,11 +91,9 @@ export const defaultTheme: ThemeStyles = {
86
91
  //
87
92
  '.cm-line': {
88
93
  paddingInline: 0,
89
- // TODO(burdon): Other values leave gaps between lines when highlighted.
90
- // lineHeight: 'normal',
91
94
  },
92
95
  '.cm-activeLine': {
93
- background: 'inherit',
96
+ background: 'transparent',
94
97
  },
95
98
 
96
99
  //
@@ -1 +0,0 @@
1
- {"version":3,"file":"comments.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/TextEditor/comments.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,YAAY,CAAC;AAEpB,OAAO,EAAE,KAAK,UAAU,EAAU,MAAM,kBAAkB,CAAC;AAG3D,OAAO,KAAwD,MAAM,OAAO,CAAC;AA6M7E,KAAK,UAAU,GAAG;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;;;;;mBAoHe,UAAU;;AAJ3B,wBAKE;AAWF,eAAO,MAAM,OAAO;;;;CAInB,CAAC;AAEF,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC"}