@dxos/react-ui-editor 0.3.10 → 0.3.11-main.008b7c6

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 (211) hide show
  1. package/dist/lib/browser/index.mjs +1537 -847
  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 +14 -10
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts +3 -2
  7. package/dist/types/src/components/TextEditor/TextEditor.d.ts.map +1 -1
  8. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts +3 -0
  9. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts.map +1 -1
  10. package/dist/types/src/{hooks/automerge → components/TextEditor}/automerge.stories.d.ts +6 -2
  11. package/dist/types/src/components/TextEditor/automerge.stories.d.ts.map +1 -0
  12. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts.map +1 -1
  13. package/dist/types/src/components/TextEditor/index.d.ts +0 -2
  14. package/dist/types/src/components/TextEditor/index.d.ts.map +1 -1
  15. package/dist/types/src/{hooks/yjs → components/TextEditor}/yjs.stories.d.ts +1 -1
  16. package/dist/types/src/components/TextEditor/yjs.stories.d.ts.map +1 -0
  17. package/dist/types/src/extensions/autocomplete.d.ts.map +1 -0
  18. package/dist/types/src/extensions/automerge/automerge.d.ts +9 -0
  19. package/dist/types/src/extensions/automerge/automerge.d.ts.map +1 -0
  20. package/dist/types/src/extensions/automerge/cursor.d.ts +5 -0
  21. package/dist/types/src/extensions/automerge/cursor.d.ts.map +1 -0
  22. package/dist/types/src/extensions/automerge/defs.d.ts +26 -0
  23. package/dist/types/src/extensions/automerge/defs.d.ts.map +1 -0
  24. package/dist/types/src/extensions/automerge/index.d.ts +3 -0
  25. package/dist/types/src/extensions/automerge/index.d.ts.map +1 -0
  26. package/dist/types/src/{hooks/automerge/PatchSemaphore.d.ts → extensions/automerge/semaphore.d.ts} +5 -5
  27. package/dist/types/src/extensions/automerge/semaphore.d.ts.map +1 -0
  28. package/dist/types/src/extensions/automerge/update-automerge.d.ts +5 -0
  29. package/dist/types/src/extensions/automerge/update-automerge.d.ts.map +1 -0
  30. package/dist/types/src/extensions/automerge/update-codemirror.d.ts +5 -0
  31. package/dist/types/src/extensions/automerge/update-codemirror.d.ts.map +1 -0
  32. package/dist/types/src/extensions/awareness.d.ts +46 -0
  33. package/dist/types/src/extensions/awareness.d.ts.map +1 -0
  34. package/dist/types/src/extensions/basic.d.ts.map +1 -0
  35. package/dist/types/src/extensions/blast.d.ts.map +1 -0
  36. package/dist/types/src/extensions/code.d.ts.map +1 -0
  37. package/dist/types/src/extensions/comments.d.ts +50 -0
  38. package/dist/types/src/extensions/comments.d.ts.map +1 -0
  39. package/dist/types/src/extensions/hr.d.ts +2 -0
  40. package/dist/types/src/extensions/hr.d.ts.map +1 -0
  41. package/dist/types/src/extensions/image.d.ts.map +1 -0
  42. package/dist/types/src/{components/TextEditor/extensions → extensions}/index.d.ts +6 -3
  43. package/dist/types/src/extensions/index.d.ts.map +1 -0
  44. package/dist/types/src/{components/TextEditor/extensions → extensions}/link.d.ts +1 -0
  45. package/dist/types/src/extensions/link.d.ts.map +1 -0
  46. package/dist/types/src/extensions/listener.d.ts +10 -0
  47. package/dist/types/src/extensions/listener.d.ts.map +1 -0
  48. package/dist/types/src/extensions/markdown/bundle.d.ts.map +1 -0
  49. package/dist/types/src/{components/TextEditor/extensions → extensions}/markdown/highlight.d.ts +0 -1
  50. package/dist/types/src/extensions/markdown/highlight.d.ts.map +1 -0
  51. package/dist/types/src/extensions/markdown/index.d.ts.map +1 -0
  52. package/dist/types/src/extensions/mention.d.ts.map +1 -0
  53. package/dist/types/src/extensions/mermaid.d.ts +3 -0
  54. package/dist/types/src/extensions/mermaid.d.ts.map +1 -0
  55. package/dist/types/src/extensions/table.d.ts.map +1 -0
  56. package/dist/types/src/extensions/tasklist.d.ts.map +1 -0
  57. package/dist/types/src/{components/TextEditor/extensions/demo.d.ts → extensions/typewriter.d.ts} +2 -3
  58. package/dist/types/src/extensions/typewriter.d.ts.map +1 -0
  59. package/dist/types/src/extensions/yjs/cursor.d.ts +4 -0
  60. package/dist/types/src/extensions/yjs/cursor.d.ts.map +1 -0
  61. package/dist/types/src/extensions/yjs/index.d.ts +2 -0
  62. package/dist/types/src/extensions/yjs/index.d.ts.map +1 -0
  63. package/dist/types/src/extensions/yjs/yjs.d.ts +4 -0
  64. package/dist/types/src/extensions/yjs/yjs.d.ts.map +1 -0
  65. package/dist/types/src/extensions/yjs/yjs.test.d.ts +2 -0
  66. package/dist/types/src/extensions/yjs/yjs.test.d.ts.map +1 -0
  67. package/dist/types/src/hooks/automerge.d.ts +3 -0
  68. package/dist/types/src/hooks/automerge.d.ts.map +1 -0
  69. package/dist/types/src/hooks/awareness-provider.d.ts +28 -0
  70. package/dist/types/src/hooks/awareness-provider.d.ts.map +1 -0
  71. package/dist/types/src/hooks/index.d.ts +2 -0
  72. package/dist/types/src/hooks/index.d.ts.map +1 -1
  73. package/dist/types/src/hooks/useTextModel.d.ts +20 -11
  74. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  75. package/dist/types/src/hooks/{yjs/space-provider.d.ts → yjs.d.ts} +8 -8
  76. package/dist/types/src/hooks/yjs.d.ts.map +1 -0
  77. package/dist/types/src/index.d.ts +3 -0
  78. package/dist/types/src/index.d.ts.map +1 -1
  79. package/dist/types/src/styles/cursors.d.ts.map +1 -0
  80. package/dist/types/src/styles/index.d.ts +1 -0
  81. package/dist/types/src/styles/index.d.ts.map +1 -1
  82. package/dist/types/src/testing/replicator.d.ts +2 -2
  83. package/dist/types/src/testing/replicator.d.ts.map +1 -1
  84. package/dist/types/src/{components/TextEditor/themes → themes}/default.d.ts +5 -13
  85. package/dist/types/src/themes/default.d.ts.map +1 -0
  86. package/dist/types/src/themes/index.d.ts.map +1 -0
  87. package/dist/types/src/util/cursor.d.ts +17 -0
  88. package/dist/types/src/util/cursor.d.ts.map +1 -0
  89. package/dist/types/src/util/index.d.ts +3 -0
  90. package/dist/types/src/util/index.d.ts.map +1 -0
  91. package/dist/types/src/util/util.d.ts +5 -0
  92. package/dist/types/src/util/util.d.ts.map +1 -0
  93. package/package.json +25 -20
  94. package/src/components/TextEditor/MarkdownEditor.stories.tsx +130 -71
  95. package/src/components/TextEditor/TextEditor.stories.tsx +15 -2
  96. package/src/components/TextEditor/TextEditor.tsx +30 -26
  97. package/src/{hooks/automerge → components/TextEditor}/automerge.stories.tsx +67 -8
  98. package/src/components/TextEditor/codemirror.stories.ts +3 -2
  99. package/src/components/TextEditor/index.ts +0 -3
  100. package/src/{hooks/yjs → components/TextEditor}/yjs.stories.tsx +1 -1
  101. package/src/extensions/automerge/automerge.ts +94 -0
  102. package/src/extensions/automerge/cursor.ts +51 -0
  103. package/src/extensions/automerge/defs.ts +62 -0
  104. package/src/extensions/automerge/index.ts +6 -0
  105. package/src/{hooks/automerge/PatchSemaphore.ts → extensions/automerge/semaphore.ts} +18 -15
  106. package/src/{hooks/automerge/translation/codemirror-to-automerge.ts → extensions/automerge/update-automerge.ts} +6 -7
  107. package/src/{hooks/automerge/translation/automerge-to-codemirror.ts → extensions/automerge/update-codemirror.ts} +14 -11
  108. package/src/extensions/awareness.ts +316 -0
  109. package/src/{components/TextEditor/extensions → extensions}/code.ts +13 -13
  110. package/src/extensions/comments.ts +421 -0
  111. package/src/extensions/hr.ts +74 -0
  112. package/src/{components/TextEditor/extensions → extensions}/image.ts +3 -1
  113. package/src/{components/TextEditor/extensions → extensions}/index.ts +6 -3
  114. package/src/{components/TextEditor/extensions → extensions}/link.ts +66 -10
  115. package/src/extensions/listener.ts +35 -0
  116. package/src/{components/TextEditor/extensions → extensions}/markdown/highlight.ts +6 -9
  117. package/src/extensions/mermaid.ts +11 -0
  118. package/src/{components/TextEditor/extensions → extensions}/table.ts +14 -1
  119. package/src/{components/TextEditor/extensions/demo.ts → extensions/typewriter.ts} +2 -3
  120. package/src/extensions/yjs/cursor.ts +21 -0
  121. package/src/extensions/yjs/index.ts +5 -0
  122. package/src/extensions/yjs/yjs.test.ts +35 -0
  123. package/src/extensions/yjs/yjs.ts +16 -0
  124. package/src/hooks/automerge.ts +52 -0
  125. package/src/hooks/awareness-provider.ts +120 -0
  126. package/src/hooks/index.ts +2 -0
  127. package/src/hooks/useTextModel.ts +43 -79
  128. package/src/hooks/{yjs/space-provider.ts → yjs.ts} +71 -19
  129. package/src/index.ts +3 -0
  130. package/src/styles/index.ts +1 -0
  131. package/src/testing/replicator.ts +10 -16
  132. package/src/{components/TextEditor/themes → themes}/default.ts +61 -38
  133. package/src/util/cursor.ts +29 -0
  134. package/src/util/index.ts +6 -0
  135. package/src/util/util.ts +18 -0
  136. package/dist/types/src/components/TextEditor/extensions/autocomplete.d.ts.map +0 -1
  137. package/dist/types/src/components/TextEditor/extensions/basic.d.ts.map +0 -1
  138. package/dist/types/src/components/TextEditor/extensions/blast.d.ts.map +0 -1
  139. package/dist/types/src/components/TextEditor/extensions/code.d.ts.map +0 -1
  140. package/dist/types/src/components/TextEditor/extensions/comments.d.ts +0 -18
  141. package/dist/types/src/components/TextEditor/extensions/comments.d.ts.map +0 -1
  142. package/dist/types/src/components/TextEditor/extensions/demo.d.ts.map +0 -1
  143. package/dist/types/src/components/TextEditor/extensions/experimental.d.ts +0 -10
  144. package/dist/types/src/components/TextEditor/extensions/experimental.d.ts.map +0 -1
  145. package/dist/types/src/components/TextEditor/extensions/highlight.d.ts +0 -24
  146. package/dist/types/src/components/TextEditor/extensions/highlight.d.ts.map +0 -1
  147. package/dist/types/src/components/TextEditor/extensions/image.d.ts.map +0 -1
  148. package/dist/types/src/components/TextEditor/extensions/index.d.ts.map +0 -1
  149. package/dist/types/src/components/TextEditor/extensions/link.d.ts.map +0 -1
  150. package/dist/types/src/components/TextEditor/extensions/listener.d.ts +0 -9
  151. package/dist/types/src/components/TextEditor/extensions/listener.d.ts.map +0 -1
  152. package/dist/types/src/components/TextEditor/extensions/markdown/bundle.d.ts.map +0 -1
  153. package/dist/types/src/components/TextEditor/extensions/markdown/highlight.d.ts.map +0 -1
  154. package/dist/types/src/components/TextEditor/extensions/markdown/index.d.ts.map +0 -1
  155. package/dist/types/src/components/TextEditor/extensions/mention.d.ts.map +0 -1
  156. package/dist/types/src/components/TextEditor/extensions/table.d.ts.map +0 -1
  157. package/dist/types/src/components/TextEditor/extensions/tasklist.d.ts.map +0 -1
  158. package/dist/types/src/components/TextEditor/extensions/tooltip.d.ts +0 -12
  159. package/dist/types/src/components/TextEditor/extensions/tooltip.d.ts.map +0 -1
  160. package/dist/types/src/components/TextEditor/themes/default.d.ts.map +0 -1
  161. package/dist/types/src/components/TextEditor/themes/index.d.ts.map +0 -1
  162. package/dist/types/src/hooks/automerge/PatchSemaphore.d.ts.map +0 -1
  163. package/dist/types/src/hooks/automerge/automerge.stories.d.ts.map +0 -1
  164. package/dist/types/src/hooks/automerge/handle.d.ts +0 -9
  165. package/dist/types/src/hooks/automerge/handle.d.ts.map +0 -1
  166. package/dist/types/src/hooks/automerge/index.d.ts +0 -3
  167. package/dist/types/src/hooks/automerge/index.d.ts.map +0 -1
  168. package/dist/types/src/hooks/automerge/plugin.d.ts +0 -26
  169. package/dist/types/src/hooks/automerge/plugin.d.ts.map +0 -1
  170. package/dist/types/src/hooks/automerge/translation/automerge-to-codemirror.d.ts +0 -5
  171. package/dist/types/src/hooks/automerge/translation/automerge-to-codemirror.d.ts.map +0 -1
  172. package/dist/types/src/hooks/automerge/translation/codemirror-to-automerge.d.ts +0 -6
  173. package/dist/types/src/hooks/automerge/translation/codemirror-to-automerge.d.ts.map +0 -1
  174. package/dist/types/src/hooks/automerge/translation/index.d.ts +0 -3
  175. package/dist/types/src/hooks/automerge/translation/index.d.ts.map +0 -1
  176. package/dist/types/src/hooks/yjs/cursors.d.ts.map +0 -1
  177. package/dist/types/src/hooks/yjs/index.d.ts +0 -3
  178. package/dist/types/src/hooks/yjs/index.d.ts.map +0 -1
  179. package/dist/types/src/hooks/yjs/space-provider.d.ts.map +0 -1
  180. package/dist/types/src/hooks/yjs/yjs.stories.d.ts.map +0 -1
  181. package/src/components/TextEditor/extensions/comments.ts +0 -173
  182. package/src/components/TextEditor/extensions/experimental.tsx +0 -114
  183. package/src/components/TextEditor/extensions/highlight.ts +0 -128
  184. package/src/components/TextEditor/extensions/listener.ts +0 -23
  185. package/src/components/TextEditor/extensions/tooltip.tsx +0 -61
  186. package/src/hooks/automerge/handle.ts +0 -14
  187. package/src/hooks/automerge/index.ts +0 -6
  188. package/src/hooks/automerge/plugin.ts +0 -134
  189. package/src/hooks/automerge/translation/index.ts +0 -6
  190. package/src/hooks/yjs/index.ts +0 -6
  191. /package/dist/types/src/{components/TextEditor/extensions → extensions}/autocomplete.d.ts +0 -0
  192. /package/dist/types/src/{components/TextEditor/extensions → extensions}/basic.d.ts +0 -0
  193. /package/dist/types/src/{components/TextEditor/extensions → extensions}/blast.d.ts +0 -0
  194. /package/dist/types/src/{components/TextEditor/extensions → extensions}/code.d.ts +0 -0
  195. /package/dist/types/src/{components/TextEditor/extensions → extensions}/image.d.ts +0 -0
  196. /package/dist/types/src/{components/TextEditor/extensions → extensions}/markdown/bundle.d.ts +0 -0
  197. /package/dist/types/src/{components/TextEditor/extensions → extensions}/markdown/index.d.ts +0 -0
  198. /package/dist/types/src/{components/TextEditor/extensions → extensions}/mention.d.ts +0 -0
  199. /package/dist/types/src/{components/TextEditor/extensions → extensions}/table.d.ts +0 -0
  200. /package/dist/types/src/{components/TextEditor/extensions → extensions}/tasklist.d.ts +0 -0
  201. /package/dist/types/src/{hooks/yjs → styles}/cursors.d.ts +0 -0
  202. /package/dist/types/src/{components/TextEditor/themes → themes}/index.d.ts +0 -0
  203. /package/src/{components/TextEditor/extensions → extensions}/autocomplete.ts +0 -0
  204. /package/src/{components/TextEditor/extensions → extensions}/basic.ts +0 -0
  205. /package/src/{components/TextEditor/extensions → extensions}/blast.ts +0 -0
  206. /package/src/{components/TextEditor/extensions → extensions}/markdown/bundle.ts +0 -0
  207. /package/src/{components/TextEditor/extensions → extensions}/markdown/index.ts +0 -0
  208. /package/src/{components/TextEditor/extensions → extensions}/mention.ts +0 -0
  209. /package/src/{components/TextEditor/extensions → extensions}/tasklist.ts +0 -0
  210. /package/src/{hooks/yjs → styles}/cursors.ts +0 -0
  211. /package/src/{components/TextEditor/themes → themes}/index.ts +0 -0
