@dxos/react-ui-editor 0.3.11-next.e28df4f → 0.3.11-next.ee2b64c

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.
@@ -1,26 +0,0 @@
1
- import '@dxosTheme';
2
- import { type EditorView } from '@codemirror/view';
3
- import React from 'react';
4
- type StoryProps = {
5
- text?: string;
6
- autoCreate?: boolean;
7
- };
8
- declare const _default: {
9
- title: string;
10
- component: React.ForwardRefExoticComponent<import("./TextEditor").TextEditorProps & React.RefAttributes<EditorView>>;
11
- decorators: import("@storybook/react").Decorator[];
12
- render: (args: StoryProps) => JSX.Element;
13
- };
14
- export default _default;
15
- export declare const Default: {
16
- args: {
17
- text: string;
18
- };
19
- };
20
- export declare const Testing: {
21
- args: {
22
- text: string;
23
- autoCreate: boolean;
24
- };
25
- };
26
- //# sourceMappingURL=comments.stories.d.ts.map
@@ -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"}
@@ -1,357 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import '@dxosTheme';
6
-
7
- import { type EditorView, keymap } from '@codemirror/view';
8
- import { faker } from '@faker-js/faker';
9
- import { Check, Trash } from '@phosphor-icons/react';
10
- import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
11
-
12
- import { getTextContent, TextObject } from '@dxos/echo-schema';
13
- import { PublicKey } from '@dxos/keys';
14
- import { log } from '@dxos/log';
15
- import { Button, DensityProvider } from '@dxos/react-ui';
16
- import { fixedInsetFlexLayout, mx } from '@dxos/react-ui-theme';
17
- import { withTheme } from '@dxos/storybook-utils';
18
-
19
- import { MarkdownEditor, TextEditor } from './TextEditor';
20
- import { comments, type CommentsOptions, focusComment, useComments } from '../../extensions';
21
- import { type Comment, type Range, useTextModel } from '../../hooks';
22
-
23
- faker.seed(101);
24
-
25
- //
26
- // Editor
27
- //
28
-
29
- const Editor: FC<{
30
- item: { text: TextObject };
31
- comments: Comment[];
32
- selected?: string;
33
- onCreateComment: CommentsOptions['onCreate'];
34
- onDeleteComment: CommentsOptions['onDelete'];
35
- onUpdateComment: CommentsOptions['onUpdate'];
36
- onSelectComment: CommentsOptions['onSelect'];
37
- }> = ({
38
- item,
39
- selected: selectedValue,
40
- comments: commentRanges,
41
- onCreateComment,
42
- onDeleteComment,
43
- onUpdateComment,
44
- onSelectComment,
45
- }) => {
46
- const model = useTextModel({ text: item.text });
47
- const view = useRef<EditorView>(null);
48
- const [selected, setSelected] = useState<string>();
49
- useEffect(() => {
50
- if (!view.current?.hasFocus && selectedValue !== selected) {
51
- setSelected(selectedValue);
52
- if (selectedValue) {
53
- focusComment(view.current!, selectedValue);
54
- }
55
- }
56
- }, [selected, commentRanges, selectedValue]);
57
-
58
- useComments(view.current, commentRanges);
59
-
60
- const extensions = useMemo(() => {
61
- return [
62
- comments({
63
- onCreate: onCreateComment,
64
- onDelete: onDeleteComment,
65
- onUpdate: onUpdateComment,
66
- onSelect: onSelectComment,
67
- }),
68
- ];
69
- }, []);
70
-
71
- if (!model) {
72
- return null;
73
- }
74
-
75
- // TODO(burdon): Highlight currently selected comment.
76
- return (
77
- <div className='flex grow overflow-y-scroll'>
78
- <MarkdownEditor ref={view} model={model} extensions={extensions} />
79
- </div>
80
- );
81
- };
82
-
83
- //
84
- // Comments thread
85
- //
86
-
87
- type CommentThread = {
88
- id: string;
89
- cursor?: string;
90
- range?: Range;
91
- yPos?: number;
92
- messages: TextObject[];
93
- };
94
-
95
- const Thread: FC<{
96
- thread: CommentThread;
97
- selected: boolean;
98
- onSelect: () => void;
99
- onResolve: () => void;
100
- }> = ({ thread, selected, onSelect, onResolve }) => {
101
- const [focus, setFocus] = useState(false);
102
- const [item, setItem] = useState({ text: new TextObject() });
103
- const model = useTextModel({ text: item.text });
104
- const editorRef = useRef<EditorView>(null);
105
-
106
- const containerRef = useRef<HTMLDivElement>(null);
107
- useEffect(() => {
108
- if (selected) {
109
- containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
110
- if (thread.messages.length === 0) {
111
- setFocus(true);
112
- }
113
- }
114
- }, [selected]);
115
-
116
- const handleCreateMessage = () => {
117
- const text = model?.text().trim();
118
- if (text?.length) {
119
- thread.messages.push(item.text);
120
- setItem({ text: new TextObject() });
121
- setFocus(true);
122
- }
123
- };
124
-
125
- if (!model) {
126
- return null;
127
- }
128
-
129
- return (
130
- <div
131
- className={mx(
132
- 'flex flex-col m-1 rounded shadow divide-y bg-white',
133
- selected && 'ring',
134
- !thread.cursor && 'opacity-50',
135
- )}
136
- >
137
- <div className='flex p-2 gap-2 items-center text-xs font-mono text-neutral-500 font-thin'>
138
- <span>id:{thread.id.slice(0, 4)}</span>
139
- <span>from:{thread.range?.from}</span>
140
- <span>to:{thread.range?.to}</span>
141
- <span>y:{thread.yPos}</span>
142
- <span className='grow' />
143
- {!thread.cursor && <Trash />}
144
- </div>
145
-
146
- {thread.messages.map((message, i) => (
147
- // TODO(burdon): Fix default editor padding so content doesn't jump on creating message.
148
- <div key={i} className='p-2' onClick={() => onSelect()}>
149
- {getTextContent(message)}
150
- </div>
151
- ))}
152
-
153
- <div ref={containerRef} className='flex' onClick={() => onSelect()}>
154
- <TextEditor
155
- ref={editorRef}
156
- autoFocus={focus}
157
- model={model}
158
- placeholder={'Enter comment...'}
159
- slots={{ root: { className: 'grow rounded-b' } }}
160
- extensions={[
161
- keymap.of([
162
- {
163
- key: 'Enter',
164
- run: () => {
165
- handleCreateMessage();
166
- return true;
167
- },
168
- },
169
- ]),
170
- ]}
171
- />
172
- <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
173
- <Check />
174
- </Button>
175
- </div>
176
- </div>
177
- );
178
- };
179
-
180
- const Sidebar: FC<{
181
- threads: CommentThread[];
182
- selected?: string;
183
- onSelect: (thread: string) => void;
184
- onResolve: (thread: string) => void;
185
- }> = ({ threads, selected, onSelect, onResolve }) => {
186
- // Sort by y-position.
187
- const sortedThreads = useMemo(() => {
188
- const sorted = [...threads];
189
- return sorted.sort(({ yPos: a = Infinity }, { yPos: b = Infinity }) => {
190
- return a < b ? -1 : a > b ? 1 : 0;
191
- });
192
- }, [threads]);
193
-
194
- return (
195
- <DensityProvider density='fine'>
196
- <div className='flex flex-col grow overflow-y-scroll py-4 gap-4'>
197
- {sortedThreads.map((thread) => (
198
- <Thread
199
- key={thread.id}
200
- thread={thread}
201
- selected={thread.id === selected}
202
- onSelect={() => onSelect(thread.id)}
203
- onResolve={() => onResolve(thread.id)}
204
- />
205
- ))}
206
- </div>
207
- </DensityProvider>
208
- );
209
- };
210
-
211
- //
212
- // Story container.
213
- //
214
-
215
- type StoryProps = {
216
- text?: string;
217
- autoCreate?: boolean;
218
- };
219
-
220
- const Story = ({ text, autoCreate }: StoryProps) => {
221
- const [item] = useState({ text: new TextObject(text) });
222
- const [threads, setThreads] = useState<CommentThread[]>([]);
223
- const [selected, setSelected] = useState<string>();
224
-
225
- const comments = useMemo<Comment[]>(() => threads.map(({ id, cursor }) => ({ id, cursor })), [threads]);
226
-
227
- // Filter by visibility.
228
- const visibleThreads = useMemo(() => threads.filter((thread) => thread.yPos !== undefined), [threads]);
229
-
230
- const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
231
- const id = PublicKey.random().toHex();
232
- log.info('create', { id: id.slice(0, 4), cursor });
233
- setThreads((threads) => [
234
- ...threads,
235
- {
236
- id,
237
- cursor,
238
- yPos: location ? Math.floor(location.top) : undefined,
239
- messages: autoCreate
240
- ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
241
- : [],
242
- },
243
- ]);
244
- setSelected(id); // TODO(burdon): Not required.
245
- return id;
246
- };
247
-
248
- const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
249
- log.info('delete', { id: id.slice(0, 4) });
250
- setThreads((threads) =>
251
- threads.map((thread) => {
252
- if (thread.id === id) {
253
- thread.cursor = undefined;
254
- }
255
-
256
- return thread;
257
- }),
258
- );
259
-
260
- setSelected((selected) => (selected === id ? undefined : selected));
261
- };
262
-
263
- const handleUpdateComment: CommentsOptions['onUpdate'] = (id, cursor) => {
264
- log.info('update', { id: id.slice(0, 4), cursor });
265
- setThreads((threads) =>
266
- threads.map((thread) => {
267
- if (thread.id === id) {
268
- thread.cursor = cursor;
269
- }
270
-
271
- return thread;
272
- }),
273
- );
274
- };
275
-
276
- const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { current, closest } }) => {
277
- log.info('select', { active: current?.slice(0, 4), closest: closest?.slice(0, 4) });
278
- setThreads((threads) =>
279
- threads.map((thread) => {
280
- const comment = comments.find(({ comment }) => comment.id === thread.id);
281
- if (comment) {
282
- thread.yPos = comment.location ? Math.floor(comment.location.top) : undefined;
283
- thread.range = { from: comment.range.from, to: comment.range.to };
284
- }
285
-
286
- return thread;
287
- }),
288
- );
289
-
290
- setSelected(current ?? closest);
291
- };
292
-
293
- const handleSelectThread = (id: string) => {
294
- setSelected(id);
295
- };
296
-
297
- const handleResolveThread = (id: string) => {
298
- setThreads((threads) => [...threads.filter((thread) => thread.id !== id)]);
299
- setSelected(undefined);
300
- };
301
-
302
- return (
303
- <div className={mx(fixedInsetFlexLayout, 'bg-neutral-100')}>
304
- <div className='flex justify-center h-full gap-8'>
305
- <div className='flex flex-col h-full w-[600px]'>
306
- <Editor
307
- item={item}
308
- selected={selected}
309
- comments={comments}
310
- onCreateComment={handleCreateComment}
311
- onDeleteComment={handleDeleteComment}
312
- onUpdateComment={handleUpdateComment}
313
- onSelectComment={handleSelectComment}
314
- />
315
- </div>
316
-
317
- <div className='flex flex-col h-full w-[300px]'>
318
- <Sidebar
319
- threads={visibleThreads}
320
- selected={selected}
321
- onSelect={handleSelectThread}
322
- onResolve={handleResolveThread}
323
- />
324
- </div>
325
- </div>
326
- </div>
327
- );
328
- };
329
-
330
- export default {
331
- title: 'react-ui-editor/comments',
332
- component: MarkdownEditor,
333
- decorators: [withTheme],
334
- render: (args: StoryProps) => <Story {...args} />,
335
- };
336
-
337
- const str = (...lines: string[]) => lines.join('\n');
338
-
339
- const document = str(
340
- '# Comments',
341
- '',
342
- str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
343
- '',
344
- );
345
-
346
- export const Default = {
347
- args: {
348
- text: document,
349
- },
350
- };
351
-
352
- export const Testing = {
353
- args: {
354
- text: document,
355
- autoCreate: true,
356
- },
357
- };