699 lines
19 KiB
TypeScript
699 lines
19 KiB
TypeScript
// Copyright 2019-2022 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
import * as React from 'react';
|
|
|
|
import Delta from 'quill-delta';
|
|
import ReactQuill from 'react-quill';
|
|
import classNames from 'classnames';
|
|
import { Manager, Reference } from 'react-popper';
|
|
import type { KeyboardStatic, RangeStatic } from 'quill';
|
|
import Quill from 'quill';
|
|
|
|
import { MentionCompletion } from '../quill/mentions/completion';
|
|
import { EmojiBlot, EmojiCompletion } from '../quill/emoji';
|
|
import type { EmojiPickDataType } from './emoji/EmojiPicker';
|
|
import { convertShortName } from './emoji/lib';
|
|
import type { LocalizerType, BodyRangeType, ThemeType } from '../types/Util';
|
|
import type { ConversationType } from '../state/ducks/conversations';
|
|
import type { PreferredBadgeSelectorType } from '../state/selectors/badges';
|
|
import { isValidUuid } from '../types/UUID';
|
|
import { MentionBlot } from '../quill/mentions/blot';
|
|
import {
|
|
matchEmojiImage,
|
|
matchEmojiBlot,
|
|
matchReactEmoji,
|
|
matchEmojiText,
|
|
} from '../quill/emoji/matchers';
|
|
import { matchMention } from '../quill/mentions/matchers';
|
|
import { MemberRepository } from '../quill/memberRepository';
|
|
import {
|
|
getDeltaToRemoveStaleMentions,
|
|
getTextAndMentionsFromOps,
|
|
isMentionBlot,
|
|
getDeltaToRestartMention,
|
|
insertMentionOps,
|
|
insertEmojiOps,
|
|
} from '../quill/util';
|
|
import { SignalClipboard } from '../quill/signal-clipboard';
|
|
import { DirectionalBlot } from '../quill/block/blot';
|
|
import { getClassNamesFor } from '../util/getClassNamesFor';
|
|
import * as log from '../logging/log';
|
|
import { useRefMerger } from '../hooks/useRefMerger';
|
|
|
|
Quill.register('formats/emoji', EmojiBlot);
|
|
Quill.register('formats/mention', MentionBlot);
|
|
Quill.register('formats/block', DirectionalBlot);
|
|
Quill.register('modules/emojiCompletion', EmojiCompletion);
|
|
Quill.register('modules/mentionCompletion', MentionCompletion);
|
|
Quill.register('modules/signalClipboard', SignalClipboard);
|
|
|
|
type HistoryStatic = {
|
|
undo(): void;
|
|
clear(): void;
|
|
};
|
|
|
|
export type InputApi = {
|
|
focus: () => void;
|
|
insertEmoji: (e: EmojiPickDataType) => void;
|
|
setText: (text: string, cursorToEnd?: boolean) => void;
|
|
reset: () => void;
|
|
resetEmojiResults: () => void;
|
|
submit: () => void;
|
|
};
|
|
|
|
export type Props = {
|
|
children?: React.ReactNode;
|
|
readonly i18n: LocalizerType;
|
|
readonly disabled?: boolean;
|
|
readonly getPreferredBadge: PreferredBadgeSelectorType;
|
|
readonly large?: boolean;
|
|
readonly inputApi?: React.MutableRefObject<InputApi | undefined>;
|
|
readonly skinTone?: EmojiPickDataType['skinTone'];
|
|
readonly draftText?: string;
|
|
readonly draftBodyRanges?: Array<BodyRangeType>;
|
|
readonly moduleClassName?: string;
|
|
readonly theme: ThemeType;
|
|
readonly placeholder?: string;
|
|
sortedGroupMembers?: Array<ConversationType>;
|
|
scrollerRef?: React.RefObject<HTMLDivElement>;
|
|
onDirtyChange?(dirty: boolean): unknown;
|
|
onEditorStateChange?(
|
|
messageText: string,
|
|
bodyRanges: Array<BodyRangeType>,
|
|
caretLocation?: number
|
|
): unknown;
|
|
onTextTooLong(): unknown;
|
|
onPickEmoji(o: EmojiPickDataType): unknown;
|
|
onSubmit(
|
|
message: string,
|
|
mentions: Array<BodyRangeType>,
|
|
timestamp: number
|
|
): unknown;
|
|
onScroll?: (ev: React.UIEvent<HTMLElement>) => void;
|
|
getQuotedMessage?(): unknown;
|
|
clearQuotedMessage?(): unknown;
|
|
};
|
|
|
|
const MAX_LENGTH = 64 * 1024;
|
|
const BASE_CLASS_NAME = 'module-composition-input';
|
|
|
|
export function CompositionInput(props: Props): React.ReactElement {
|
|
const {
|
|
children,
|
|
i18n,
|
|
disabled,
|
|
large,
|
|
inputApi,
|
|
moduleClassName,
|
|
onPickEmoji,
|
|
onSubmit,
|
|
onScroll,
|
|
placeholder,
|
|
skinTone,
|
|
draftText,
|
|
draftBodyRanges,
|
|
getPreferredBadge,
|
|
getQuotedMessage,
|
|
clearQuotedMessage,
|
|
sortedGroupMembers,
|
|
theme,
|
|
} = props;
|
|
|
|
const refMerger = useRefMerger();
|
|
|
|
const [emojiCompletionElement, setEmojiCompletionElement] =
|
|
React.useState<JSX.Element>();
|
|
const [lastSelectionRange, setLastSelectionRange] =
|
|
React.useState<RangeStatic | null>(null);
|
|
const [mentionCompletionElement, setMentionCompletionElement] =
|
|
React.useState<JSX.Element>();
|
|
|
|
const emojiCompletionRef = React.useRef<EmojiCompletion>();
|
|
const mentionCompletionRef = React.useRef<MentionCompletion>();
|
|
const quillRef = React.useRef<Quill>();
|
|
|
|
const scrollerRefInner = React.useRef<HTMLDivElement>(null);
|
|
|
|
const propsRef = React.useRef<Props>(props);
|
|
const canSendRef = React.useRef<boolean>(false);
|
|
const memberRepositoryRef = React.useRef<MemberRepository>(
|
|
new MemberRepository()
|
|
);
|
|
|
|
const generateDelta = (
|
|
text: string,
|
|
bodyRanges: Array<BodyRangeType>
|
|
): Delta => {
|
|
const initialOps = [{ insert: text }];
|
|
const opsWithMentions = insertMentionOps(initialOps, bodyRanges);
|
|
const opsWithEmojis = insertEmojiOps(opsWithMentions);
|
|
|
|
return new Delta(opsWithEmojis);
|
|
};
|
|
|
|
const getTextAndMentions = (): [string, Array<BodyRangeType>] => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return ['', []];
|
|
}
|
|
|
|
const contents = quill.getContents();
|
|
|
|
if (contents === undefined) {
|
|
return ['', []];
|
|
}
|
|
|
|
const { ops } = contents;
|
|
|
|
if (ops === undefined) {
|
|
return ['', []];
|
|
}
|
|
|
|
return getTextAndMentionsFromOps(ops);
|
|
};
|
|
|
|
const focus = () => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
quill.focus();
|
|
};
|
|
|
|
const insertEmoji = (e: EmojiPickDataType) => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
const range = quill.getSelection();
|
|
|
|
const insertionRange = range || lastSelectionRange;
|
|
if (insertionRange == null) {
|
|
return;
|
|
}
|
|
|
|
const emoji = convertShortName(e.shortName, e.skinTone);
|
|
|
|
const delta = new Delta()
|
|
.retain(insertionRange.index)
|
|
.delete(insertionRange.length)
|
|
.insert({ emoji });
|
|
|
|
quill.updateContents(delta, 'user');
|
|
quill.setSelection(insertionRange.index + 1, 0, 'user');
|
|
};
|
|
|
|
const reset = () => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
canSendRef.current = true;
|
|
quill.setText('');
|
|
|
|
const historyModule = quill.getModule('history');
|
|
|
|
if (historyModule === undefined) {
|
|
return;
|
|
}
|
|
|
|
historyModule.clear();
|
|
};
|
|
|
|
const setText = (text: string, cursorToEnd?: boolean) => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
canSendRef.current = true;
|
|
quill.setText(text);
|
|
if (cursorToEnd) {
|
|
quill.setSelection(quill.getLength(), 0);
|
|
}
|
|
};
|
|
|
|
const resetEmojiResults = () => {
|
|
const emojiCompletion = emojiCompletionRef.current;
|
|
|
|
if (emojiCompletion === undefined) {
|
|
return;
|
|
}
|
|
|
|
emojiCompletion.reset();
|
|
};
|
|
|
|
const submit = () => {
|
|
const timestamp = Date.now();
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
if (!canSendRef.current) {
|
|
log.warn(
|
|
'CompositionInput: Not submitting message - cannot send right now'
|
|
);
|
|
return;
|
|
}
|
|
|
|
const [text, mentions] = getTextAndMentions();
|
|
|
|
log.info(
|
|
`CompositionInput: Submitting message ${timestamp} with ${mentions.length} mentions`
|
|
);
|
|
canSendRef.current = false;
|
|
onSubmit(text, mentions, timestamp);
|
|
};
|
|
|
|
if (inputApi) {
|
|
inputApi.current = {
|
|
focus,
|
|
insertEmoji,
|
|
setText,
|
|
reset,
|
|
resetEmojiResults,
|
|
submit,
|
|
};
|
|
}
|
|
|
|
React.useEffect(() => {
|
|
propsRef.current = props;
|
|
}, [props]);
|
|
|
|
React.useEffect(() => {
|
|
canSendRef.current = !disabled;
|
|
}, [disabled]);
|
|
|
|
const onShortKeyEnter = (): boolean => {
|
|
submit();
|
|
return false;
|
|
};
|
|
|
|
const onEnter = (): boolean => {
|
|
const quill = quillRef.current;
|
|
const emojiCompletion = emojiCompletionRef.current;
|
|
const mentionCompletion = mentionCompletionRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return false;
|
|
}
|
|
|
|
if (emojiCompletion === undefined || mentionCompletion === undefined) {
|
|
return false;
|
|
}
|
|
|
|
if (emojiCompletion.results.length) {
|
|
emojiCompletion.completeEmoji();
|
|
return false;
|
|
}
|
|
|
|
if (mentionCompletion.results.length) {
|
|
mentionCompletion.completeMention();
|
|
return false;
|
|
}
|
|
|
|
if (propsRef.current.large) {
|
|
return true;
|
|
}
|
|
|
|
submit();
|
|
|
|
return false;
|
|
};
|
|
|
|
const onTab = (): boolean => {
|
|
const quill = quillRef.current;
|
|
const emojiCompletion = emojiCompletionRef.current;
|
|
const mentionCompletion = mentionCompletionRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return false;
|
|
}
|
|
|
|
if (emojiCompletion === undefined || mentionCompletion === undefined) {
|
|
return false;
|
|
}
|
|
|
|
if (emojiCompletion.results.length) {
|
|
emojiCompletion.completeEmoji();
|
|
return false;
|
|
}
|
|
|
|
if (mentionCompletion.results.length) {
|
|
mentionCompletion.completeMention();
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
const onEscape = (): boolean => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return false;
|
|
}
|
|
|
|
const emojiCompletion = emojiCompletionRef.current;
|
|
const mentionCompletion = mentionCompletionRef.current;
|
|
|
|
if (emojiCompletion) {
|
|
if (emojiCompletion.results.length) {
|
|
emojiCompletion.reset();
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (mentionCompletion) {
|
|
if (mentionCompletion.results.length) {
|
|
mentionCompletion.clearResults();
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (getQuotedMessage?.()) {
|
|
clearQuotedMessage?.();
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
const onBackspace = (): boolean => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return true;
|
|
}
|
|
|
|
const selection = quill.getSelection();
|
|
if (!selection || selection.length > 0) {
|
|
return true;
|
|
}
|
|
|
|
const [blotToDelete] = quill.getLeaf(selection.index);
|
|
if (!isMentionBlot(blotToDelete)) {
|
|
return true;
|
|
}
|
|
|
|
const contents = quill.getContents(0, selection.index - 1);
|
|
const restartDelta = getDeltaToRestartMention(contents.ops);
|
|
|
|
quill.updateContents(restartDelta);
|
|
quill.setSelection(selection.index, 0);
|
|
|
|
return false;
|
|
};
|
|
|
|
const onChange = (): void => {
|
|
const quill = quillRef.current;
|
|
|
|
const [text, mentions] = getTextAndMentions();
|
|
|
|
if (quill !== undefined) {
|
|
const historyModule: HistoryStatic = quill.getModule('history');
|
|
|
|
if (text.length > MAX_LENGTH) {
|
|
historyModule.undo();
|
|
propsRef.current.onTextTooLong();
|
|
return;
|
|
}
|
|
|
|
const { onEditorStateChange } = propsRef.current;
|
|
|
|
if (onEditorStateChange) {
|
|
// `getSelection` inside the `onChange` event handler will be the
|
|
// selection value _before_ the change occurs. `setTimeout` 0 here will
|
|
// let `getSelection` return the selection after the change takes place.
|
|
// this is necessary for `maybeGrabLinkPreview` as it needs the correct
|
|
// `caretLocation` from the post-change selection index value.
|
|
setTimeout(() => {
|
|
const selection = quill.getSelection();
|
|
|
|
onEditorStateChange(
|
|
text,
|
|
mentions,
|
|
selection ? selection.index : undefined
|
|
);
|
|
}, 0);
|
|
}
|
|
}
|
|
|
|
if (propsRef.current.onDirtyChange) {
|
|
propsRef.current.onDirtyChange(text.length > 0);
|
|
}
|
|
};
|
|
|
|
React.useEffect(() => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
quill.enable(!disabled);
|
|
quill.focus();
|
|
}, [disabled]);
|
|
|
|
React.useEffect(() => {
|
|
const emojiCompletion = emojiCompletionRef.current;
|
|
|
|
if (emojiCompletion === undefined || skinTone === undefined) {
|
|
return;
|
|
}
|
|
|
|
emojiCompletion.options.skinTone = skinTone;
|
|
}, [skinTone]);
|
|
|
|
React.useEffect(
|
|
() => () => {
|
|
const emojiCompletion = emojiCompletionRef.current;
|
|
const mentionCompletion = mentionCompletionRef.current;
|
|
|
|
if (emojiCompletion !== undefined) {
|
|
emojiCompletion.destroy();
|
|
}
|
|
|
|
if (mentionCompletion !== undefined) {
|
|
mentionCompletion.destroy();
|
|
}
|
|
},
|
|
[]
|
|
);
|
|
|
|
const removeStaleMentions = (currentMembers: Array<ConversationType>) => {
|
|
const quill = quillRef.current;
|
|
|
|
if (quill === undefined) {
|
|
return;
|
|
}
|
|
|
|
const { ops } = quill.getContents();
|
|
if (ops === undefined) {
|
|
return;
|
|
}
|
|
|
|
const currentMemberUuids = currentMembers
|
|
.map(m => m.uuid)
|
|
.filter(isValidUuid);
|
|
|
|
const newDelta = getDeltaToRemoveStaleMentions(ops, currentMemberUuids);
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
quill.updateContents(newDelta as any);
|
|
};
|
|
|
|
const memberIds = sortedGroupMembers ? sortedGroupMembers.map(m => m.id) : [];
|
|
|
|
React.useEffect(() => {
|
|
memberRepositoryRef.current.updateMembers(sortedGroupMembers || []);
|
|
removeStaleMentions(sortedGroupMembers || []);
|
|
// We are still depending on members, but ESLint can't tell
|
|
// Comparing the actual members list does not work for a couple reasons:
|
|
// * Arrays with the same objects are not "equal" to React
|
|
// * We only care about added/removed members, ignoring other attributes
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, [JSON.stringify(memberIds)]);
|
|
|
|
// Placing all of these callbacks inside of a ref since Quill is not able
|
|
// to re-render. We want to make sure that all these callbacks are fresh
|
|
// so that the consumers of this component won't deal with stale props or
|
|
// stale state as the result of calling them.
|
|
const unstaleCallbacks = {
|
|
onBackspace,
|
|
onChange,
|
|
onEnter,
|
|
onEscape,
|
|
onPickEmoji,
|
|
onShortKeyEnter,
|
|
onTab,
|
|
};
|
|
const callbacksRef = React.useRef(unstaleCallbacks);
|
|
callbacksRef.current = unstaleCallbacks;
|
|
|
|
const reactQuill = React.useMemo(
|
|
() => {
|
|
const delta = generateDelta(draftText || '', draftBodyRanges || []);
|
|
|
|
return (
|
|
<ReactQuill
|
|
className={`${BASE_CLASS_NAME}__quill`}
|
|
onChange={() => callbacksRef.current.onChange()}
|
|
defaultValue={delta}
|
|
modules={{
|
|
toolbar: false,
|
|
signalClipboard: true,
|
|
clipboard: {
|
|
matchers: [
|
|
['IMG', matchEmojiImage],
|
|
['IMG', matchEmojiBlot],
|
|
['SPAN', matchReactEmoji],
|
|
[Node.TEXT_NODE, matchEmojiText],
|
|
['SPAN', matchMention(memberRepositoryRef)],
|
|
],
|
|
},
|
|
keyboard: {
|
|
bindings: {
|
|
onEnter: {
|
|
key: 13,
|
|
handler: () => callbacksRef.current.onEnter(),
|
|
}, // 13 = Enter
|
|
onShortKeyEnter: {
|
|
key: 13, // 13 = Enter
|
|
shortKey: true,
|
|
handler: () => callbacksRef.current.onShortKeyEnter(),
|
|
},
|
|
onEscape: {
|
|
key: 27,
|
|
handler: () => callbacksRef.current.onEscape(),
|
|
}, // 27 = Escape
|
|
onBackspace: {
|
|
key: 8,
|
|
handler: () => callbacksRef.current.onBackspace(),
|
|
}, // 8 = Backspace
|
|
},
|
|
},
|
|
emojiCompletion: {
|
|
setEmojiPickerElement: setEmojiCompletionElement,
|
|
onPickEmoji: (emoji: EmojiPickDataType) =>
|
|
callbacksRef.current.onPickEmoji(emoji),
|
|
skinTone,
|
|
},
|
|
mentionCompletion: {
|
|
getPreferredBadge,
|
|
me: sortedGroupMembers
|
|
? sortedGroupMembers.find(foo => foo.isMe)
|
|
: undefined,
|
|
memberRepositoryRef,
|
|
setMentionPickerElement: setMentionCompletionElement,
|
|
i18n,
|
|
theme,
|
|
},
|
|
}}
|
|
formats={['emoji', 'mention']}
|
|
placeholder={placeholder || i18n('sendMessage')}
|
|
readOnly={disabled}
|
|
ref={element => {
|
|
if (element) {
|
|
const quill = element.getEditor();
|
|
const keyboard = quill.getModule('keyboard') as KeyboardStatic;
|
|
|
|
// force the tab handler to be prepended, otherwise it won't be
|
|
// executed: https://github.com/quilljs/quill/issues/1967
|
|
keyboard.bindings[9].unshift({
|
|
key: 9,
|
|
handler: () => callbacksRef.current.onTab(),
|
|
}); // 9 = Tab
|
|
// also, remove the default \t insertion binding
|
|
keyboard.bindings[9].pop();
|
|
|
|
// When loading a multi-line message out of a draft, the cursor
|
|
// position needs to be pushed to the end of the input manually.
|
|
quill.once('editor-change', () => {
|
|
const scroller = scrollerRefInner.current;
|
|
|
|
if (scroller != null) {
|
|
quill.scrollingContainer = scroller;
|
|
}
|
|
|
|
setTimeout(() => {
|
|
quill.setSelection(quill.getLength(), 0);
|
|
quill.root.classList.add('ql-editor--loaded');
|
|
}, 0);
|
|
});
|
|
|
|
quill.on(
|
|
'selection-change',
|
|
(newRange: RangeStatic, oldRange: RangeStatic) => {
|
|
// If we lose focus, store the last edit point for emoji insertion
|
|
if (newRange == null) {
|
|
setLastSelectionRange(oldRange);
|
|
}
|
|
}
|
|
);
|
|
quillRef.current = quill;
|
|
emojiCompletionRef.current = quill.getModule('emojiCompletion');
|
|
mentionCompletionRef.current =
|
|
quill.getModule('mentionCompletion');
|
|
}
|
|
}}
|
|
/>
|
|
);
|
|
},
|
|
// quill shouldn't re-render, all changes should take place exclusively
|
|
// through mutating the quill state directly instead of through props
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
[]
|
|
);
|
|
|
|
// The onClick handler below is only to make it easier for mouse users to focus the
|
|
// message box. In 'large' mode, the actual Quill text box can be one line while the
|
|
// visual text box is much larger. Clicking that should allow you to start typing,
|
|
// hence the click handler.
|
|
// eslint-disable-next-line max-len
|
|
/* eslint-disable jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions */
|
|
|
|
const getClassName = getClassNamesFor(BASE_CLASS_NAME, moduleClassName);
|
|
|
|
return (
|
|
<Manager>
|
|
<Reference>
|
|
{({ ref }) => (
|
|
<div className={getClassName('__input')} ref={ref}>
|
|
<div
|
|
ref={
|
|
props.scrollerRef
|
|
? refMerger(scrollerRefInner, props.scrollerRef)
|
|
: scrollerRefInner
|
|
}
|
|
onClick={focus}
|
|
onScroll={onScroll}
|
|
className={classNames(
|
|
getClassName('__input__scroller'),
|
|
large ? getClassName('__input__scroller--large') : null,
|
|
children ? getClassName('__input--with-children') : null
|
|
)}
|
|
>
|
|
{children}
|
|
{reactQuill}
|
|
{emojiCompletionElement}
|
|
{mentionCompletionElement}
|
|
</div>
|
|
</div>
|
|
)}
|
|
</Reference>
|
|
</Manager>
|
|
);
|
|
}
|