@@ -0,0 +1,421 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { type Extension, StateEffect, StateField } from '@codemirror/state';
6
+ import {
7
+ hoverTooltip,
8
+ keymap,
9
+ type Command,
10
+ type DecorationSet,
11
+ type ViewUpdate,
12
+ Decoration,
13
+ EditorView,
14
+ MatchDecorator,
15
+ ViewPlugin,
16
+ WidgetType,
17
+ type Rect,
18
+ } from '@codemirror/view';
19
+ import get from 'lodash.get';
20
+ import sortBy from 'lodash.sortby';
21
+
22
+ import { debounce } from '@dxos/async';
23
+ import { invariant } from '@dxos/invariant';
24
+ import { log } from '@dxos/log';
25
+ import { nonNullable } from '@dxos/util';
26
+
27
+ import { type CommentRange, type EditorModel, type Range } from '../hooks';
28
+ import { tokens } from '../styles';
29
+ import { callbackWrapper, CursorConverter } from '../util';
30
+
31
+ // TODO(burdon): Handle delete, cut, copy, and paste (separately) text that includes comment range.
32
+ // TODO(burdon): Consider breaking into separate plugin (since not standalone)? Like mermaid?
33
+
34
+ // TODO(burdon): Reconcile with theme.
35
+ const styles = EditorView.baseTheme({
36
+ '& .cm-bookmark': {
37
+ cursor: 'pointer',
38
+ margin: '4px',
39
+ padding: '4px',
40
+ backgroundColor: 'yellow',
41
+ },
42
+ '& .cm-bookmark-selected': {
43
+ backgroundColor: 'orange',
44
+ },
45
+ '& .cm-comment': {
46
+ backgroundColor: get(tokens, 'extend.colors.yellow.50'),
47
+ },
48
+ '& .cm-comment-active': {
49
+ backgroundColor: get(tokens, 'extend.colors.yellow.100'),
50
+ },
51
+ });
52
+
53
+ const marks = {
54
+ highlight: Decoration.mark({ class: 'cm-comment' }),
55
+ highlightActive: Decoration.mark({ class: 'cm-comment-active' }),
56
+ };
57
+
58
+ // TODO(burdon): Should this be part of state?
59
+ type CommentSelected = {
60
+ active?: string;
61
+ closest?: string;
62
+ };
63
+
64
+ // TODO(burdon): Rename.
65
+ type ExtendedCommentRange = Range &
66
+ CommentRange & {
67
+ // TODO(burdon): Not part of state; just required for callback.
68
+ location?: Rect | null;
69
+ };
70
+
71
+ export type CommentsState = CommentSelected & {
72
+ ranges: ExtendedCommentRange[];
73
+ };
74
+
75
+ export const setFocus = (view: EditorView, thread: string) => {
76
+ const range = view.state.field(commentsStateField).ranges.find((range) => range.id === thread);
77
+ if (!range) {
78
+ return;
79
+ }
80
+
81
+ view.dispatch({
82
+ effects: setSelection.of({ active: thread }),
83
+ selection: { anchor: range.from },
84
+ scrollIntoView: true,
85
+ });
86
+ };
87
+
88
+ export const setCommentRange = StateEffect.define<{ model: EditorModel; comments: CommentRange[] }>();
89
+
90
+ export const setSelection = StateEffect.define<CommentSelected>();
91
+
92
+ const setCommentState = StateEffect.define<CommentsState>();
93
+
94
+ /**
95
+ * State field (reducer) that tracks comment ranges.
96
+ * The ranges are tracked as codemirror ranges (i.e., not relative YJS/Automerge positions), and
97
+ * therefore must be updated when the document changes.
98
+ */
99
+ const commentsStateField = StateField.define<CommentsState>({
100
+ create: () => ({ ranges: [] }),
101
+ update: (value, tr) => {
102
+ const cursorConverter = tr.state.facet(CursorConverter);
103
+
104
+ for (const effect of tr.effects) {
105
+ // Update selection.
106
+ if (effect.is(setSelection)) {
107
+ return { ...value, ...effect.value };
108
+ }
109
+
110
+ // Update range from store.
111
+ if (effect.is(setCommentRange)) {
112
+ const { comments } = effect.value;
113
+ const ranges: ExtendedCommentRange[] = comments
114
+ .map((comment) => {
115
+ const range = getRangeFromCursor(cursorConverter, comment.cursor);
116
+ return range && { ...comment, ...range };
117
+ })
118
+ .filter(nonNullable);
119
+
120
+ return { ...value, ranges };
121
+ }
122
+
123
+ // Update entire state.
124
+ if (effect.is(setCommentState)) {
125
+ return effect.value;
126
+ }
127
+ }
128
+
129
+ return value;
130
+ },
131
+ });
132
+
133
+ /**
134
+ * Decorate ranges.
135
+ */
136
+ const highlightDecorations = EditorView.decorations.compute([commentsStateField], (state) => {
137
+ const { active, ranges } = state.field(commentsStateField);
138
+ const decorations =
139
+ sortBy(ranges ?? [], (range) => range.from)
140
+ ?.flatMap((selection) => {
141
+ // TODO(burdon): Invalid range (e.g., deleted).
142
+ if (selection.from === selection.to) {
143
+ return undefined;
144
+ }
145
+
146
+ const range = { from: selection.from, to: selection.to };
147
+ if (selection.id === active) {
148
+ return marks.highlightActive.range(range.from, range.to);
149
+ } else {
150
+ return marks.highlight.range(range.from, range.to);
151
+ }
152
+ })
153
+ .filter(nonNullable) ?? [];
154
+
155
+ return Decoration.set(decorations);
156
+ });
157
+
158
+ /**
159
+ * Optional bookmark widget at the start/end of the selection.
160
+ * May correspond to a markdown bookmark.
161
+ */
162
+ class BookmarkWidget extends WidgetType {
163
+ constructor(
164
+ private readonly _anchor: number,
165
+ private readonly _id: string,
166
+ private readonly _handleClick?: () => void,
167
+ ) {
168
+ super();
169
+ invariant(this._id);
170
+ }
171
+
172
+ override eq(other: BookmarkWidget) {
173
+ return this._anchor === other._anchor && this._id === other._id;
174
+ }
175
+
176
+ override toDOM() {
177
+ const span = document.createElement('span');
178
+ span.className = 'cm-bookmark';
179
+ span.textContent = '※';
180
+ if (this._handleClick) {
181
+ span.onclick = () => this._handleClick!();
182
+ }
183
+ return span;
184
+ }
185
+ }
186
+
187
+ export type CommentsOptions = {
188
+ key?: string;
189
+ footnote?: boolean;
190
+ /**
191
+ * Called to create a new thread and return the thread id.
192
+ */
193
+ onCreate?: (range: string) => string | undefined;
194
+ /**
195
+ * Called to notify which thread is currently closest to the cursor.
196
+ */
197
+ onSelect?: (state: CommentsState) => void;
198
+ /**
199
+ * Called to render tooltip.
200
+ */
201
+ onHover?: (el: Element) => void;
202
+ };
203
+
204
+ /**
205
+ * Comment threads.
206
+ * 1). Updates the EditorModel to store relative selections for a set of comments threads.
207
+ * Since the selections are relative, they do not need to be updated when the document is edited.
208
+ * 2). Implements a StateField to track absolute selections corresponding to the comments (i.e., when the document is edited).
209
+ * 3). Creates decoration marks to apply classes to each selection.
210
+ * 4). Tracks the current cursor position to:
211
+ * a). Update the decoration to show if the cursor is within a current selection.
212
+ * b). Calls a handler to indicate which is the closest selection (e.g., to update the thread sidebar).
213
+ * 5). Optionally, inserts a markdown footnote when creating a comment thread.
214
+ * 6). Optionally, implements a hoverTooltip to show hints when creating a selection range.
215
+ */
216
+ export const comments = (options: CommentsOptions = {}): Extension => {
217
+ const handleSelect = debounce((state: CommentsState) => options.onSelect?.(state), 200);
218
+
219
+ /**
220
+ * Create comment thread action.
221
+ */
222
+ const createCommentThread: Command = (view) => {
223
+ const cursorConverter = view.state.facet(CursorConverter);
224
+
225
+ invariant(options.onCreate);
226
+ const { head, from, to } = view.state.selection.main;
227
+ if (from === to) {
228
+ return false;
229
+ }
230
+
231
+ const relPos = getCursorFromRange(cursorConverter, { from, to });
232
+ if (relPos) {
233
+ // Create thread via callback.
234
+ const id = callbackWrapper(options.onCreate)(relPos);
235
+ if (id) {
236
+ // Update range.
237
+ view.dispatch({
238
+ effects: setSelection.of({ active: id }),
239
+ selection: { anchor: from },
240
+ });
241
+
242
+ // Insert footnote.
243
+ if (options.footnote) {
244
+ const tag = `[^${id}]`;
245
+ view.dispatch({
246
+ changes: { from: head, insert: tag },
247
+ selection: { anchor: head + tag.length },
248
+ });
249
+ }
250
+
251
+ return true;
252
+ }
253
+ }
254
+
255
+ return false;
256
+ };
257
+
258
+ /**
259
+ * Bookmark widget decoration.
260
+ */
261
+ const bookmarksViewPlugin = ViewPlugin.fromClass(
262
+ class BookmarkViewPlugin {
263
+ // Match markdown footnotes (option).
264
+ // https://www.markdownguide.org/extended-syntax/#footnotes
265
+ static bookmarkMatcher = new MatchDecorator({
266
+ regexp: /\[\^(\w+)\]/g,
267
+ decoration: (match, view, pos) => {
268
+ const id = match[1];
269
+ return Decoration.replace({
270
+ id,
271
+ widget: new BookmarkWidget(pos, id),
272
+ });
273
+ },
274
+ });
275
+
276
+ bookmarks: DecorationSet;
277
+ constructor(view: EditorView) {
278
+ this.bookmarks = BookmarkViewPlugin.bookmarkMatcher.createDeco(view);
279
+ }
280
+
281
+ update(update: ViewUpdate) {
282
+ this.bookmarks = BookmarkViewPlugin.bookmarkMatcher.updateDeco(update, this.bookmarks);
283
+ }
284
+ },
285
+ {
286
+ decorations: (instance) => instance.bookmarks,
287
+ provide: (plugin) =>
288
+ EditorView.atomicRanges.of((view) => {
289
+ return view.plugin(plugin)?.bookmarks || Decoration.none;
290
+ }),
291
+ },
292
+ );
293
+
294
+ return [
295
+ bookmarksViewPlugin,
296
+ commentsStateField,
297
+ highlightDecorations,
298
+ styles,
299
+
300
+ //
301
+ // Keymap.
302
+ //
303
+ options.onCreate
304
+ ? keymap.of([
305
+ {
306
+ key: options?.key ?? "meta-'",
307
+ run: callbackWrapper(createCommentThread),
308
+ },
309
+ ])
310
+ : [],
311
+
312
+ //
313
+ // Hover tooltip (for key shortcut hints, etc.)
314
+ // TODO(burdon): Factor out to generic hints extension for current selection/line.
315
+ //
316
+ options.onHover
317
+ ? hoverTooltip(
318
+ (view, pos) => {
319
+ const selection = view.state.selection.main;
320
+ if (selection && pos >= selection.from && pos <= selection.to) {
321
+ return {
322
+ pos: selection.from,
323
+ end: selection.to,
324
+ above: true,
325
+ create: () => {
326
+ // TODO(burdon): Dispatch to react callback to render (or use SSR)?
327
+ const el = document.createElement('div');
328
+ options.onHover?.(el);
329
+ return { dom: el, offset: { x: 0, y: 8 } };
330
+ },
331
+ };
332
+ }
333
+
334
+ return null;
335
+ },
336
+ { hideOnChange: true, hoverTime: 1000 },
337
+ )
338
+ : [],
339
+
340
+ //
341
+ // Monitor cursor movement and text updates.
342
+ // TODO(burdon): Is there a better (finer grained) way to do this?
343
+ //
344
+ EditorView.updateListener.of(({ view, state, changes }) => {
345
+ const cursorConverter = view.state.facet(CursorConverter);
346
+
347
+ //
348
+ // Test if need to recompute indexed range if document changes before the end of the range.
349
+ //
350
+ {
351
+ let mod = false;
352
+ const { active, ranges } = state.field(commentsStateField);
353
+ changes.iterChanges((from, to, from2, to2) => {
354
+ ranges.forEach((range) => {
355
+ if (from2 === to2) {
356
+ const newRange = getRangeFromCursor(cursorConverter, range.cursor);
357
+ if (!newRange || newRange.to - newRange.from === 0) {
358
+ // TODO(burdon): Delete range if empty.
359
+ log.info('deleted comment', { thread: range.id });
360
+ }
361
+ }
362
+
363
+ if (from <= range.to) {
364
+ const newRange = getRangeFromCursor(cursorConverter, range.cursor);
365
+ Object.assign(range, newRange);
366
+ mod = true;
367
+ }
368
+ });
369
+ });
370
+
371
+ if (mod) {
372
+ view.dispatch({ effects: setCommentState.of({ active, ranges }) });
373
+ }
374
+ }
375
+
376
+ //
377
+ // Track the current selection.
378
+ //
379
+ {
380
+ const { head } = state.selection.main;
381
+
382
+ let min = Infinity;
383
+ const { active, closest, ranges } = state.field(commentsStateField);
384
+ const selected: CommentSelected = { active: undefined, closest: undefined };
385
+ ranges.forEach((comment) => {
386
+ const d = Math.min(Math.abs(head - comment.from), Math.abs(head - comment.to));
387
+ if (head >= comment.from && head <= comment.to) {
388
+ selected.active = comment.id;
389
+ }
390
+ if (d < min) {
391
+ selected.closest = comment.id;
392
+ min = d;
393
+ }
394
+ });
395
+
396
+ if (selected.active !== active || selected.closest !== closest) {
397
+ view.dispatch({ effects: setSelection.of(selected) });
398
+
399
+ // Update callback.
400
+ handleSelect({
401
+ ...selected,
402
+ ranges: ranges.map((range) => ({ ...range, location: view.coordsAtPos(range.from) })),
403
+ });
404
+ }
405
+ }
406
+ }),
407
+ ];
408
+ };
409
+
410
+ const getCursorFromRange = (cursorConverter: CursorConverter, range: Range) => {
411
+ const from = cursorConverter.toCursor(range.from);
412
+ const to = cursorConverter.toCursor(range.to, -1);
413
+ return [from, to].join(':');
414
+ };
415
+
416
+ const getRangeFromCursor = (cursorConverter: CursorConverter, cursor: string) => {
417
+ const parts = cursor.split(':');
418
+ const from = cursorConverter.fromCursor(parts[0]);
419
+ const to = cursorConverter.fromCursor(parts[1]);
420
+ return from && to ? { from, to } : undefined;
421
+ };
@@ -0,0 +1,74 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import {
6
+ Decoration,
7
+ type DecorationSet,
8
+ EditorView,
9
+ MatchDecorator,
10
+ ViewPlugin,
11
+ type ViewUpdate,
12
+ WidgetType,
13
+ } from '@codemirror/view';
14
+ import get from 'lodash.get';
15
+
16
+ import { tokens } from '../styles';
17
+
18
+ // TODO(burdon): Reconcile with theme.
19
+ const styles = EditorView.baseTheme({
20
+ '& .cm-hr': {
21
+ // TODO(burdon): ???
22
+ // Note that block-level decorations should not have vertical margins,
23
+ borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
24
+ },
25
+ });
26
+
27
+ class HorizontalRuleWidget extends WidgetType {
28
+ constructor(readonly _pos: number) {
29
+ super();
30
+ }
31
+
32
+ override eq(other: WidgetType) {
33
+ return this._pos === (other as any as HorizontalRuleWidget)._pos;
34
+ }
35
+
36
+ toDOM(view: EditorView) {
37
+ // TODO(burdon): Create <hr> element? Does this clash with markdown parser?
38
+ const el = document.createElement('div');
39
+ el.className = 'cm-hr';
40
+ return el;
41
+ }
42
+ }
43
+
44
+ const placeholderMatcher = new MatchDecorator({
45
+ regexp: /^---$/g,
46
+ decoration: (match, view, pos) =>
47
+ Decoration.replace({
48
+ widget: new HorizontalRuleWidget(pos),
49
+ }),
50
+ });
51
+
52
+ export const hr = () => [
53
+ styles,
54
+ ViewPlugin.fromClass(
55
+ class {
56
+ rules: DecorationSet;
57
+ constructor(view: EditorView) {
58
+ this.rules = placeholderMatcher.createDeco(view);
59
+ }
60
+
61
+ update(update: ViewUpdate) {
62
+ this.rules = placeholderMatcher.updateDeco(update, this.rules);
63
+ }
64
+ },
65
+ {
66
+ decorations: (instance) => instance.rules,
67
+ // TODO(burdon): Is this really atomic (cursor can move into ---).
68
+ provide: (plugin) =>
69
+ EditorView.atomicRanges.of((view) => {
70
+ return view.plugin(plugin)?.rules || Decoration.none;
71
+ }),
72
+ },
73
+ ),
74
+ ];
@@ -38,6 +38,7 @@ const update = (state: EditorState, options: ImageOptions) => {
38
38
  hide ? node.from : node.to,
39
39
  node.to,
40
40
  Decoration.replace({
41
+ block: true, // Prevent cursor from entering.
41
42
  widget: new ImageWidget(url),
42
43
  }),
43
44
  );
