import React, { forwardRef, memo, useRef, useState } from 'react' import { Editor, Text, Path, Element, Node } from 'slate' import { ReactEditor, useSlateStatic } from '..' import { useIsomorphicLayoutEffect } from '../hooks/use-isomorphic-layout-effect' import { IS_ANDROID } from 'slate-dom' import { MARK_PLACEHOLDER_SYMBOL } from 'slate-dom' /** * Leaf content strings. */ const String = (props: { isLast: boolean leaf: Text parent: Element text: Text }) => { const { isLast, leaf, parent, text } = props const editor = useSlateStatic() const path = ReactEditor.findPath(editor, text) const parentPath = Path.parent(path) const isMarkPlaceholder = Boolean(leaf[MARK_PLACEHOLDER_SYMBOL]) // COMPAT: Render text inside void nodes with a zero-width space. // So the node can contain selection but the text is not visible. if (editor.isVoid(parent)) { return } // COMPAT: If this is the last text node in an empty block, render a zero- // width space that will convert into a line break when copying and pasting // to support expected plain text. if ( leaf.text === '' && parent.children[parent.children.length - 1] === text && !editor.isInline(parent) && Editor.string(editor, parentPath) === '' ) { return } // COMPAT: If the text is empty, it's because it's on the edge of an inline // node, so we render a zero-width space so that the selection can be // inserted next to it still. if (leaf.text === '') { return } // COMPAT: Browsers will collapse trailing new lines at the end of blocks, // so we need to add an extra trailing new lines to prevent that. if (isLast && leaf.text.slice(-1) === '\n') { return } return } /** * Leaf strings with text in them. */ const TextString = (props: { text: string; isTrailing?: boolean }) => { const { text, isTrailing = false } = props const ref = useRef(null) const getTextContent = () => { return `${text ?? ''}${isTrailing ? '\n' : ''}` } const [initialText] = useState(getTextContent) // This is the actual text rendering boundary where we interface with the DOM // The text is not rendered as part of the virtual DOM, as since we handle basic character insertions natively, // updating the DOM is not a one way dataflow anymore. What we need here is not reconciliation and diffing // with previous version of the virtual DOM, but rather diffing with the actual DOM element, and replace the DOM content // exactly if and only if its current content does not match our current virtual DOM. // Otherwise the DOM TextNode would always be replaced by React as the user types, which interferes with native text features, // eg makes native spellcheck opt out from checking the text node. // useLayoutEffect: updating our span before browser paint useIsomorphicLayoutEffect(() => { // null coalescing text to make sure we're not outputing "null" as a string in the extreme case it is nullish at runtime const textWithTrailing = getTextContent() if (ref.current && ref.current.textContent !== textWithTrailing) { ref.current.textContent = textWithTrailing } // intentionally not specifying dependencies, so that this effect runs on every render // as this effectively replaces "specifying the text in the virtual DOM under the below" on each render }) // We intentionally render a memoized that only receives the initial text content when the component is mounted. // We defer to the layout effect above to update the `textContent` of the span element when needed. return {initialText} } const MemoizedText = memo( forwardRef((props, ref) => { return ( {props.children} ) }) ) /** * Leaf strings without text, render as zero-width strings. */ export const ZeroWidthString = (props: { length?: number isLineBreak?: boolean isMarkPlaceholder?: boolean }) => { const { length = 0, isLineBreak = false, isMarkPlaceholder = false } = props const attributes: { 'data-slate-zero-width': string 'data-slate-length': number 'data-slate-mark-placeholder'?: boolean } = { 'data-slate-zero-width': isLineBreak ? 'n' : 'z', 'data-slate-length': length, } if (isMarkPlaceholder) { attributes['data-slate-mark-placeholder'] = true } // FIXME: Inserting the \uFEFF on iOS breaks capitalization at the start of an // empty editor (https://github.com/ianstormtaylor/slate/issues/5199). // // However, not inserting the \uFEFF on iOS causes the editor to crash when // inserting any text using an IME at the start of a block. This appears to // be because accepting an IME suggestion when at the start of a block (no // preceding \uFEFF) removes one or more DOM elements that `toSlateRange` // depends on. (https://github.com/ianstormtaylor/slate/issues/5703) return ( {!IS_ANDROID || !isLineBreak ? '\uFEFF' : null} {isLineBreak ?
: null}
) } export default String