mirror of
https://github.com/SableClient/Sable.git
synced 2026-11-21 17:41:25 -08:00
fix(android): stop composer re-renders from interrupting IME input (#1713)
<!-- Please read https://github.com/SableClient/Sable/blob/dev/CONTRIBUTING.md before submitting your pull request --> ### Description <!-- Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Fixes # #### Type of change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update ### Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings ### AI disclosure: - [ ] Partially AI assisted (clarify which code was AI assisted and briefly explain what it does). - [ ] Fully AI generated (explain what all the generated code does in moderate detail). <!-- Write any explanation required here, but do not generate the explanation using AI!! You must prove you understand what the code in this PR does. -->
This commit is contained in:
1 file changed
+60
-46
@@ -1,10 +1,11 @@
|
||||
import type {
|
||||
ClipboardEventHandler,
|
||||
FocusEvent,
|
||||
KeyboardEventHandler,
|
||||
MutableRefObject,
|
||||
ReactNode,
|
||||
} from 'react';
|
||||
import { forwardRef, useCallback, useEffect, useLayoutEffect, useRef, useState } from 'react';
|
||||
import { forwardRef, memo, useCallback, useEffect, useLayoutEffect, useRef, useState } from 'react';
|
||||
import { Box, Scroll, Text } from 'folds';
|
||||
import type { Descendant, Editor } from 'slate';
|
||||
import { Node, Transforms, createEditor } from 'slate';
|
||||
@@ -101,6 +102,9 @@ const insertPastedText = (editor: Editor, text: string): void => {
|
||||
});
|
||||
};
|
||||
|
||||
const MemoizedEditable = memo(Editable);
|
||||
const EDITABLE_STYLE = { boxShadow: 'none' };
|
||||
|
||||
type EditorChangeHandler = (value: Descendant[]) => void;
|
||||
const MAX_MULTILINE_MEASURE_RETRIES = 2;
|
||||
const MULTILINE_HEIGHT_EPSILON = 1;
|
||||
@@ -444,32 +448,60 @@ export const CustomEditor = forwardRef<HTMLDivElement, CustomEditorProps>(
|
||||
|
||||
const renderLeaf = useCallback((props: RenderLeafProps) => <RenderLeaf {...props} />, []);
|
||||
|
||||
const handleKeydown: KeyboardEventHandler = useCallback(
|
||||
(evt) => {
|
||||
onKeyDown?.(evt);
|
||||
const latestRef = useRef({ editor, onKeyDown, onKeyUp, onPaste, shortcutOverrides });
|
||||
latestRef.current = { editor, onKeyDown, onKeyUp, onPaste, shortcutOverrides };
|
||||
|
||||
const shortcutToggled = toggleKeyboardShortcut(editor, evt, shortcutOverrides);
|
||||
if (shortcutToggled) evt.preventDefault();
|
||||
const handleKeydown: KeyboardEventHandler = useCallback((evt) => {
|
||||
const { editor: slate, onKeyDown: keyDown, shortcutOverrides: overrides } = latestRef.current;
|
||||
keyDown?.(evt);
|
||||
|
||||
const shortcutToggled = toggleKeyboardShortcut(slate, evt, overrides);
|
||||
if (shortcutToggled) evt.preventDefault();
|
||||
}, []);
|
||||
|
||||
const handleKeyUp: KeyboardEventHandler = useCallback((evt) => {
|
||||
latestRef.current.onKeyUp?.(evt);
|
||||
}, []);
|
||||
|
||||
const handlePaste: ClipboardEventHandler = useCallback((evt) => {
|
||||
const { editor: slate, onPaste: paste } = latestRef.current;
|
||||
paste?.(evt);
|
||||
if (evt.isDefaultPrevented() || !iosApp() || hasPasteData(evt.clipboardData)) return;
|
||||
|
||||
evt.preventDefault();
|
||||
readClipboardText()
|
||||
.then((text) => {
|
||||
if (text) insertPastedText(slate, text);
|
||||
})
|
||||
.catch((err: unknown) => {
|
||||
log.warn('Failed to read the native clipboard on paste:', err);
|
||||
});
|
||||
}, []);
|
||||
|
||||
const handleBlur = useCallback(
|
||||
(evt: FocusEvent<HTMLDivElement>) => {
|
||||
cancelFocusScroll();
|
||||
if (!isMobileOrTablet()) return;
|
||||
if (suppressBlurRefocusRef?.current) return;
|
||||
const next = evt.relatedTarget as HTMLElement | null;
|
||||
if (!next) return;
|
||||
if (next !== editableRef.current && next.isContentEditable) return;
|
||||
ReactEditor.focus(latestRef.current.editor);
|
||||
},
|
||||
[editor, onKeyDown, shortcutOverrides]
|
||||
[cancelFocusScroll, suppressBlurRefocusRef]
|
||||
);
|
||||
|
||||
const handlePaste: ClipboardEventHandler = useCallback(
|
||||
(evt) => {
|
||||
onPaste?.(evt);
|
||||
if (evt.isDefaultPrevented() || !iosApp() || hasPasteData(evt.clipboardData)) return;
|
||||
|
||||
evt.preventDefault();
|
||||
readClipboardText()
|
||||
.then((text) => {
|
||||
if (text) insertPastedText(editor, text);
|
||||
})
|
||||
.catch((err: unknown) => {
|
||||
log.warn('Failed to read the native clipboard on paste:', err);
|
||||
});
|
||||
},
|
||||
[editor, onPaste]
|
||||
);
|
||||
const handleFocus = useCallback(() => {
|
||||
if (!isMobileOrTablet()) return;
|
||||
cancelFocusScroll();
|
||||
const scrollIn = () => {
|
||||
if (editableRef.current?.contains(document.activeElement)) {
|
||||
rootRef.current?.scrollIntoView({ block: 'nearest' });
|
||||
}
|
||||
};
|
||||
window.visualViewport?.addEventListener('resize', scrollIn, { once: true });
|
||||
focusScrollTimerRef.current = window.setTimeout(scrollIn, 500);
|
||||
}, [cancelFocusScroll]);
|
||||
|
||||
const renderPlaceholder = useCallback(
|
||||
({ attributes, children }: RenderPlaceholderProps) => (
|
||||
@@ -514,7 +546,7 @@ export const CustomEditor = forwardRef<HTMLDivElement, CustomEditorProps>(
|
||||
visibility="Always"
|
||||
hideTrack
|
||||
>
|
||||
<Editable
|
||||
<MemoizedEditable
|
||||
ref={editableRef}
|
||||
data-editable-name={editableName}
|
||||
className={`${css.EditorTextarea} ${alwaysInlineEditor ? css.EditorTextareaInline : ''}`}
|
||||
@@ -523,36 +555,18 @@ export const CustomEditor = forwardRef<HTMLDivElement, CustomEditorProps>(
|
||||
renderElement={renderElement}
|
||||
renderLeaf={renderLeaf}
|
||||
onKeyDown={handleKeydown}
|
||||
onKeyUp={onKeyUp}
|
||||
onKeyUp={handleKeyUp}
|
||||
onPaste={handlePaste}
|
||||
// Defer to OS capitalization setting (respects iOS sentence-case toggle).
|
||||
autoCapitalize="sentences"
|
||||
autoCorrect="on"
|
||||
enterKeyHint={enterKeyHint}
|
||||
// keeps focus after pressing send, but yields to another editor.
|
||||
onBlur={(evt) => {
|
||||
cancelFocusScroll();
|
||||
if (!isMobileOrTablet()) return;
|
||||
if (suppressBlurRefocusRef?.current) return;
|
||||
const next = evt.relatedTarget as HTMLElement | null;
|
||||
if (!next) return;
|
||||
if (next && next !== editableRef.current && next.isContentEditable) return;
|
||||
ReactEditor.focus(editor);
|
||||
}}
|
||||
onBlur={handleBlur}
|
||||
// Once the virtual keyboard has settled, make sure the composer is
|
||||
// not left hidden behind it.
|
||||
onFocus={() => {
|
||||
if (!isMobileOrTablet()) return;
|
||||
cancelFocusScroll();
|
||||
const scrollIn = () => {
|
||||
if (editableRef.current?.contains(document.activeElement)) {
|
||||
rootRef.current?.scrollIntoView({ block: 'nearest' });
|
||||
}
|
||||
};
|
||||
window.visualViewport?.addEventListener('resize', scrollIn, { once: true });
|
||||
focusScrollTimerRef.current = window.setTimeout(scrollIn, 500);
|
||||
}}
|
||||
style={{ boxShadow: 'none' }}
|
||||
onFocus={handleFocus}
|
||||
style={EDITABLE_STYLE}
|
||||
/>
|
||||
</Scroll>
|
||||
{(hasAfter || showResponsiveAfterInline) && (
|
||||
|
||||
Reference in new issue
Block a user