@@ -54,8 +55,9 @@ class ImageWidget extends WidgetType {
54
55
  super();
55
56
  }
56
57
 
58
+ // TODO(burdon): Does this need to be unique for each position?
57
59
  override eq(other: WidgetType) {
58
- return this._url === (other as any as ImageWidget)?._url;
60
+ return this._url === (other as any as ImageWidget)._url;
59
61
  }
60
62
 
61
63
  toDOM(view: EditorView) {
@@ -3,17 +3,20 @@
3
3
  //
4
4
 
5
5
  export * from './autocomplete';
6
+ export * from './automerge';
7
+ export * from './awareness';
6
8
  export * from './basic';
7
9
  export * from './blast';
8
10
  export * from './code';
9
- export * from './demo';
10
11
  export * from './comments';
11
- export * from './highlight';
12
+ export * from './hr';
12
13
  export * from './image';
13
14
  export * from './link';
14
15
  export * from './listener';
15
16
  export * from './markdown';
16
17
  export * from './mention';
18
+ export * from './mermaid';
17
19
  export * from './table';
18
20
  export * from './tasklist';
19
- export * from './tooltip';
21
+ export * from './typewriter';
22
+ export * from './yjs';
@@ -12,7 +12,11 @@ import {
12
12
  StateField,
13
13
  type Transaction,
14
14
  } from '@codemirror/state';
15
- import { Decoration, EditorView, WidgetType } from '@codemirror/view';
15
+ import { Decoration, EditorView, WidgetType, hoverTooltip } from '@codemirror/view';
16
+
17
+ import { tooltipContent } from '@dxos/react-ui-theme';
18
+
19
+ const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)/;
16
20
 
