@folijs/react 0.3.0 → 0.4.0
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.
- package/CHANGELOG.md +28 -0
- package/dist/FoliComments.d.ts +22 -0
- package/dist/FoliComments.d.ts.map +1 -0
- package/dist/FoliComments.js +275 -0
- package/dist/FoliComments.js.map +1 -0
- package/dist/FoliEditor.d.ts +12 -1
- package/dist/FoliEditor.d.ts.map +1 -1
- package/dist/FoliEditor.js +6 -4
- package/dist/FoliEditor.js.map +1 -1
- package/dist/FoliToolbar.d.ts +6 -1
- package/dist/FoliToolbar.d.ts.map +1 -1
- package/dist/FoliToolbar.js +89 -5
- package/dist/FoliToolbar.js.map +1 -1
- package/dist/editor.d.ts +7 -1
- package/dist/editor.d.ts.map +1 -1
- package/dist/editor.js +8 -2
- package/dist/editor.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/FoliComments.tsx +499 -0
- package/src/FoliEditor.tsx +48 -4
- package/src/FoliToolbar.tsx +104 -3
- package/src/editor.tsx +15 -2
- package/src/index.ts +1 -0
- package/styles.css +104 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# @folijs/react
|
|
2
2
|
|
|
3
|
+
## 0.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- e2a6e23: Review as in Word: tracked changes recorded, shown, accepted and rejected; comments written, answered and resolved; both round-trip with Word.
|
|
8
|
+
- **Tracked changes** (`@folijs/core`): with tracking on (`createEditor({ author, trackChanges })`, `editor.commands.setTrackChanges`), every edit is recorded as Word records it: what is removed stays marked deleted, what is added is marked inserted, paragraph marks removed or added are recorded on the paragraph, formatting changes keep the properties from before the first change (`formatChange`), and deleting your own insertion removes it. Commands need no tracking code: the editor rebuilds each transaction it dispatches (`trackTransaction`). Accept and reject (`acceptChange`, `rejectChange` at the caret or in the selection, `acceptAllChanges(author?)`, `rejectAllChanges(author?)`, `nextChange`, `previousChange`, `trackedChanges(doc)`), each its own undo step; both ends of a move together. A property test checks that accepting everything gives the same document as the edits made untracked and rejecting everything gives the original.
|
|
9
|
+
- **Comments** (`@folijs/core`): `addComment`, `replyToComment`, `editComment`, `resolveComment`, `deleteComment`, `deleteAllComments`, with Word's anchors; comment changes are part of undo history (`CommentStep`); a comment whose text is deleted with its reference goes with it.
|
|
10
|
+
- **Review view** (`@folijs/core` state, drawn by `@folijs/view`): tracked changes shown as all markup (author colors, a bar beside changed paragraphs), simple markup or no markup while editing (`setReviewView`, `createEditor({ reviewView })`); while tracking, or where it is hidden, Backspace and Delete step over deleted text; the caret never goes into hidden text.
|
|
11
|
+
- **React** (`@folijs/react`): a review group in `FoliToolbar` (New comment, Track changes, Show changes as, previous and next change, Accept, Reject, Accept all, Reject all); `FoliComments`, a comments pane beside the pages (threads level with their text; reply, edit, resolve, delete), shown by `FoliEditor` while the document has comments (`comments` prop); `FoliEditor` props `author`, `trackChanges`, `reviewView`.
|
|
12
|
+
- **DOCX** (`@folijs/docx`): `DocxImport.trackRevisions` and `exportDocx(document, package?, { trackRevisions })` read and write Word's tracking setting. Checked with Word on the corpus: files with changes and comments made in Foli open without a repair prompt with those changes, authors and threads; Word's accepted and rejected text equals Foli's (case aside; table paragraphs, fields and content controls aside; one corpus document, with a content control around paragraphs, not compared); Foli reads Word's own changes and replies back.
|
|
13
|
+
|
|
14
|
+
No document format change (schema 3): 0.3.0 and 0.4.0 read each other's documents. Known limits are in [Known limitations](https://github.com/josep-audenis/foli/blob/main/docs/limitations.md) (tables are not tracked yet; dates are written in UTC).
|
|
15
|
+
|
|
16
|
+
Changed behaviour (pre-1.0 minor):
|
|
17
|
+
- A paragraph left with nothing by a join or by a deletion from its start is removed whole: the next paragraph keeps its own properties (before, the merged paragraph took the first one's).
|
|
18
|
+
- `closeHistory` makes a transaction an undo step of its own on both sides: typing right after a paste, cut or drop is now its own step.
|
|
19
|
+
- `FoliToolbar` shows a review group by default (Track changes, Show changes as, previous and next change, Accept, Reject, Accept all, Reject all); New comment only with its new `comments` prop (`FoliEditor` passes it).
|
|
20
|
+
- Tracked changes in markup are drawn in each author's color (was one fixed red), with a bar beside changed paragraphs; commented text carries `data-foli-comments`.
|
|
21
|
+
- `withEnvelope` ignores comments: change them with `setComments` (or the comment commands).
|
|
22
|
+
- `FoliEditor` puts the canvas inside a `.foli-editor-body` element (beside the comments pane): CSS that relied on `.foli-canvas` being a direct child of the editor's parent needs updating.
|
|
23
|
+
- Imported `w:rPrChange` properties are in canonical form (default attributes left out); inserted and deleted text in `renderDocument` and the editor is titled "Inserted by …" / "Deleted by …".
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- Updated dependencies [e2a6e23]
|
|
28
|
+
- @folijs/core@0.4.0
|
|
29
|
+
- @folijs/view@0.4.0
|
|
30
|
+
|
|
3
31
|
## 0.3.0
|
|
4
32
|
|
|
5
33
|
### Minor Changes
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { type Editor } from "@folijs/core";
|
|
2
|
+
export interface FoliCommentsProps {
|
|
3
|
+
/** Default: the editor of the nearest `FoliEditorProvider`. */
|
|
4
|
+
editor?: Editor | undefined;
|
|
5
|
+
/** Comments can be read, not changed (pass it with a `readOnly` canvas). */
|
|
6
|
+
readOnly?: boolean | undefined;
|
|
7
|
+
/** Accessible name of the pane (default "Comments"). */
|
|
8
|
+
label?: string | undefined;
|
|
9
|
+
className?: string | undefined;
|
|
10
|
+
/** Not shown (still following the editor: a comment made meanwhile opens for writing). */
|
|
11
|
+
hidden?: boolean | undefined;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The comments pane: the document's comment threads beside the pages, each next to its text,
|
|
15
|
+
* moved down when they would overlap. Focusing a thread marks its text in the document; a
|
|
16
|
+
* caret in commented text marks its thread. Reply, edit (plain text), resolve, reopen and
|
|
17
|
+
* delete; a comment made empty while the pane shows (the toolbar's "New comment") opens for
|
|
18
|
+
* writing, and goes when cancelled empty. Render it beside the pages (`FoliEditor` does): it
|
|
19
|
+
* finds the comments' text in the nearest ancestor holding them.
|
|
20
|
+
*/
|
|
21
|
+
export declare function FoliComments({ editor: editorProp, readOnly, label, className, hidden, }: FoliCommentsProps): import("react").JSX.Element;
|
|
22
|
+
//# sourceMappingURL=FoliComments.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FoliComments.d.ts","sourceRoot":"","sources":["../src/FoliComments.tsx"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,MAAM,EAOZ,MAAM,cAAc,CAAC;AAItB,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,wDAAwD;IACxD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,0FAA0F;IAC1F,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B;AAkGD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,EAC3B,MAAM,EAAE,UAAU,EAClB,QAAgB,EAChB,KAAkB,EAClB,SAAS,EACT,MAAc,GACf,EAAE,iBAAiB,+BAyNnB"}
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { commentAnchors, deleteComment, editComment, replyToComment, resolveComment, wordContext, } from "@folijs/core";
|
|
3
|
+
import { useEffect, useId, useRef, useState } from "react";
|
|
4
|
+
import { useEditorOrContext, useEditorState, useIsomorphicLayoutEffect } from "./editor.js";
|
|
5
|
+
const EMPTY = [];
|
|
6
|
+
/** The comments of the editor's document, as threads in document order. */
|
|
7
|
+
function threadsOf(state, comments) {
|
|
8
|
+
const anchors = commentAnchors(state.doc);
|
|
9
|
+
const byId = new Map(comments.map((c) => [c.id, c]));
|
|
10
|
+
const rootOf = (c) => {
|
|
11
|
+
let root = c;
|
|
12
|
+
const seen = new Set();
|
|
13
|
+
while (root.parent !== undefined && byId.has(root.parent) && !seen.has(root.id)) {
|
|
14
|
+
seen.add(root.id);
|
|
15
|
+
root = byId.get(root.parent);
|
|
16
|
+
}
|
|
17
|
+
return root;
|
|
18
|
+
};
|
|
19
|
+
const threads = new Map();
|
|
20
|
+
for (const c of comments) {
|
|
21
|
+
const root = rootOf(c);
|
|
22
|
+
let thread = threads.get(root.id);
|
|
23
|
+
if (!thread) {
|
|
24
|
+
const a = anchors.get(root.id);
|
|
25
|
+
const pos = a?.start ?? a?.reference ?? Number.MAX_SAFE_INTEGER;
|
|
26
|
+
thread = { comment: root, replies: [], pos, end: a?.end ?? a?.reference ?? pos };
|
|
27
|
+
threads.set(root.id, thread);
|
|
28
|
+
}
|
|
29
|
+
if (c !== root)
|
|
30
|
+
thread.replies.push(c);
|
|
31
|
+
}
|
|
32
|
+
return [...threads.values()].sort((a, b) => a.pos - b.pos || a.comment.id - b.comment.id);
|
|
33
|
+
}
|
|
34
|
+
/** A paragraph's text as shown: tabs and line breaks kept. */
|
|
35
|
+
const paragraphText = (p) => (p.content ?? [])
|
|
36
|
+
.map((n) => n.type === "text"
|
|
37
|
+
? (n.text ?? "")
|
|
38
|
+
: n.type === "tab"
|
|
39
|
+
? "\t"
|
|
40
|
+
: n.type === "hardBreak"
|
|
41
|
+
? "\n"
|
|
42
|
+
: "")
|
|
43
|
+
.join("");
|
|
44
|
+
/** A comment's text: its paragraphs' text, a line each. */
|
|
45
|
+
const textOf = (c) => c.content.map(paragraphText).join("\n");
|
|
46
|
+
/**
|
|
47
|
+
* Whether the pane edits a comment as text without losing anything: paragraphs of unformatted
|
|
48
|
+
* text, all in one paragraph style or none (Word gives its comments the CommentText style).
|
|
49
|
+
*/
|
|
50
|
+
function plain(c) {
|
|
51
|
+
const styles = new Set(c.content.map((p) => p.attrs?.style));
|
|
52
|
+
return (styles.size <= 1 &&
|
|
53
|
+
c.content.every((p) => p.type === "paragraph" &&
|
|
54
|
+
Object.keys(p.attrs ?? {}).every((key) => key === "style") &&
|
|
55
|
+
(p.content ?? []).every((n) => n.type === "text" && !n.marks?.length)));
|
|
56
|
+
}
|
|
57
|
+
/** `text` as `c`'s content: a paragraph per line, in `c`'s paragraph style. */
|
|
58
|
+
function contentLike(c, text) {
|
|
59
|
+
const style = c.content[0]?.attrs?.style;
|
|
60
|
+
return text.split(/\r\n|\r|\n/).map((line) => ({
|
|
61
|
+
type: "paragraph",
|
|
62
|
+
...(style ? { attrs: { style } } : {}),
|
|
63
|
+
...(line ? { content: [{ type: "text", text: line }] } : {}),
|
|
64
|
+
}));
|
|
65
|
+
}
|
|
66
|
+
const isEmpty = (c) => textOf(c).trim() === "";
|
|
67
|
+
/** The nearest ancestor of the pane that holds the editor's pages. */
|
|
68
|
+
function pagesAround(pane) {
|
|
69
|
+
let element = pane.parentElement;
|
|
70
|
+
while (element && !element.querySelector(".foli-page"))
|
|
71
|
+
element = element.parentElement;
|
|
72
|
+
return element;
|
|
73
|
+
}
|
|
74
|
+
const dateOf = (date) => (date ? date.slice(0, 10) : "");
|
|
75
|
+
const nameOf = (c) => c.author || "an unknown author";
|
|
76
|
+
/**
|
|
77
|
+
* The comments pane: the document's comment threads beside the pages, each next to its text,
|
|
78
|
+
* moved down when they would overlap. Focusing a thread marks its text in the document; a
|
|
79
|
+
* caret in commented text marks its thread. Reply, edit (plain text), resolve, reopen and
|
|
80
|
+
* delete; a comment made empty while the pane shows (the toolbar's "New comment") opens for
|
|
81
|
+
* writing, and goes when cancelled empty. Render it beside the pages (`FoliEditor` does): it
|
|
82
|
+
* finds the comments' text in the nearest ancestor holding them.
|
|
83
|
+
*/
|
|
84
|
+
export function FoliComments({ editor: editorProp, readOnly = false, label = "Comments", className, hidden = false, }) {
|
|
85
|
+
const editor = useEditorOrContext(editorProp, "FoliComments");
|
|
86
|
+
const comments = useEditorState((state) => wordContext(state)?.envelope.comments ?? EMPTY, {
|
|
87
|
+
editor,
|
|
88
|
+
});
|
|
89
|
+
const documentId = useEditorState((state) => wordContext(state)?.id ?? "", { editor });
|
|
90
|
+
const doc = useEditorState((state) => state.doc, { editor });
|
|
91
|
+
const head = useEditorState((state) => state.selection.head, { editor });
|
|
92
|
+
const threads = threadsOf(editor.state, comments);
|
|
93
|
+
const pane = useRef(null);
|
|
94
|
+
const [tops, setTops] = useState([]);
|
|
95
|
+
const [height, setHeight] = useState(0);
|
|
96
|
+
const [writing, setWriting] = useState(null);
|
|
97
|
+
const [focused, setFocused] = useState(null);
|
|
98
|
+
/** The comments the pane has seen, per document: only ones made later open for writing. */
|
|
99
|
+
const known = useRef(null);
|
|
100
|
+
/** The comments the pane opened for writing: cancelled while empty, they go. */
|
|
101
|
+
const created = useRef(new Set());
|
|
102
|
+
/** After a change, the element to focus (the next thread, the button that opened a form). */
|
|
103
|
+
const refocus = useRef(null);
|
|
104
|
+
useEffect(() => {
|
|
105
|
+
const seen = known.current;
|
|
106
|
+
const same = seen?.document === documentId;
|
|
107
|
+
const objects = same ? seen.objects : new WeakSet();
|
|
108
|
+
known.current = { document: documentId, objects, ids: new Set(comments.map((c) => c.id)) };
|
|
109
|
+
// New: an id that was not there, and an object never seen (not one undo brought back).
|
|
110
|
+
const fresh = same ? comments.find((c) => !seen.ids.has(c.id) && !objects.has(c)) : undefined;
|
|
111
|
+
for (const c of comments)
|
|
112
|
+
objects.add(c);
|
|
113
|
+
// The first render, or another document: what is there was not made here, and nothing
|
|
114
|
+
// open for writing belongs to it.
|
|
115
|
+
if (!same) {
|
|
116
|
+
if (seen) {
|
|
117
|
+
created.current.clear();
|
|
118
|
+
setWriting(null);
|
|
119
|
+
}
|
|
120
|
+
return;
|
|
121
|
+
}
|
|
122
|
+
// A comment that comes back (undo) is the very object seen before: not new.
|
|
123
|
+
if (fresh && !readOnly && isEmpty(fresh) && plain(fresh)) {
|
|
124
|
+
created.current.add(fresh.id);
|
|
125
|
+
setWriting({ id: fresh.id, reply: false });
|
|
126
|
+
}
|
|
127
|
+
}, [comments, documentId, readOnly]);
|
|
128
|
+
// Each thread next to its text, pushed down below the one before.
|
|
129
|
+
const measure = () => {
|
|
130
|
+
const root = pane.current;
|
|
131
|
+
const container = root && pagesAround(root);
|
|
132
|
+
if (!root || !container)
|
|
133
|
+
return;
|
|
134
|
+
const paneTop = root.getBoundingClientRect().top;
|
|
135
|
+
// The first text of each comment, in one pass.
|
|
136
|
+
const anchors = new Map();
|
|
137
|
+
for (const element of container.querySelectorAll("[data-foli-comments], [data-foli-comment-reference]")) {
|
|
138
|
+
const ids = (element.dataset.foliComments ?? element.dataset.foliCommentReference ?? "")
|
|
139
|
+
.split(" ")
|
|
140
|
+
.filter(Boolean);
|
|
141
|
+
for (const id of ids)
|
|
142
|
+
if (!anchors.has(id))
|
|
143
|
+
anchors.set(id, element);
|
|
144
|
+
}
|
|
145
|
+
const items = [...root.querySelectorAll(":scope > .foli-comment-thread")];
|
|
146
|
+
const next = [];
|
|
147
|
+
let bottom = 0;
|
|
148
|
+
threads.forEach((thread, i) => {
|
|
149
|
+
const anchor = anchors.get(String(thread.comment.id));
|
|
150
|
+
const wanted = anchor ? anchor.getBoundingClientRect().top - paneTop : bottom;
|
|
151
|
+
const top = Math.max(wanted, bottom);
|
|
152
|
+
next.push(top);
|
|
153
|
+
bottom = top + (items[i]?.offsetHeight ?? 0) + 8;
|
|
154
|
+
});
|
|
155
|
+
setTops((old) => old.length === next.length && old.every((t, i) => Math.abs(t - next[i]) < 0.5)
|
|
156
|
+
? old
|
|
157
|
+
: next);
|
|
158
|
+
setHeight(bottom);
|
|
159
|
+
};
|
|
160
|
+
const measureRef = useRef(measure);
|
|
161
|
+
measureRef.current = measure;
|
|
162
|
+
// biome-ignore lint/correctness/useExhaustiveDependencies: measured after every change of what it shows.
|
|
163
|
+
useIsomorphicLayoutEffect(measure, [doc, comments, writing, threads.length]);
|
|
164
|
+
useEffect(() => {
|
|
165
|
+
const container = pane.current && pagesAround(pane.current);
|
|
166
|
+
if (!container || typeof ResizeObserver === "undefined")
|
|
167
|
+
return;
|
|
168
|
+
const observer = new ResizeObserver(() => measureRef.current());
|
|
169
|
+
observer.observe(container);
|
|
170
|
+
return () => observer.disconnect();
|
|
171
|
+
}, []);
|
|
172
|
+
// Focus where the last action left it (after React drew the change).
|
|
173
|
+
useEffect(() => {
|
|
174
|
+
const focus = refocus.current;
|
|
175
|
+
refocus.current = null;
|
|
176
|
+
focus?.();
|
|
177
|
+
});
|
|
178
|
+
// The focused thread's text marked in the document (again after the view redraws it).
|
|
179
|
+
// biome-ignore lint/correctness/useExhaustiveDependencies: `doc` changes mean redrawn text to mark.
|
|
180
|
+
useEffect(() => {
|
|
181
|
+
const container = pane.current && pagesAround(pane.current);
|
|
182
|
+
if (!container || focused === null)
|
|
183
|
+
return;
|
|
184
|
+
const marked = [
|
|
185
|
+
...container.querySelectorAll(`[data-foli-comments~="${focused}"]`),
|
|
186
|
+
];
|
|
187
|
+
for (const element of marked)
|
|
188
|
+
element.classList.add("foli-comment-active");
|
|
189
|
+
return () => {
|
|
190
|
+
for (const element of marked)
|
|
191
|
+
element.classList.remove("foli-comment-active");
|
|
192
|
+
};
|
|
193
|
+
}, [focused, doc]);
|
|
194
|
+
const run = (command) => editor.run(command);
|
|
195
|
+
/** Focus the thread of `id` (its first button), else the pane, else the document. */
|
|
196
|
+
const focusThread = (id) => {
|
|
197
|
+
refocus.current = () => {
|
|
198
|
+
const root = pane.current;
|
|
199
|
+
const thread = id === undefined ? null : root?.querySelector(`[data-thread="${id}"]`);
|
|
200
|
+
const document = root && pagesAround(root)?.querySelector('[role="textbox"]');
|
|
201
|
+
(thread?.querySelector("button") ??
|
|
202
|
+
thread ??
|
|
203
|
+
(root?.hidden ? document : root))?.focus();
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
return (_jsxs("aside", { ref: pane, tabIndex: -1, className: `foli-comments${className ? ` ${className}` : ""}`, "aria-label": label, hidden: hidden, style: height ? { minHeight: height } : undefined, children: [threads.length === 0 && _jsx("p", { className: "foli-comments-empty", children: "No comments" }), threads.map((thread, i) => {
|
|
207
|
+
const { comment } = thread;
|
|
208
|
+
const active = head >= thread.pos && head <= thread.end + 1;
|
|
209
|
+
const after = threads[i + 1] ?? threads[i - 1];
|
|
210
|
+
const canReply = !readOnly && editor.can(replyToComment(comment.id, "x"));
|
|
211
|
+
return (_jsxs("article", { "data-thread": comment.id, tabIndex: -1, className: "foli-comment-thread", "data-active": active || undefined, "data-done": comment.done || undefined, style: { top: tops[i] ?? 0 }, "aria-label": `Comment by ${nameOf(comment)}${comment.done ? ", resolved" : ""}`, onFocus: () => setFocused(comment.id), onBlur: (e) => {
|
|
212
|
+
if (!e.currentTarget.contains(e.relatedTarget))
|
|
213
|
+
setFocused(null);
|
|
214
|
+
}, children: [[comment, ...thread.replies].map((c) => (_jsx(CommentView, { comment: c, root: c === comment, readOnly: readOnly, canReply: canReply, canDelete: !readOnly && editor.can(deleteComment(c.id)), editing: writing?.id === c.id && !writing.reply, onEdit: () => setWriting({ id: c.id, reply: false }), onReply: () => setWriting({ id: comment.id, reply: true }), onResolve: () => {
|
|
215
|
+
run(resolveComment(comment.id, !comment.done));
|
|
216
|
+
focusThread(comment.id);
|
|
217
|
+
}, onDelete: () => {
|
|
218
|
+
run(deleteComment(c.id));
|
|
219
|
+
focusThread(c === comment ? after?.comment.id : comment.id);
|
|
220
|
+
}, onSave: (text) => {
|
|
221
|
+
if (!run(editComment(c.id, contentLike(c, text))))
|
|
222
|
+
return false;
|
|
223
|
+
created.current.delete(c.id);
|
|
224
|
+
setWriting(null);
|
|
225
|
+
focusThread(comment.id);
|
|
226
|
+
return true;
|
|
227
|
+
}, onCancel: () => {
|
|
228
|
+
// A comment made here and left empty goes.
|
|
229
|
+
const gone = created.current.has(c.id) && isEmpty(c);
|
|
230
|
+
created.current.delete(c.id);
|
|
231
|
+
if (gone)
|
|
232
|
+
run(deleteComment(c.id));
|
|
233
|
+
setWriting(null);
|
|
234
|
+
focusThread(gone ? after?.comment.id : comment.id);
|
|
235
|
+
} }, c.id))), writing?.reply && writing.id === comment.id && (_jsx(CommentForm, { label: "Reply", initial: "", onSave: (text) => {
|
|
236
|
+
if (text.trim() && !run(replyToComment(comment.id, text)))
|
|
237
|
+
return false;
|
|
238
|
+
setWriting(null);
|
|
239
|
+
focusThread(comment.id);
|
|
240
|
+
return true;
|
|
241
|
+
}, onCancel: () => {
|
|
242
|
+
setWriting(null);
|
|
243
|
+
focusThread(comment.id);
|
|
244
|
+
} }))] }, comment.id));
|
|
245
|
+
})] }));
|
|
246
|
+
}
|
|
247
|
+
function CommentView({ comment, root, readOnly, canReply, canDelete, editing, onEdit, onReply, onResolve, onDelete, onSave, onCancel, }) {
|
|
248
|
+
const author = comment.author || "Unknown author";
|
|
249
|
+
const what = root ? "comment" : "reply";
|
|
250
|
+
return (_jsxs("div", { className: "foli-comment", children: [_jsxs("p", { className: "foli-comment-meta", children: [_jsx("strong", { children: author }), " ", _jsx("span", { children: dateOf(comment.date) })] }), editing ? (_jsx(CommentForm, { label: "Comment", initial: textOf(comment), onSave: onSave, onCancel: onCancel })) : (_jsx("div", { className: "foli-comment-text", children: comment.content.map((p, i) => (_jsx("p", { children: paragraphText(p) }, i))) })), !readOnly && !editing && (_jsxs("div", { className: "foli-comment-actions", children: [root && canReply && (_jsx("button", { type: "button", onClick: onReply, children: "Reply" })), plain(comment) && (_jsx("button", { type: "button", onClick: onEdit, "aria-label": `Edit ${what} by ${nameOf(comment)}`, children: "Edit" })), root && (_jsx("button", { type: "button", onClick: onResolve, children: comment.done ? "Reopen" : "Resolve" })), canDelete && (_jsx("button", { type: "button", onClick: onDelete, "aria-label": `Delete ${what} by ${nameOf(comment)}`, children: "Delete" }))] }))] }));
|
|
251
|
+
}
|
|
252
|
+
function CommentForm({ label, initial, onSave, onCancel, }) {
|
|
253
|
+
const id = useId();
|
|
254
|
+
const [text, setText] = useState(initial);
|
|
255
|
+
const [failed, setFailed] = useState(false);
|
|
256
|
+
const field = useRef(null);
|
|
257
|
+
useEffect(() => field.current?.focus(), []);
|
|
258
|
+
const save = () => setFailed(!onSave(text));
|
|
259
|
+
const submit = (e) => {
|
|
260
|
+
e.preventDefault();
|
|
261
|
+
save();
|
|
262
|
+
};
|
|
263
|
+
const keys = (e) => {
|
|
264
|
+
if (e.key === "Escape") {
|
|
265
|
+
e.preventDefault();
|
|
266
|
+
onCancel();
|
|
267
|
+
}
|
|
268
|
+
else if (e.key === "Enter" && (e.ctrlKey || e.metaKey)) {
|
|
269
|
+
e.preventDefault();
|
|
270
|
+
save();
|
|
271
|
+
}
|
|
272
|
+
};
|
|
273
|
+
return (_jsxs("form", { className: "foli-comment-form", onSubmit: submit, children: [_jsx("label", { htmlFor: id, children: label }), _jsx("textarea", { id: id, ref: field, value: text, rows: 3, onChange: (e) => setText(e.target.value), onKeyDown: keys, "aria-invalid": failed || undefined, "aria-describedby": failed ? `${id}-error` : undefined }), failed && (_jsx("p", { id: `${id}-error`, className: "foli-comment-error", role: "alert", children: "Could not be saved here." })), _jsxs("div", { className: "foli-comment-actions", children: [_jsx("button", { type: "submit", children: "Save" }), _jsx("button", { type: "button", onClick: onCancel, children: "Cancel" })] })] }));
|
|
274
|
+
}
|
|
275
|
+
//# sourceMappingURL=FoliComments.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FoliComments.js","sourceRoot":"","sources":["../src/FoliComments.tsx"],"names":[],"mappings":";AAAA,OAAO,EAEL,cAAc,EACd,aAAa,EAGb,WAAW,EAEX,cAAc,EACd,cAAc,EACd,WAAW,GACZ,MAAM,cAAc,CAAC;AACtB,OAAO,EAAsC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC/F,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAwB5F,MAAM,KAAK,GAA2B,EAAE,CAAC;AAEzC,2EAA2E;AAC3E,SAAS,SAAS,CAAC,KAAkB,EAAE,QAAgC;IACrE,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,CAAC,CAAc,EAAE,EAAE;QAChC,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAChF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAClB,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAgB,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC/B,MAAM,GAAG,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,SAAS,IAAI,MAAM,CAAC,gBAAgB,CAAC;YAChE,MAAM,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,SAAS,IAAI,GAAG,EAAE,CAAC;YACjF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,CAAC,KAAK,IAAI;YAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AAC5F,CAAC;AAED,8DAA8D;AAC9D,MAAM,aAAa,GAAG,CAAC,CAAW,EAAE,EAAE,CACpC,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;KACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACT,CAAC,CAAC,IAAI,KAAK,MAAM;IACf,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK;QAChB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,EAAE,CACX;KACA,IAAI,CAAC,EAAE,CAAC,CAAC;AAEd,2DAA2D;AAC3D,MAAM,MAAM,GAAG,CAAC,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE3E;;;GAGG;AACH,SAAS,KAAK,CAAC,CAAc;IAC3B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,KAAyC,EAAE,KAAK,CAAC,CAAC,CAAC;IAClG,OAAO,CACL,MAAM,CAAC,IAAI,IAAI,CAAC;QAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CACb,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,KAAK,WAAW;YACtB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,OAAO,CAAC;YAC1D,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CACxE,CACF,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,SAAS,WAAW,CAAC,CAAc,EAAE,IAAY;IAC/C,MAAM,KAAK,GAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAwC,EAAE,KAAK,CAAC;IAC7E,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7C,IAAI,EAAE,WAAW;QACjB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7D,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAc,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAE5D,sEAAsE;AACtE,SAAS,WAAW,CAAC,IAAiB;IACpC,IAAI,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC;IACjC,OAAO,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC;QAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IACxF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,IAAwB,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAC7E,MAAM,MAAM,GAAG,CAAC,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,mBAAmB,CAAC;AAEnE;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,MAAM,EAAE,UAAU,EAClB,QAAQ,GAAG,KAAK,EAChB,KAAK,GAAG,UAAU,EAClB,SAAS,EACT,MAAM,GAAG,KAAK,GACI;IAClB,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,QAAQ,IAAI,KAAK,EAAE;QACzF,MAAM;KACP,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACvF,MAAM,GAAG,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,MAAM,CAAc,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAW,EAAE,CAAC,CAAC;IAC/C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAwC,IAAI,CAAC,CAAC;IACpF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAC5D,2FAA2F;IAC3F,MAAM,KAAK,GAAG,MAAM,CAIV,IAAI,CAAC,CAAC;IAChB,gFAAgF;IAChF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,GAAG,EAAU,CAAC,CAAC;IAC1C,6FAA6F;IAC7F,MAAM,OAAO,GAAG,MAAM,CAAsB,IAAI,CAAC,CAAC;IAElD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,EAAE,QAAQ,KAAK,UAAU,CAAC;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,EAAe,CAAC;QACjE,KAAK,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAC3F,uFAAuF;QACvF,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,KAAK,MAAM,CAAC,IAAI,QAAQ;YAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACzC,sFAAsF;QACtF,kCAAkC;QAClC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACxB,UAAU,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;YACD,OAAO;QACT,CAAC;QACD,4EAA4E;QAC5E,IAAI,KAAK,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC9B,UAAU,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAErC,kEAAkE;IAClE,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,GAAG,CAAC;QACjD,+CAA+C;QAC/C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC/C,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,gBAAgB,CAC9C,qDAAqD,CACtD,EAAE,CAAC;YACF,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC;iBACrF,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,OAAO,CAAC,CAAC;YACnB,KAAK,MAAM,EAAE,IAAI,GAAG;gBAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAc,+BAA+B,CAAC,CAAC,CAAC;QACvF,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;YAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CACd,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAI,IAAI,CAAC,CAAC,CAAY,CAAC,GAAG,GAAG,CAAC;YACxF,CAAC,CAAC,GAAG;YACL,CAAC,CAAC,IAAI,CACT,CAAC;QACF,SAAS,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;IACF,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAC7B,yGAAyG;IACzG,yBAAyB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7E,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5D,IAAI,CAAC,SAAS,IAAI,OAAO,cAAc,KAAK,WAAW;YAAE,OAAO;QAChE,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAChE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5B,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,qEAAqE;IACrE,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;QAC9B,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,KAAK,EAAE,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,sFAAsF;IACtF,oGAAoG;IACpG,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5D,IAAI,CAAC,SAAS,IAAI,OAAO,KAAK,IAAI;YAAE,OAAO;QAC3C,MAAM,MAAM,GAAG;YACb,GAAG,SAAS,CAAC,gBAAgB,CAAc,yBAAyB,OAAO,IAAI,CAAC;SACjF,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,MAAM;YAAE,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAC3E,OAAO,GAAG,EAAE;YACV,KAAK,MAAM,OAAO,IAAI,MAAM;gBAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAChF,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAEnB,MAAM,GAAG,GAAG,CAAC,OAAqC,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3E,qFAAqF;IACrF,MAAM,WAAW,GAAG,CAAC,EAAsB,EAAE,EAAE;QAC7C,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE;YACrB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;YAC1B,MAAM,MAAM,GACV,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,CAAc,iBAAiB,EAAE,IAAI,CAAC,CAAC;YACtF,MAAM,QAAQ,GAAG,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,aAAa,CAAc,kBAAkB,CAAC,CAAC;YAC3F,CACE,MAAM,EAAE,aAAa,CAAc,QAAQ,CAAC;gBAC5C,MAAM;gBACN,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CACjC,EAAE,KAAK,EAAE,CAAC;QACb,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,CACL,iBACE,GAAG,EAAE,IAAI,EACT,QAAQ,EAAE,CAAC,CAAC,EACZ,SAAS,EAAE,gBAAgB,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,gBACjD,KAAK,EACjB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,aAEhD,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,YAAG,SAAS,EAAC,qBAAqB,4BAAgB,EAC1E,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;gBAC3B,MAAM,MAAM,GAAG,IAAI,IAAI,MAAM,CAAC,GAAG,IAAI,IAAI,IAAI,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;gBAC5D,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC/C,MAAM,QAAQ,GAAG,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC1E,OAAO,CACL,kCAEe,OAAO,CAAC,EAAE,EACvB,QAAQ,EAAE,CAAC,CAAC,EACZ,SAAS,EAAC,qBAAqB,iBAClB,MAAM,IAAI,SAAS,eACrB,OAAO,CAAC,IAAI,IAAI,SAAS,EACpC,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,gBAChB,cAAc,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,EAC9E,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,EACrC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;wBACZ,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,aAA4B,CAAC;4BAAE,UAAU,CAAC,IAAI,CAAC,CAAC;oBAClF,CAAC,aAEA,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CACvC,KAAC,WAAW,IAEV,OAAO,EAAE,CAAC,EACV,IAAI,EAAE,CAAC,KAAK,OAAO,EACnB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EACvD,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAC/C,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EACpD,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAC1D,SAAS,EAAE,GAAG,EAAE;gCACd,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gCAC/C,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;4BAC1B,CAAC,EACD,QAAQ,EAAE,GAAG,EAAE;gCACb,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gCACzB,WAAW,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;4BAC9D,CAAC,EACD,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gCACf,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;oCAAE,OAAO,KAAK,CAAC;gCAChE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gCAC7B,UAAU,CAAC,IAAI,CAAC,CAAC;gCACjB,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gCACxB,OAAO,IAAI,CAAC;4BACd,CAAC,EACD,QAAQ,EAAE,GAAG,EAAE;gCACb,2CAA2C;gCAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;gCACrD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gCAC7B,IAAI,IAAI;oCAAE,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gCACnC,UAAU,CAAC,IAAI,CAAC,CAAC;gCACjB,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;4BACrD,CAAC,IA/BI,CAAC,CAAC,EAAE,CAgCT,CACH,CAAC,EACD,OAAO,EAAE,KAAK,IAAI,OAAO,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,IAAI,CAC9C,KAAC,WAAW,IACV,KAAK,EAAC,OAAO,EACb,OAAO,EAAC,EAAE,EACV,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gCACf,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;oCAAE,OAAO,KAAK,CAAC;gCACxE,UAAU,CAAC,IAAI,CAAC,CAAC;gCACjB,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gCACxB,OAAO,IAAI,CAAC;4BACd,CAAC,EACD,QAAQ,EAAE,GAAG,EAAE;gCACb,UAAU,CAAC,IAAI,CAAC,CAAC;gCACjB,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;4BAC1B,CAAC,GACD,CACH,KAhEI,OAAO,CAAC,EAAE,CAiEP,CACX,CAAC;YACJ,CAAC,CAAC,IACI,CACT,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,EACnB,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,QAAQ,EACR,MAAM,EACN,QAAQ,GAcT;IACC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,gBAAgB,CAAC;IAClD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;IACxC,OAAO,CACL,eAAK,SAAS,EAAC,cAAc,aAC3B,aAAG,SAAS,EAAC,mBAAmB,aAC9B,2BAAS,MAAM,GAAU,OAAC,yBAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAQ,IAC3D,EACH,OAAO,CAAC,CAAC,CAAC,CACT,KAAC,WAAW,IACV,KAAK,EAAC,SAAS,EACf,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EACxB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,GAClB,CACH,CAAC,CAAC,CAAC,CACF,cAAK,SAAS,EAAC,mBAAmB,YAC/B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAE7B,sBAAY,aAAa,CAAC,CAAC,CAAC,IAApB,CAAC,CAAwB,CAClC,CAAC,GACE,CACP,EACA,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CACxB,eAAK,SAAS,EAAC,sBAAsB,aAClC,IAAI,IAAI,QAAQ,IAAI,CACnB,iBAAQ,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,OAAO,sBAE7B,CACV,EACA,KAAK,CAAC,OAAO,CAAC,IAAI,CACjB,iBACE,IAAI,EAAC,QAAQ,EACb,OAAO,EAAE,MAAM,gBACH,QAAQ,IAAI,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE,qBAGzC,CACV,EACA,IAAI,IAAI,CACP,iBAAQ,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,SAAS,YACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,GAC7B,CACV,EACA,SAAS,IAAI,CACZ,iBACE,IAAI,EAAC,QAAQ,EACb,OAAO,EAAE,QAAQ,gBACL,UAAU,IAAI,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE,uBAG3C,CACV,IACG,CACP,IACG,CACP,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,EACnB,KAAK,EACL,OAAO,EACP,MAAM,EACN,QAAQ,GAOT;IACC,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IACnB,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAsB,IAAI,CAAC,CAAC;IAChD,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,CAAC,CAAY,EAAE,EAAE;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAC;QACnB,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,CAAC,CAAqC,EAAE,EAAE;QACrD,IAAI,CAAC,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YACvB,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,QAAQ,EAAE,CAAC;QACb,CAAC;aAAM,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;YACzD,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC,CAAC;IACF,OAAO,CACL,gBAAM,SAAS,EAAC,mBAAmB,EAAC,QAAQ,EAAE,MAAM,aAClD,gBAAO,OAAO,EAAE,EAAE,YAAG,KAAK,GAAS,EACnC,mBACE,EAAE,EAAE,EAAE,EACN,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,IAAI,EACX,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EACxC,SAAS,EAAE,IAAI,kBACD,MAAM,IAAI,SAAS,sBACf,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,GACpD,EACD,MAAM,IAAI,CACT,YAAG,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAC,oBAAoB,EAAC,IAAI,EAAC,OAAO,yCAE7D,CACL,EACD,eAAK,SAAS,EAAC,sBAAsB,aACnC,iBAAQ,IAAI,EAAC,QAAQ,qBAAc,EACnC,iBAAQ,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,QAAQ,uBAE9B,IACL,IACD,CACR,CAAC;AACJ,CAAC"}
|
package/dist/FoliEditor.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type Editor, type EditorDocument, type FoliDocument, type Plugin, type Transaction } from "@folijs/core";
|
|
1
|
+
import { type Editor, type EditorDocument, type FoliDocument, type Plugin, type ReviewView, type Transaction } from "@folijs/core";
|
|
2
2
|
import { type ReactNode } from "react";
|
|
3
3
|
import { type FoliCanvasHandle, type FoliCanvasProps } from "./FoliCanvas.js";
|
|
4
4
|
/**
|
|
@@ -23,6 +23,12 @@ export interface FoliEditorProps extends Omit<FoliCanvasProps, "editor"> {
|
|
|
23
23
|
initialContent?: EditorDocument | undefined;
|
|
24
24
|
/** Read once on mount. */
|
|
25
25
|
plugins?: readonly Plugin[] | undefined;
|
|
26
|
+
/** Read once on mount: who edits (tracked changes are made in this name). */
|
|
27
|
+
author?: string | undefined;
|
|
28
|
+
/** Read once on mount: record edits as tracked changes (the toolbar turns it on and off). */
|
|
29
|
+
trackChanges?: boolean | undefined;
|
|
30
|
+
/** Read once on mount: how tracked changes show (the toolbar changes it). */
|
|
31
|
+
reviewView?: ReviewView | undefined;
|
|
26
32
|
/**
|
|
27
33
|
* Called after every change to the document's content made through transactions (typing,
|
|
28
34
|
* commands, undo). Not for selection changes, and not for `editor.setDocument()`, whose
|
|
@@ -31,6 +37,11 @@ export interface FoliEditorProps extends Omit<FoliCanvasProps, "editor"> {
|
|
|
31
37
|
onChange?: ((change: FoliChange) => void) | undefined;
|
|
32
38
|
/** Show the default `FoliToolbar` above the pages (default true). */
|
|
33
39
|
toolbar?: boolean | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* Show the comments pane (`FoliComments`) beside the pages: `"auto"` (the default) while the
|
|
42
|
+
* document has comments, `true` always, `false` never.
|
|
43
|
+
*/
|
|
44
|
+
comments?: boolean | "auto" | undefined;
|
|
34
45
|
/** Rendered between the toolbar and the pages, inside the editor's context. */
|
|
35
46
|
children?: ReactNode | undefined;
|
|
36
47
|
}
|
package/dist/FoliEditor.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FoliEditor.d.ts","sourceRoot":"","sources":["../src/FoliEditor.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,WAAW,EAEjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAc,KAAK,SAAS,EAA+B,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"FoliEditor.d.ts","sourceRoot":"","sources":["../src/FoliEditor.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,WAAW,EAEjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAc,KAAK,SAAS,EAA+B,MAAM,OAAO,CAAC;AAOhF,OAAO,EAAc,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAI1F;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,+EAA+E;IAC/E,QAAQ,CAAC,YAAY,EAAE,SAAS,WAAW,EAAE,CAAC;IAC9C;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;CACjC;AAED,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC;IACtE;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,0BAA0B;IAC1B,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,6FAA6F;IAC7F,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC,6EAA6E;IAC7E,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACtD,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;IACxC,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAClC;AAED,2FAA2F;AAC3F,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,8GA2ErB,CAAC"}
|
package/dist/FoliEditor.js
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
2
|
import { wordContext, } from "@folijs/core";
|
|
3
3
|
import { forwardRef, useImperativeHandle, useRef } from "react";
|
|
4
|
-
import { FoliEditorProvider, useFoliEditor, useIsomorphicLayoutEffect } from "./editor.js";
|
|
4
|
+
import { FoliEditorProvider, useEditorState, useFoliEditor, useIsomorphicLayoutEffect, } from "./editor.js";
|
|
5
5
|
import { FoliCanvas } from "./FoliCanvas.js";
|
|
6
|
+
import { FoliComments } from "./FoliComments.js";
|
|
6
7
|
import { FoliToolbar } from "./FoliToolbar.js";
|
|
7
8
|
/**
|
|
8
9
|
* An editable document on real pages with a toolbar: creates its editor, provides it to
|
|
9
10
|
* `children` and shows it. Uncontrolled: the editor owns the document; React observes it
|
|
10
11
|
* through `onChange`, a parent reaches it through a `ref`.
|
|
11
12
|
*/
|
|
12
|
-
export const FoliEditor = forwardRef(function FoliEditor({ initialContent, plugins, onChange, toolbar = true, children, ...canvas }, ref) {
|
|
13
|
-
const editor = useFoliEditor({ initialContent, plugins });
|
|
13
|
+
export const FoliEditor = forwardRef(function FoliEditor({ initialContent, plugins, author, trackChanges, reviewView, onChange, toolbar = true, comments = "auto", children, ...canvas }, ref) {
|
|
14
|
+
const editor = useFoliEditor({ initialContent, plugins, author, trackChanges, reviewView });
|
|
15
|
+
const hasComments = useEditorState((state) => (wordContext(state)?.envelope.comments.length ?? 0) > 0, { editor });
|
|
14
16
|
const onChangeRef = useRef(onChange);
|
|
15
17
|
const canvasRef = useRef(null);
|
|
16
18
|
useImperativeHandle(ref, () => ({ editor, focus: () => canvasRef.current?.focus() }), [editor]);
|
|
@@ -35,6 +37,6 @@ export const FoliEditor = forwardRef(function FoliEditor({ initialContent, plugi
|
|
|
35
37
|
},
|
|
36
38
|
});
|
|
37
39
|
}), [editor]);
|
|
38
|
-
return (_jsxs(FoliEditorProvider, { editor: editor, children: [toolbar && (_jsx(FoliToolbar, { editor: editor, disabled: canvas.readOnly, onClickCommand: () => canvasRef.current?.focus() })), children, _jsx(FoliCanvas, { ref: canvasRef, editor: editor, ...canvas })] }));
|
|
40
|
+
return (_jsxs(FoliEditorProvider, { editor: editor, children: [toolbar && (_jsx(FoliToolbar, { editor: editor, disabled: canvas.readOnly, comments: comments !== false, onClickCommand: () => canvasRef.current?.focus() })), children, _jsxs("div", { className: "foli-editor-body", children: [_jsx(FoliCanvas, { ref: canvasRef, editor: editor, ...canvas }), comments !== false && (_jsx(FoliComments, { editor: editor, readOnly: canvas.readOnly, hidden: comments === "auto" && !hasComments }))] })] }));
|
|
39
41
|
});
|
|
40
42
|
//# sourceMappingURL=FoliEditor.js.map
|
package/dist/FoliEditor.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FoliEditor.js","sourceRoot":"","sources":["../src/FoliEditor.tsx"],"names":[],"mappings":";AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"FoliEditor.js","sourceRoot":"","sources":["../src/FoliEditor.tsx"],"names":[],"mappings":";AAAA,OAAO,EAOL,WAAW,GACZ,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAkB,mBAAmB,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,yBAAyB,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAA+C,MAAM,iBAAiB,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAqD/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAoC,SAAS,UAAU,CACzF,EACE,cAAc,EACd,OAAO,EACP,MAAM,EACN,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,OAAO,GAAG,IAAI,EACd,QAAQ,GAAG,MAAM,EACjB,QAAQ,EACR,GAAG,MAAM,EACV,EACD,GAAG;IAEH,MAAM,MAAM,GAAG,aAAa,CAAC,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5F,MAAM,WAAW,GAAG,cAAc,CAChC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,EAClE,EAAE,MAAM,EAAE,CACX,CAAC;IACF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,MAAM,CAAmB,IAAI,CAAC,CAAC;IAEjD,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhG,yBAAyB,CAAC,GAAG,EAAE;QAC7B,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,yBAAyB,CACvB,GAAG,EAAE,CACH,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE;QACvC,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC;YAAE,OAAO;QACnE,qFAAqF;QACrF,IAAI,QAAkC,CAAC;QACvC,QAAQ,CAAC;YACP,MAAM;YACN,YAAY;YACZ,IAAI,QAAQ;gBACV,QAAQ,KAAK;oBACX,GAAI,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAmC;oBACnF,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE;iBAC5B,CAAC;gBACF,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF,CAAC,CAAC;IACL,CAAC,CAAC,EACJ,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO,CACL,MAAC,kBAAkB,IAAC,MAAM,EAAE,MAAM,aAC/B,OAAO,IAAI,CACV,KAAC,WAAW,IACV,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,CAAC,QAAQ,EACzB,QAAQ,EAAE,QAAQ,KAAK,KAAK,EAC5B,cAAc,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,GAChD,CACH,EACA,QAAQ,EACT,eAAK,SAAS,EAAC,kBAAkB,aAC/B,KAAC,UAAU,IAAC,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,KAAM,MAAM,GAAI,EAEzD,QAAQ,KAAK,KAAK,IAAI,CACrB,KAAC,YAAY,IACX,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,CAAC,QAAQ,EACzB,MAAM,EAAE,QAAQ,KAAK,MAAM,IAAI,CAAC,WAAW,GAC3C,CACH,IACG,IACa,CACtB,CAAC;AACJ,CAAC,CAAC,CAAC"}
|
package/dist/FoliToolbar.d.ts
CHANGED
|
@@ -14,6 +14,11 @@ export interface FoliToolbarProps {
|
|
|
14
14
|
onClickCommand?: (() => void) | undefined;
|
|
15
15
|
/** Accessible name of the toolbar (default "Formatting"). */
|
|
16
16
|
label?: string | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* Show "New comment": only where a comments pane (`FoliComments`) lets the comment be written
|
|
19
|
+
* (`FoliEditor` passes it). Default false.
|
|
20
|
+
*/
|
|
21
|
+
comments?: boolean | undefined;
|
|
17
22
|
className?: string | undefined;
|
|
18
23
|
}
|
|
19
24
|
/**
|
|
@@ -24,5 +29,5 @@ export interface FoliToolbarProps {
|
|
|
24
29
|
* `aria-pressed`; a button whose command cannot run now is `aria-disabled` (still focusable).
|
|
25
30
|
* Clicks leave the focus and selection in the document.
|
|
26
31
|
*/
|
|
27
|
-
export declare function FoliToolbar({ editor: given, disabled, onClickCommand, label, className, }: FoliToolbarProps): import("react").JSX.Element;
|
|
32
|
+
export declare function FoliToolbar({ editor: given, disabled, onClickCommand, label, className, comments, }: FoliToolbarProps): import("react").JSX.Element;
|
|
28
33
|
//# sourceMappingURL=FoliToolbar.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FoliToolbar.d.ts","sourceRoot":"","sources":["../src/FoliToolbar.tsx"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"FoliToolbar.d.ts","sourceRoot":"","sources":["../src/FoliToolbar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAUL,KAAK,MAAM,EAsCZ,MAAM,cAAc,CAAC;AActB,MAAM,WAAW,gBAAgB;IAC/B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAC1C,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAwaD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EAAE,KAAK,EACb,QAAgB,EAChB,cAAc,EACd,KAAoB,EACpB,SAAS,EACT,QAAgB,GACjB,EAAE,gBAAgB,+BAyOlB"}
|
package/dist/FoliToolbar.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
-
import { alignAt, canOutdent, changeIndent, colorAt, fontFamilyAt, fontSizeAt, insertPageBreak, isSafeHref, lineSpacingAt, linkAt, listKindAt, normalizeHref, openLinkEditor, paragraphStyleAt, paragraphStyles, redo, redoDepth, removeLink, requestsLinkEditor, setAlign, setFontFamily, setFontSize, setHighlight, setLineSpacing, setLink, setParagraphStyle, setTextColor, toggleList, toggleMark, undo, undoDepth, wordContext, } from "@folijs/core";
|
|
2
|
+
import { acceptAllChanges, acceptChange, addComment, alignAt, canOutdent, changeIndent, colorAt, fontFamilyAt, fontSizeAt, insertPageBreak, isSafeHref, lineSpacingAt, linkAt, listKindAt, nextChange, normalizeHref, openLinkEditor, paragraphStyleAt, paragraphStyles, previousChange, redo, redoDepth, rejectAllChanges, rejectChange, removeLink, requestsLinkEditor, setAlign, setFontFamily, setFontSize, setHighlight, setLineSpacing, setLink, setParagraphStyle, setReviewView, setTextColor, setTrackChanges, toggleList, toggleMark, trackState, undo, undoDepth, wordContext, } from "@folijs/core";
|
|
3
3
|
import { Fragment, useEffect, useId, useRef, useState, } from "react";
|
|
4
4
|
import { useEditorOrContext, useEditorState } from "./editor.js";
|
|
5
5
|
/**
|
|
@@ -70,6 +70,11 @@ const FONTS = [
|
|
|
70
70
|
];
|
|
71
71
|
const SIZES = [8, 9, 10, 10.5, 11, 12, 14, 16, 18, 20, 22, 24, 26, 28, 36, 48, 72];
|
|
72
72
|
const LINE_SPACINGS = [1, 1.15, 1.5, 2, 2.5, 3];
|
|
73
|
+
const REVIEW_VIEWS = [
|
|
74
|
+
{ value: "markup", label: "All markup" },
|
|
75
|
+
{ value: "simple", label: "Simple markup" },
|
|
76
|
+
{ value: "final", label: "No markup" },
|
|
77
|
+
];
|
|
73
78
|
/** Word's controls. */
|
|
74
79
|
const GROUPS = [
|
|
75
80
|
[
|
|
@@ -232,6 +237,78 @@ const GROUPS = [
|
|
|
232
237
|
command: () => changeIndent(1),
|
|
233
238
|
},
|
|
234
239
|
],
|
|
240
|
+
[
|
|
241
|
+
{
|
|
242
|
+
key: "newComment",
|
|
243
|
+
label: "New comment on the selection",
|
|
244
|
+
text: "New comment",
|
|
245
|
+
enabled: (state) => wordContext(state) !== null && hasTextblock(state),
|
|
246
|
+
command: () => addComment(""),
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
key: "trackChanges",
|
|
250
|
+
label: "Track changes",
|
|
251
|
+
text: "Track changes",
|
|
252
|
+
pressed: (state) => trackState(state)?.on === true,
|
|
253
|
+
enabled: (state) => trackState(state) !== null,
|
|
254
|
+
command: (state) => setTrackChanges(!trackState(state)?.on),
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
key: "reviewView",
|
|
258
|
+
label: "Show changes as",
|
|
259
|
+
text: "Show",
|
|
260
|
+
enabled: (state) => trackState(state) !== null,
|
|
261
|
+
select: {
|
|
262
|
+
options: () => REVIEW_VIEWS,
|
|
263
|
+
value: (state) => trackState(state)?.view ?? "markup",
|
|
264
|
+
pick: (view) => setReviewView(view),
|
|
265
|
+
},
|
|
266
|
+
},
|
|
267
|
+
// Enabled while tracking can be used: whether there is a change to go to or resolve would
|
|
268
|
+
// walk the whole document after every transaction.
|
|
269
|
+
{
|
|
270
|
+
key: "previousChange",
|
|
271
|
+
label: "Previous change",
|
|
272
|
+
text: "Previous change",
|
|
273
|
+
enabled: (state) => trackState(state) !== null,
|
|
274
|
+
command: () => previousChange,
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
key: "nextChange",
|
|
278
|
+
label: "Next change",
|
|
279
|
+
text: "Next change",
|
|
280
|
+
enabled: (state) => trackState(state) !== null,
|
|
281
|
+
command: () => nextChange,
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
key: "acceptChange",
|
|
285
|
+
label: "Accept the change here, or the changes selected",
|
|
286
|
+
text: "Accept",
|
|
287
|
+
enabled: (state) => trackState(state) !== null,
|
|
288
|
+
command: () => acceptChange,
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
key: "rejectChange",
|
|
292
|
+
label: "Reject the change here, or the changes selected",
|
|
293
|
+
text: "Reject",
|
|
294
|
+
enabled: (state) => trackState(state) !== null,
|
|
295
|
+
command: () => rejectChange,
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
key: "acceptAll",
|
|
299
|
+
label: "Accept all changes",
|
|
300
|
+
text: "Accept all",
|
|
301
|
+
enabled: (state) => trackState(state) !== null,
|
|
302
|
+
command: () => acceptAllChanges(),
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
key: "rejectAll",
|
|
306
|
+
label: "Reject all changes",
|
|
307
|
+
text: "Reject all",
|
|
308
|
+
enabled: (state) => trackState(state) !== null,
|
|
309
|
+
command: () => rejectAllChanges(),
|
|
310
|
+
},
|
|
311
|
+
],
|
|
235
312
|
[
|
|
236
313
|
{
|
|
237
314
|
key: "undo",
|
|
@@ -251,6 +328,9 @@ const GROUPS = [
|
|
|
251
328
|
[{ key: "pageBreak", label: "Page break", text: "Page break", command: () => insertPageBreak }],
|
|
252
329
|
];
|
|
253
330
|
const ITEMS = GROUPS.flat();
|
|
331
|
+
/** Without "New comment": where no comments pane lets a comment be written. */
|
|
332
|
+
const GROUPS_NO_COMMENT = GROUPS.map((group) => group.filter((i) => i.key !== "newComment"));
|
|
333
|
+
const ITEMS_NO_COMMENT = GROUPS_NO_COMMENT.flat();
|
|
254
334
|
const sameStates = (a, b) => a.length === b.length &&
|
|
255
335
|
a.every((item, i) => item.pressed === b[i]?.pressed &&
|
|
256
336
|
item.enabled === b[i]?.enabled &&
|
|
@@ -262,6 +342,7 @@ const statesOf = (items) => (state, editor) => items.map((item) => ({
|
|
|
262
342
|
value: item.menu?.value(state) ?? item.select?.value(state),
|
|
263
343
|
}));
|
|
264
344
|
const selectStates = statesOf(ITEMS);
|
|
345
|
+
const selectStatesNoComment = statesOf(ITEMS_NO_COMMENT);
|
|
265
346
|
/**
|
|
266
347
|
* Word's formatting controls for an editor: paragraph style, font and size boxes, marks, link (a
|
|
267
348
|
* dialog, also on Mod-K in the document), text color and highlight menus, alignment and line
|
|
@@ -270,11 +351,14 @@ const selectStates = statesOf(ITEMS);
|
|
|
270
351
|
* `aria-pressed`; a button whose command cannot run now is `aria-disabled` (still focusable).
|
|
271
352
|
* Clicks leave the focus and selection in the document.
|
|
272
353
|
*/
|
|
273
|
-
export function FoliToolbar({ editor: given, disabled = false, onClickCommand, label = "Formatting", className, }) {
|
|
354
|
+
export function FoliToolbar({ editor: given, disabled = false, onClickCommand, label = "Formatting", className, comments = false, }) {
|
|
274
355
|
const editor = useEditorOrContext(given, "FoliToolbar");
|
|
275
|
-
const groups = GROUPS;
|
|
276
|
-
const items = ITEMS;
|
|
277
|
-
const states = useEditorState(
|
|
356
|
+
const groups = comments ? GROUPS : GROUPS_NO_COMMENT;
|
|
357
|
+
const items = comments ? ITEMS : ITEMS_NO_COMMENT;
|
|
358
|
+
const states = useEditorState(comments ? selectStates : selectStatesNoComment, {
|
|
359
|
+
editor,
|
|
360
|
+
isEqual: sameStates,
|
|
361
|
+
});
|
|
278
362
|
const [active, setActive] = useState(0);
|
|
279
363
|
const buttons = useRef([]);
|
|
280
364
|
// Whether a select box was last used with the pointer (its pick then goes back to the document).
|