17
21
  // Adapted from:
18
22
  // https://codemirror.net/try/?c=aW1wb3J0IHsgYmFzaWNTZXR1cCwgRWRpdG9yVmlldyB9IGZyb20gImNvZGVtaXJyb3IiCmltcG9ydCB7IG1hcmtkb3duIH0gZnJvbSAiQGNvZGVtaXJyb3IvbGFuZy1tYXJrZG93biIKaW1wb3J0IHsgc3ludGF4VHJlZSB9IGZyb20gIkBjb2RlbWlycm9yL2xhbmd1YWdlIjsKaW1wb3J0IHsgRWRpdG9yU3RhdGUsIFJhbmdlU2V0QnVpbGRlciwgU3RhdGVGaWVsZCB9IGZyb20gIkBjb2RlbWlycm9yL3N0YXRlIjsKaW1wb3J0IHsgRGVjb3JhdGlvbiwgV2lkZ2V0VHlwZSB9IGZyb20gIkBjb2RlbWlycm9yL3ZpZXciOwoKY2xhc3MgTGluayBleHRlbmRzIFdpZGdldFR5cGUgewogIGNvbnN0cnVjdG9yKHRleHQsIHVybCkgewogICAgc3VwZXIoKQogICAgdGhpcy50ZXh0ID0gdGV4dAogICAgdGhpcy51cmwgPSB1cmwKICB9CiAgZXEob3RoZXIpIHsgcmV0dXJuIHRoaXMudGV4dCA9PSBvdGhlci50ZXh0ICYmIHRoaXMudXJsID09IG90aGVyLnVybCB9CiAgdG9ET00oKSB7CiAgICBsZXQgbGluayA9IGRvY3VtZW50LmNyZWF0ZUVsZW1lbnQoImEiKQogICAgbGluay50ZXh0Q29udGVudCA9IHRoaXMudGV4dAogICAgbGluay5ocmVmID0gdGhpcy51cmwKICAgIHJldHVybiBsaW5rOwogIH0KfQoKbGV0IGRlY29yYXRpb25zRmllbGQgPSBTdGF0ZUZpZWxkLmRlZmluZSh7CiAgY3JlYXRlKCkgewogICAgcmV0dXJuIERlY29yYXRpb24ubm9uZTsKICB9LAogIHVwZGF0ZShfLCB0cikgewogICAgY29uc3QgYnVpbGRlciA9IG5ldyBSYW5nZVNldEJ1aWxkZXIoKTsKICAgIGxldCBjdXJzb3IgPSB0ci5zdGF0ZS5zZWxlY3Rpb24ubWFpbi5oZWFkOwogICAgc3ludGF4VHJlZSh0ci5zdGF0ZSkuaXRlcmF0ZSh7CiAgICAgIGVudGVyOiAobm9kZSkgPT4gewogICAgICAgIGlmICgoY3Vyc29yIDwgbm9kZS5mcm9tIHx8IGN1cnNvciA+IG5vZGUudG8pICYmIG5vZGUubmFtZSA9PSAiTGluayIpIHsKICAgICAgICAgIGxldCBtYXJrcyA9IG5vZGUubm9kZS5nZXRDaGlsZHJlbigiTGlua01hcmsiKTsKICAgICAgICAgIGxldCB0ZXh0ID0gbWFya3MubGVuZ3RoID49IDIgPyB0ci5zdGF0ZS5zbGljZURvYyhtYXJrc1swXS50bywgbWFya3NbMV0uZnJvbSkgOiAiIgoKICAgICAgICAgIGxldCB1cmxOb2RlID0gbm9kZS5ub2RlLmdldENoaWxkKCJVUkwiKTsKICAgICAgICAgIGxldCB1cmwgPSB1cmxOb2RlID8gdHIuc3RhdGUuc2xpY2VEb2ModXJsTm9kZS5mcm9tLCB1cmxOb2RlLnRvKSA6ICIiCiAgICAgICAgICBidWlsZGVyLmFkZChub2RlLmZyb20sIG5vZGUudG8sIERlY29yYXRpb24ucmVwbGFjZSh7CiAgICAgICAgICAgIHdpZGdldDogbmV3IExpbmsodGV4dCwgdXJsKSwKICAgICAgICAgIH0pLAogICAgICAgICAgICAgICAgICAgICApOwogICAgICAgICAgcmV0dXJuIGZhbHNlOwogICAgICAgIH0KICAgICAgICByZXR1cm4gdHJ1ZTsKICAgICAgfSwKICAgIH0pOwogICAgcmV0dXJuIGJ1aWxkZXIuZmluaXNoKCk7CiAgfSwKICBwcm92aWRlOiAoZikgPT4gRWRpdG9yVmlldy5kZWNvcmF0aW9ucy5mcm9tKGYpLAp9KTsKCmxldCB2aWV3ID0gbmV3IEVkaXRvclZpZXcoewogIGRvYzogIiMgSGVsbG8gV29ybGRcblxuW1Rlc3RdKGh0dHBzOi8vZXhhbXBsZS5jb20pXG5cblxuIiwKICBleHRlbnNpb25zOiBbZGVjb3JhdGlvbnNGaWVsZCwgbWFya2Rvd24oKV0sCiAgcGFyZW50OiBkb2N1bWVudC5ib2R5LAp9KTsKCnZpZXcuZm9jdXMoKTs=
@@ -20,6 +24,7 @@ import { Decoration, EditorView, WidgetType } from '@codemirror/view';
20
24
 
21
25
  export type LinkOptions = {
22
26
  link?: boolean;
27
+ onHover?: (el: Element, url: string) => void;
23
28
  onRender?: (el: Element, url: string) => void;
24
29
  };
25
30
 
@@ -28,11 +33,62 @@ export type LinkOptions = {
28
33
  * https://codemirror.net/docs/ref/#state.StateField
29
34
  */
30
35
  export const link = (options: LinkOptions = {}): Extension => {
31
- return StateField.define<RangeSet<any>>({
32
- create: (state) => update(state, options),
33
- update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
34
- provide: (field) => EditorView.decorations.from(field),
35
- });
36
+ const extensions: Extension[] = [
37
+ StateField.define<RangeSet<any>>({
38
+ create: (state) => update(state, options),
39
+ update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
40
+ provide: (field) => EditorView.decorations.from(field),
41
+ }),
42
+ ];
43
+
44
+ if (options.onHover) {
45
+ extensions.push(
46
+ // https://codemirror.net/examples/tooltip
47
+ // https://codemirror.net/docs/ref/#view.hoverTooltip
48
+ // https://github.com/codemirror/view/blob/main/src/tooltip.ts
49
+ hoverTooltip((view, pos) => {
50
+ const { from, text } = view.state.doc.lineAt(pos);
51
+ const p = pos - from;
52
+
53
+ let idx = 0;
54
+ let match;
55
+ do {
56
+ match = text.substring(idx).match(markdownLinkRegexp);
57
+ if (!match) {
58
+ match = undefined;
59
+ break;
60
+ }
61
+
62
+ idx = text.indexOf(match[0]);
63
+ if (p >= idx && p < idx + match[0].length) {
64
+ break;
65
+ }
66
+
67
+ idx += match[0].length;
68
+ } while (true);
69
+
70
+ if (!match) {
71
+ return null;
72
+ }
73
+
74
+ const [, , url] = match ?? [];
75
+
76
+ return {
77
+ pos: idx + from,
78
+ end: idx + from + match[0].length,
79
+ above: true,
80
+ create: () => {
81
+ const el = document.createElement('div');
82
+ el.className = tooltipContent({}, 'pli-2 plb-1');
83
+ options.onHover!(el, url);
84
+ return { dom: el, offset: { x: 0, y: 4 } };
85
+ },
86
+ };
87
+ }),
88
+ );
89
+ }
90
+
91
+ return extensions;
36
92
  };
37
93
 
38
94
  class LinkButton extends WidgetType {
@@ -56,12 +112,12 @@ class LinkButton extends WidgetType {
56
112
  }
57
113
 
58
114
  class LinkText extends WidgetType {
59
- constructor(private readonly _pos: number, private readonly _text: string, private readonly _url?: string) {
115
+ constructor(private readonly _text: string, private readonly _url?: string) {
60
116
  super();
61
117
  }
62
118
 
63
119
  override eq(other: LinkText) {
64
- return this._pos === other._pos && this._url === other._url;
120
+ return this._url === other._url;
65
121
  }
66
122
 
67
123
  toDOM(view: EditorView) {
@@ -76,7 +132,7 @@ class LinkText extends WidgetType {
76
132
  link.onclick = () => {
77
133
  view.dispatch({
78
134
  selection: {
79
- anchor: this._pos,
135
+ anchor: view.posAtDOM(link),
80
136
  },
81
137
  });
82
138
  };
@@ -112,7 +168,7 @@ const update = (state: EditorState, options: LinkOptions) => {
112
168
  node.from,
113
169
  node.to,
114
170
  Decoration.replace({
115
- widget: new LinkText(node.from, text, options.link ? url : undefined),
171
+ widget: new LinkText(text, options.link ? url : undefined),
116
172
  }),
117
173
  );
118
174
  }
@@ -0,0 +1,35 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { type Extension } from '@codemirror/state';
6
+ import { EditorView } from '@codemirror/view';
7
+
8
+ export type ListenerOptions = {
9
+ onFocus?: (focused: boolean) => void;
10
+ onChange?: (text: string) => void;
11
+ };
12
+
13
+ /**
14
+ * Event listener.
15
+ */
16
+ export const listener = ({ onFocus, onChange }: ListenerOptions): Extension => {
17
+ const extensions: Extension[] = [];
18
+
19
+ onFocus &&
20
+ extensions.push(
21
+ EditorView.focusChangeEffect.of((_, focused) => {
22
+ onFocus(focused);
23
+ return null;
24
+ }),
25
+ );
26
+
27
+ onChange &&
28
+ extensions.push(
29
+ EditorView.updateListener.of((update) => {
30
+ onChange(update.state.doc.toString());
31
+ }),
32
+ );
33
+
34
+ return extensions;
35
+ };