UNPKG

dropdeck-slate-react

Version:

Tools for building completely customizable richtext editors with React.

1,459 lines (1,227 loc) 84.4 kB
'use strict'; Object.defineProperty(exports, '__esModule', { value: true }); var React = require('react'); var slate = require('slate'); var throttle = require('lodash/throttle'); var scrollIntoView = require('scroll-into-view-if-needed'); var getDirection = require('direction'); var isHotkey = require('is-hotkey'); var ReactDOM = require('react-dom'); function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; } var React__default = /*#__PURE__*/_interopDefaultLegacy(React); var throttle__default = /*#__PURE__*/_interopDefaultLegacy(throttle); var scrollIntoView__default = /*#__PURE__*/_interopDefaultLegacy(scrollIntoView); var getDirection__default = /*#__PURE__*/_interopDefaultLegacy(getDirection); var ReactDOM__default = /*#__PURE__*/_interopDefaultLegacy(ReactDOM); function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; } var defineProperty = _defineProperty; function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; } var arrayWithHoles = _arrayWithHoles; function _iterableToArrayLimit(arr, i) { if (!(Symbol.iterator in Object(arr) || Object.prototype.toString.call(arr) === "[object Arguments]")) { return; } var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; } var iterableToArrayLimit = _iterableToArrayLimit; function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); } var nonIterableRest = _nonIterableRest; function _slicedToArray(arr, i) { return arrayWithHoles(arr) || iterableToArrayLimit(arr, i) || nonIterableRest(); } var slicedToArray = _slicedToArray; function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; } var objectWithoutPropertiesLoose = _objectWithoutPropertiesLoose; function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; } var objectWithoutProperties = _objectWithoutProperties; /** * Leaf content strings. */ var String = function String(props) { var isLast = props.isLast, leaf = props.leaf, parent = props.parent, text = props.text; var editor = useEditor(); var path = ReactEditor.findPath(editor, text); var parentPath = slate.Path.parent(path); // 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 React__default['default'].createElement(ZeroWidthString, { length: slate.Node.string(parent).length }); } // 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) && slate.Editor.string(editor, parentPath) === '') { return React__default['default'].createElement(ZeroWidthString, { isLineBreak: true }); } // 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 React__default['default'].createElement(ZeroWidthString, null); } // 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 React__default['default'].createElement(TextString, { isTrailing: true, text: leaf.text }); } return React__default['default'].createElement(TextString, { text: leaf.text }); }; /** * Leaf strings with text in them. */ var TextString = function TextString(props) { var text = props.text, _props$isTrailing = props.isTrailing, isTrailing = _props$isTrailing === void 0 ? false : _props$isTrailing; return React__default['default'].createElement("span", { "data-slate-string": true }, text, isTrailing ? '\n' : null); }; /** * Leaf strings without text, render as zero-width strings. */ var ZeroWidthString = function ZeroWidthString(props) { var _props$length = props.length, length = _props$length === void 0 ? 0 : _props$length, _props$isLineBreak = props.isLineBreak, isLineBreak = _props$isLineBreak === void 0 ? false : _props$isLineBreak; return React__default['default'].createElement("span", { "data-slate-zero-width": isLineBreak ? 'n' : 'z', "data-slate-length": length }, "\uFEFF", isLineBreak ? React__default['default'].createElement("br", null) : null); }; /** * Two weak maps that allow us rebuild a path given a node. They are populated * at render time such that after a render occurs we can always backtrack. */ var NODE_TO_INDEX = new WeakMap(); var NODE_TO_PARENT = new WeakMap(); /** * Weak maps that allow us to go between Slate nodes and DOM nodes. These * are used to resolve DOM event-related logic into Slate actions. */ var EDITOR_TO_ELEMENT = new WeakMap(); var ELEMENT_TO_NODE = new WeakMap(); var KEY_TO_ELEMENT = new WeakMap(); var NODE_TO_ELEMENT = new WeakMap(); var NODE_TO_KEY = new WeakMap(); /** * Weak maps for storing editor-related state. */ var IS_READ_ONLY = new WeakMap(); var IS_FOCUSED = new WeakMap(); /** * Weak map for associating the context `onChange` context with the plugin. */ var EDITOR_TO_ON_CHANGE = new WeakMap(); /** * Symbols. */ var PLACEHOLDER_SYMBOL = Symbol('placeholder'); /** * Individual leaves in a text node with unique formatting. */ var Leaf = function Leaf(props) { var leaf = props.leaf, isLast = props.isLast, text = props.text, parent = props.parent, _props$renderLeaf = props.renderLeaf, renderLeaf = _props$renderLeaf === void 0 ? function (props) { return React__default['default'].createElement(DefaultLeaf, Object.assign({}, props)); } : _props$renderLeaf; var children = React__default['default'].createElement(String, { isLast: isLast, leaf: leaf, parent: parent, text: text }); if (leaf[PLACEHOLDER_SYMBOL]) { children = React__default['default'].createElement(React__default['default'].Fragment, null, React__default['default'].createElement("span", { contentEditable: false, style: { pointerEvents: 'none', display: 'inline-block', width: '0', maxWidth: '100%', whiteSpace: 'nowrap', opacity: '0.333', userSelect: 'none', fontStyle: 'normal', fontWeight: 'normal', textDecoration: 'none' } }, leaf.placeholder), children); } // COMPAT: Having the `data-` attributes on these leaf elements ensures that // in certain misbehaving browsers they aren't weirdly cloned/destroyed by // contenteditable behaviors. (2019/05/08) var attributes = { 'data-slate-leaf': true }; return renderLeaf({ attributes: attributes, children: children, leaf: leaf, text: text }); }; var MemoizedLeaf = React__default['default'].memo(Leaf, function (prev, next) { return next.parent === prev.parent && next.isLast === prev.isLast && next.renderLeaf === prev.renderLeaf && next.text === prev.text && slate.Text.matches(next.leaf, prev.leaf); }); /** * The default custom leaf renderer. */ var DefaultLeaf = function DefaultLeaf(props) { var attributes = props.attributes, children = props.children; return React__default['default'].createElement("span", Object.assign({}, attributes), children); }; /** * Prevent warning on SSR by falling back to useEffect when window is not defined */ var useIsomorphicLayoutEffect = typeof window !== 'undefined' ? React.useLayoutEffect : React.useEffect; /** * Text. */ var Text = function Text(props) { var decorations = props.decorations, isLast = props.isLast, parent = props.parent, renderLeaf = props.renderLeaf, text = props.text; var editor = useEditor(); var ref = React.useRef(null); var leaves = slate.Text.decorations(text, decorations); var key = ReactEditor.findKey(editor, text); var children = []; for (var i = 0; i < leaves.length; i++) { var leaf = leaves[i]; children.push(React__default['default'].createElement(MemoizedLeaf, { isLast: isLast && i === leaves.length - 1, key: "".concat(key.id, "-").concat(i), leaf: leaf, text: text, parent: parent, renderLeaf: renderLeaf })); } // Update element-related weak maps with the DOM element ref. useIsomorphicLayoutEffect(function () { if (ref.current) { KEY_TO_ELEMENT.set(key, ref.current); NODE_TO_ELEMENT.set(text, ref.current); ELEMENT_TO_NODE.set(ref.current, text); } else { KEY_TO_ELEMENT["delete"](key); NODE_TO_ELEMENT["delete"](text); } }); return React__default['default'].createElement("span", { "data-slate-node": "text", ref: ref }, children); }; var MemoizedText = React__default['default'].memo(Text, function (prev, next) { return next.parent === prev.parent && next.isLast === prev.isLast && next.renderLeaf === prev.renderLeaf && next.text === prev.text; }); /** * A React context for sharing the `selected` state of an element. */ var SelectedContext = React.createContext(false); /** * Get the current `selected` state of an element. */ var useSelected = function useSelected() { return React.useContext(SelectedContext); }; /** * Element. */ var Element = function Element(props) { var decorate = props.decorate, decorations = props.decorations, element = props.element, _props$renderElement = props.renderElement, renderElement = _props$renderElement === void 0 ? function (p) { return React__default['default'].createElement(DefaultElement, Object.assign({}, p)); } : _props$renderElement, renderLeaf = props.renderLeaf, selection = props.selection; var ref = React.useRef(null); var editor = useEditor(); var readOnly = useReadOnly(); var isInline = editor.isInline(element); var key = ReactEditor.findKey(editor, element); var children = React__default['default'].createElement(Children, { decorate: decorate, decorations: decorations, node: element, renderElement: renderElement, renderLeaf: renderLeaf, selection: selection }); // Attributes that the developer must mix into the element in their // custom node renderer component. var attributes = { 'data-slate-node': 'element', ref: ref }; if (isInline) { attributes['data-slate-inline'] = true; } // If it's a block node with inline children, add the proper `dir` attribute // for text direction. if (!isInline && slate.Editor.hasInlines(editor, element)) { var text = slate.Node.string(element); var dir = getDirection__default['default'](text); if (dir === 'rtl') { attributes.dir = dir; } } // If it's a void node, wrap the children in extra void-specific elements. if (slate.Editor.isVoid(editor, element)) { attributes['data-slate-void'] = true; if (!readOnly && isInline) { attributes.contentEditable = false; } var Tag = isInline ? 'span' : 'div'; var _Node$texts = slate.Node.texts(element), _Node$texts2 = slicedToArray(_Node$texts, 1), _Node$texts2$ = slicedToArray(_Node$texts2[0], 1), _text = _Node$texts2$[0]; children = readOnly ? null : React__default['default'].createElement(Tag, { "data-slate-spacer": true, style: { height: '0', color: 'transparent', outline: 'none', position: 'absolute' } }, React__default['default'].createElement(MemoizedText, { decorations: [], isLast: false, parent: element, text: _text })); NODE_TO_INDEX.set(_text, 0); NODE_TO_PARENT.set(_text, element); } // Update element-related weak maps with the DOM element ref. useIsomorphicLayoutEffect(function () { if (ref.current) { KEY_TO_ELEMENT.set(key, ref.current); NODE_TO_ELEMENT.set(element, ref.current); ELEMENT_TO_NODE.set(ref.current, element); } else { KEY_TO_ELEMENT["delete"](key); NODE_TO_ELEMENT["delete"](element); } }); return React__default['default'].createElement(SelectedContext.Provider, { value: !!selection }, renderElement({ attributes: attributes, children: children, element: element })); }; var MemoizedElement = React__default['default'].memo(Element, function (prev, next) { return prev.decorate === next.decorate && prev.element === next.element && prev.renderElement === next.renderElement && prev.renderLeaf === next.renderLeaf && isRangeListEqual(prev.decorations, next.decorations) && (prev.selection === next.selection || !!prev.selection && !!next.selection && slate.Range.equals(prev.selection, next.selection)); }); /** * The default element renderer. */ var DefaultElement = function DefaultElement(props) { var attributes = props.attributes, children = props.children, element = props.element; var editor = useEditor(); var Tag = editor.isInline(element) ? 'span' : 'div'; return React__default['default'].createElement(Tag, Object.assign({}, attributes, { style: { position: 'relative' } }), children); }; /** * Check if a list of ranges is equal to another. * * PERF: this requires the two lists to also have the ranges inside them in the * same order, but this is an okay constraint for us since decorations are * kept in order, and the odd case where they aren't is okay to re-render for. */ var isRangeListEqual = function isRangeListEqual(list, another) { if (list.length !== another.length) { return false; } for (var i = 0; i < list.length; i++) { var range = list[i]; var other = another[i]; if (!slate.Range.equals(range, other)) { return false; } } return true; }; /** * A React context for sharing the editor object. */ var EditorContext = React.createContext(null); /** * Get the current editor object from the React context. */ var useEditor = function useEditor() { var editor = React.useContext(EditorContext); if (!editor) { throw new Error("The `useEditor` hook must be used inside the <Slate> component's context."); } return editor; }; /** * Children. */ var Children = function Children(props) { var decorate = props.decorate, decorations = props.decorations, node = props.node, renderElement = props.renderElement, renderLeaf = props.renderLeaf, selection = props.selection; var editor = useEditor(); var path = ReactEditor.findPath(editor, node); var children = []; var isLeafBlock = slate.Element.isElement(node) && !editor.isInline(node) && slate.Editor.hasInlines(editor, node); for (var i = 0; i < node.children.length; i++) { var p = path.concat(i); var n = node.children[i]; var key = ReactEditor.findKey(editor, n); var range = null; try { range = slate.Editor.range(editor, p); } catch (e) { console.log("Unable to get range for ".concat(JSON.stringify(p)), e); } var sel = selection && range && slate.Range.intersection(range, selection); var ds = decorate([n, p]); var _iteratorNormalCompletion = true; var _didIteratorError = false; var _iteratorError = undefined; try { for (var _iterator = decorations[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) { var dec = _step.value; var d = range && slate.Range.intersection(dec, range); if (d) { ds.push(d); } } } catch (err) { _didIteratorError = true; _iteratorError = err; } finally { try { if (!_iteratorNormalCompletion && _iterator["return"] != null) { _iterator["return"](); } } finally { if (_didIteratorError) { throw _iteratorError; } } } if (slate.Element.isElement(n)) { children.push(React__default['default'].createElement(MemoizedElement, { decorate: decorate, decorations: ds, element: n, key: key.id, renderElement: renderElement, renderLeaf: renderLeaf, selection: sel })); } else { children.push(React__default['default'].createElement(MemoizedText, { decorations: ds, key: key.id, isLast: isLeafBlock && i === node.children.length - 1, parent: node, renderLeaf: renderLeaf, text: n })); } NODE_TO_INDEX.set(n, i); NODE_TO_PARENT.set(n, node); } return React__default['default'].createElement(React__default['default'].Fragment, null, children); }; var IS_IOS = typeof navigator !== 'undefined' && typeof window !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent) && !window.MSStream; var IS_APPLE = typeof navigator !== 'undefined' && /Mac OS X/.test(navigator.userAgent); var IS_FIREFOX = typeof navigator !== 'undefined' && /^(?!.*Seamonkey)(?=.*Firefox).*/i.test(navigator.userAgent); var IS_SAFARI = typeof navigator !== 'undefined' && /Version\/[\d\.]+.*Safari/.test(navigator.userAgent); // "modern" Edge was released at 79.x var IS_EDGE_LEGACY = typeof navigator !== 'undefined' && /Edge?\/(?:[0-6][0-9]|[0-7][0-8])(?:\.)/i.test(navigator.userAgent); // Native beforeInput events don't work well with react on Chrome 75 and older, Chrome 76+ can use beforeInput var IS_CHROME_LEGACY = typeof navigator !== 'undefined' && /Chrome?\/(?:[0-7][0-5]|[0-6][0-9])(?:\.)/i.test(navigator.userAgent); // Firefox did not support `beforeInput` until `v87`. var IS_FIREFOX_LEGACY = typeof navigator !== 'undefined' && /^(?!.*Seamonkey)(?=.*Firefox\/(?:[0-7][0-9]|[0-8][0-6])(?:\.)).*/i.test(navigator.userAgent); /** * Hotkey mappings for each platform. */ var HOTKEYS = { bold: 'mod+b', compose: ['down', 'left', 'right', 'up', 'backspace', 'enter'], moveBackward: 'left', moveForward: 'right', moveWordBackward: 'ctrl+left', moveWordForward: 'ctrl+right', deleteBackward: 'shift?+backspace', deleteForward: 'shift?+delete', extendBackward: 'shift+left', extendForward: 'shift+right', italic: 'mod+i', splitBlock: 'shift?+enter', undo: 'mod+z' }; var APPLE_HOTKEYS = { moveLineBackward: 'opt+up', moveLineForward: 'opt+down', moveWordBackward: 'opt+left', moveWordForward: 'opt+right', deleteBackward: ['ctrl+backspace', 'ctrl+h'], deleteForward: ['ctrl+delete', 'ctrl+d'], deleteLineBackward: 'cmd+shift?+backspace', deleteLineForward: ['cmd+shift?+delete', 'ctrl+k'], deleteWordBackward: 'opt+shift?+backspace', deleteWordForward: 'opt+shift?+delete', extendLineBackward: 'opt+shift+up', extendLineForward: 'opt+shift+down', redo: 'cmd+shift+z', transposeCharacter: 'ctrl+t' }; var WINDOWS_HOTKEYS = { deleteWordBackward: 'ctrl+shift?+backspace', deleteWordForward: 'ctrl+shift?+delete', redo: ['ctrl+y', 'ctrl+shift+z'] }; /** * Create a platform-aware hotkey checker. */ var create = function create(key) { var generic = HOTKEYS[key]; var apple = APPLE_HOTKEYS[key]; var windows = WINDOWS_HOTKEYS[key]; var isGeneric = generic && isHotkey.isKeyHotkey(generic); var isApple = apple && isHotkey.isKeyHotkey(apple); var isWindows = windows && isHotkey.isKeyHotkey(windows); return function (event) { if (isGeneric && isGeneric(event)) return true; if (IS_APPLE && isApple && isApple(event)) return true; if (!IS_APPLE && isWindows && isWindows(event)) return true; return false; }; }; /** * Hotkeys. */ var Hotkeys = { isBold: create('bold'), isCompose: create('compose'), isMoveBackward: create('moveBackward'), isMoveForward: create('moveForward'), isDeleteBackward: create('deleteBackward'), isDeleteForward: create('deleteForward'), isDeleteLineBackward: create('deleteLineBackward'), isDeleteLineForward: create('deleteLineForward'), isDeleteWordBackward: create('deleteWordBackward'), isDeleteWordForward: create('deleteWordForward'), isExtendBackward: create('extendBackward'), isExtendForward: create('extendForward'), isExtendLineBackward: create('extendLineBackward'), isExtendLineForward: create('extendLineForward'), isItalic: create('italic'), isMoveLineBackward: create('moveLineBackward'), isMoveLineForward: create('moveLineForward'), isMoveWordBackward: create('moveWordBackward'), isMoveWordForward: create('moveWordForward'), isRedo: create('redo'), isSplitBlock: create('splitBlock'), isTransposeCharacter: create('transposeCharacter'), isUndo: create('undo') }; /** * A React context for sharing the `readOnly` state of the editor. */ var ReadOnlyContext = React.createContext(false); /** * Get the current `readOnly` state of the editor. */ var useReadOnly = function useReadOnly() { return React.useContext(ReadOnlyContext); }; /** * A React context for sharing the editor object, in a way that re-renders the * context whenever changes occur. */ var SlateContext = React.createContext(null); /** * Get the current editor object from the React context. */ var useSlate = function useSlate() { var context = React.useContext(SlateContext); if (!context) { throw new Error("The `useSlate` hook must be used inside the <SlateProvider> component's context."); } var _context = slicedToArray(context, 1), editor = _context[0]; return editor; }; /** * Check if a DOM node is a comment node. */ var isDOMComment = function isDOMComment(value) { return isDOMNode(value) && value.nodeType === 8; }; /** * Check if a DOM node is an element node. */ var isDOMElement = function isDOMElement(value) { return isDOMNode(value) && value.nodeType === 1; }; /** * Check if a value is a DOM node. */ var isDOMNode = function isDOMNode(value) { return value instanceof Node; }; /** * Check if a DOM node is an element node. */ var isDOMText = function isDOMText(value) { return isDOMNode(value) && value.nodeType === 3; }; /** * Checks whether a paste event is a plaintext-only event. */ var isPlainTextOnlyPaste = function isPlainTextOnlyPaste(event) { return event.clipboardData && event.clipboardData.getData('text/plain') !== '' && event.clipboardData.types.length === 1; }; /** * Normalize a DOM point so that it always refers to a text node. */ var normalizeDOMPoint = function normalizeDOMPoint(domPoint) { var _domPoint = slicedToArray(domPoint, 2), node = _domPoint[0], offset = _domPoint[1]; // If it's an element node, its offset refers to the index of its children // including comment nodes, so try to find the right text child node. if (isDOMElement(node) && node.childNodes.length) { var isLast = offset === node.childNodes.length; var direction = isLast ? 'backward' : 'forward'; var index = isLast ? offset - 1 : offset; node = getEditableChild(node, index, direction); // If the node has children, traverse until we have a leaf node. Leaf nodes // can be either text nodes, or other void DOM nodes. while (isDOMElement(node) && node.childNodes.length) { var i = isLast ? node.childNodes.length - 1 : 0; node = getEditableChild(node, i, direction); } // Determine the new offset inside the text node. offset = isLast && node.textContent != null ? node.textContent.length : 0; } // Return the node and offset. return [node, offset]; }; /** * Get the nearest editable child at `index` in a `parent`, preferring * `direction`. */ var getEditableChild = function getEditableChild(parent, index, direction) { var childNodes = parent.childNodes; var child = childNodes[index]; var i = index; var triedForward = false; var triedBackward = false; // While the child is a comment node, or an element node with no children, // keep iterating to find a sibling non-void, non-comment node. while (isDOMComment(child) || isDOMElement(child) && child.childNodes.length === 0 || isDOMElement(child) && child.getAttribute('contenteditable') === 'false') { if (triedForward && triedBackward) { break; } if (i >= childNodes.length) { triedForward = true; i = index - 1; direction = 'backward'; continue; } if (i < 0) { triedBackward = true; i = index + 1; direction = 'forward'; continue; } child = childNodes[i]; i += direction === 'forward' ? 1 : -1; } return child; }; /** * Get a plaintext representation of the content of a node, accounting for block * elements which get a newline appended. * * The domNode must be attached to the DOM. */ var getPlainText = function getPlainText(domNode) { var text = ''; if (isDOMText(domNode) && domNode.nodeValue) { return domNode.nodeValue; } if (isDOMElement(domNode)) { for (var _i = 0, _Array$from = Array.from(domNode.childNodes); _i < _Array$from.length; _i++) { var childNode = _Array$from[_i]; text += getPlainText(childNode); } var display = getComputedStyle(domNode).getPropertyValue('display'); if (display === 'block' || display === 'list' || domNode.tagName === 'BR') { text += '\n'; } } return text; }; /** * there is no way to create a reverse DOM Range using Range.setStart/setEnd * according to https://dom.spec.whatwg.org/#concept-range-bp-set. * Luckily it's possible to create a reverse selection via Selection.extend * * Note: Selection.extend is not implement in any version of IE (up to and including version 11) */ var setReverseDomSelection = function setReverseDomSelection(domRange, domSelection) { var newRange = domRange.cloneRange(); // collapses the range to end newRange.collapse(); // set both anchor and focus of the selection to domRange's focus domSelection.addRange(newRange); // moves the focus of the selection to domRange's anchor domSelection.extend(domRange.startContainer, domRange.startOffset); }; function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; } function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; } // Chrome Legacy doesn't support `beforeinput` correctly var HAS_BEFORE_INPUT_SUPPORT = !(IS_FIREFOX || IS_EDGE_LEGACY || IS_CHROME_LEGACY); /** * Editable. */ var Editable = function Editable(props) { var autoFocus = props.autoFocus, _props$decorate = props.decorate, decorate = _props$decorate === void 0 ? defaultDecorate : _props$decorate, propsOnDOMBeforeInput = props.onDOMBeforeInput, placeholder = props.placeholder, _props$readOnly = props.readOnly, readOnly = _props$readOnly === void 0 ? false : _props$readOnly, renderElement = props.renderElement, renderLeaf = props.renderLeaf, _props$style = props.style, style = _props$style === void 0 ? {} : _props$style, _props$as = props.as, Component = _props$as === void 0 ? 'div' : _props$as, attributes = objectWithoutProperties(props, ["autoFocus", "decorate", "onDOMBeforeInput", "placeholder", "readOnly", "renderElement", "renderLeaf", "style", "as"]); var editor = useSlate(); var ref = React.useRef(null); // Update internal state on each render. IS_READ_ONLY.set(editor, readOnly); // Keep track of some state for the event handler logic. var state = React.useMemo(function () { return { isComposing: false, isUpdatingSelection: false, latestElement: null }; }, []); // Update element-related weak maps with the DOM element ref. useIsomorphicLayoutEffect(function () { if (ref.current) { EDITOR_TO_ELEMENT.set(editor, ref.current); NODE_TO_ELEMENT.set(editor, ref.current); ELEMENT_TO_NODE.set(ref.current, editor); } else { NODE_TO_ELEMENT["delete"](editor); } }); // Whenever the editor updates, make sure the DOM selection state is in sync. useIsomorphicLayoutEffect(function () { var selection = editor.selection; var domSelection = window.getSelection(); if (state.isComposing || !domSelection || !ReactEditor.isFocused(editor)) { return; } var hasDomSelection = domSelection.type !== 'None'; // If the DOM selection is properly unset, we're done. if (!selection && !hasDomSelection) { return; } var newDomRange = null; try { newDomRange = selection && ReactEditor.toDOMRange(editor, selection); } catch (e) { console.log("Unable to find a native DOM range from the current selection: ".concat(e)); } // verify that the dom selection is in the editor var editorElement = EDITOR_TO_ELEMENT.get(editor); var hasDomSelectionInEditor = false; if (editorElement.contains(domSelection.anchorNode) && editorElement.contains(domSelection.focusNode)) { hasDomSelectionInEditor = true; } // If the DOM selection is in the editor and the editor selection is already correct, we're done. if (hasDomSelection && hasDomSelectionInEditor && selection && newDomRange && isRangeEqual(domSelection.getRangeAt(0), newDomRange) // Range.equals(ReactEditor.toSlateRange(editor, domSelection), selection) ) { return; } // Otherwise the DOM selection is out of sync, so update it. var el = ReactEditor.toDOMNode(editor, editor); state.isUpdatingSelection = true; domSelection.removeAllRanges(); if (newDomRange) { if (slate.Range.isBackward(selection)) { setReverseDomSelection(newDomRange, domSelection); } else { domSelection.addRange(newDomRange); } var leafEl = newDomRange.startContainer.parentElement; scrollIntoView__default['default'](leafEl, { scrollMode: 'if-needed', boundary: el }); } setTimeout(function () { // COMPAT: In Firefox, it's not enough to create a range, you also need // to focus the contenteditable element too. (2016/11/16) if (newDomRange && IS_FIREFOX) { el.focus(); } state.isUpdatingSelection = false; }); }); // The autoFocus TextareaHTMLAttribute doesn't do anything on a div, so it // needs to be manually focused. React.useEffect(function () { if (ref.current && autoFocus) { ref.current.focus(); } }, [autoFocus]); // Listen on the native `beforeinput` event to get real "Level 2" events. This // is required because React's `beforeinput` is fake and never really attaches // to the real event sadly. (2019/11/01) // https://github.com/facebook/react/issues/11211 var onDOMBeforeInput = React.useCallback(function (event) { if (!readOnly && hasEditableTarget(editor, event.target) && !isDOMEventHandled(event, propsOnDOMBeforeInput)) { var selection = editor.selection; var type = event.inputType; var data = event.dataTransfer || event.data || undefined; // These two types occur while a user is composing text and can't be // cancelled. Let them through and wait for the composition to end. if (type === 'insertCompositionText' || type === 'deleteCompositionText') { return; } event.preventDefault(); // COMPAT: For the deleting forward/backward input types we don't want // to change the selection because it is the range that will be deleted, // and those commands determine that for themselves. if (!type.startsWith('delete') || type.startsWith('deleteBy')) { var _event$getTargetRange = event.getTargetRanges(), _event$getTargetRange2 = slicedToArray(_event$getTargetRange, 1), targetRange = _event$getTargetRange2[0]; if (targetRange) { var range = ReactEditor.toSlateRange(editor, targetRange); if (!selection || !slate.Range.equals(selection, range)) { slate.Transforms.select(editor, range); } } } // COMPAT: If the selection is expanded, even if the command seems like // a delete forward/backward command it should delete the selection. if (selection && slate.Range.isExpanded(selection) && type.startsWith('delete')) { slate.Editor.deleteFragment(editor); return; } switch (type) { case 'deleteByComposition': case 'deleteByCut': case 'deleteByDrag': { slate.Editor.deleteFragment(editor); break; } case 'deleteContent': case 'deleteContentForward': { slate.Editor.deleteForward(editor); break; } case 'deleteContentBackward': { slate.Editor.deleteBackward(editor); break; } case 'deleteEntireSoftLine': { slate.Editor.deleteBackward(editor, { unit: 'line' }); slate.Editor.deleteForward(editor, { unit: 'line' }); break; } case 'deleteHardLineBackward': { slate.Editor.deleteBackward(editor, { unit: 'block' }); break; } case 'deleteSoftLineBackward': { slate.Editor.deleteBackward(editor, { unit: 'line' }); break; } case 'deleteHardLineForward': { slate.Editor.deleteForward(editor, { unit: 'block' }); break; } case 'deleteSoftLineForward': { slate.Editor.deleteForward(editor, { unit: 'line' }); break; } case 'deleteWordBackward': { slate.Editor.deleteBackward(editor, { unit: 'word' }); break; } case 'deleteWordForward': { slate.Editor.deleteForward(editor, { unit: 'word' }); break; } case 'insertLineBreak': case 'insertParagraph': { slate.Editor.insertBreak(editor); break; } case 'insertFromComposition': case 'insertFromDrop': case 'insertFromPaste': case 'insertFromYank': case 'insertReplacementText': case 'insertText': { if (data instanceof DataTransfer) { ReactEditor.insertData(editor, data); } else if (typeof data === 'string') { slate.Editor.insertText(editor, data); } break; } } } }, [readOnly, propsOnDOMBeforeInput]); // Attach a native DOM event handler for `beforeinput` events, because React's // built-in `onBeforeInput` is actually a leaky polyfill that doesn't expose // real `beforeinput` events sadly... (2019/11/04) // https://github.com/facebook/react/issues/11211 useIsomorphicLayoutEffect(function () { if (ref.current && HAS_BEFORE_INPUT_SUPPORT) { // @ts-ignore The `beforeinput` event isn't recognized. ref.current.addEventListener('beforeinput', onDOMBeforeInput); } return function () { if (ref.current && HAS_BEFORE_INPUT_SUPPORT) { // @ts-ignore The `beforeinput` event isn't recognized. ref.current.removeEventListener('beforeinput', onDOMBeforeInput); } }; }, [onDOMBeforeInput]); // Listen on the native `selectionchange` event to be able to update any time // the selection changes. This is required because React's `onSelect` is leaky // and non-standard so it doesn't fire until after a selection has been // released. This causes issues in situations where another change happens // while a selection is being dragged. var onDOMSelectionChange = React.useCallback(throttle__default['default'](function () { if (!readOnly && !state.isComposing && !state.isUpdatingSelection) { var activeElement = window.document.activeElement; var el = ReactEditor.toDOMNode(editor, editor); var domSelection = window.getSelection(); if (activeElement === el) { state.latestElement = activeElement; IS_FOCUSED.set(editor, true); } else { IS_FOCUSED["delete"](editor); } if (!domSelection) { return slate.Transforms.deselect(editor); } var anchorNode = domSelection.anchorNode, focusNode = domSelection.focusNode; var anchorNodeSelectable = hasEditableTarget(editor, anchorNode) || isTargetInsideVoid(editor, anchorNode); var focusNodeSelectable = hasEditableTarget(editor, focusNode) || isTargetInsideVoid(editor, focusNode); if (anchorNodeSelectable && focusNodeSelectable) { var range = ReactEditor.toSlateRange(editor, domSelection); slate.Transforms.select(editor, range); } else { slate.Transforms.deselect(editor); } } }, 100), [readOnly]); // Attach a native DOM event handler for `selectionchange`, because React's // built-in `onSelect` handler doesn't fire for all selection changes. It's a // leaky polyfill that only fires on keypresses or clicks. Instead, we want to // fire for any change to the selection inside the editor. (2019/11/04) // https://github.com/facebook/react/issues/5785 useIsomorphicLayoutEffect(function () { window.document.addEventListener('selectionchange', onDOMSelectionChange); return function () { window.document.removeEventListener('selectionchange', onDOMSelectionChange); }; }, [onDOMSelectionChange]); var decorations = decorate([editor, []]); if (placeholder && editor.children.length === 1 && Array.from(slate.Node.texts(editor)).length === 1 && slate.Node.string(editor) === '') { var _decorations$push; var start = slate.Editor.start(editor, []); decorations.push((_decorations$push = {}, defineProperty(_decorations$push, PLACEHOLDER_SYMBOL, true), defineProperty(_decorations$push, "placeholder", placeholder), defineProperty(_decorations$push, "anchor", start), defineProperty(_decorations$push, "focus", start), _decorations$push)); } return React__default['default'].createElement(ReadOnlyContext.Provider, { value: readOnly }, React__default['default'].createElement(Component // COMPAT: The Grammarly Chrome extension works by changing the DOM // out from under `contenteditable` elements, which leads to weird // behaviors so we have to disable it like editor. (2017/04/24) , Object.assign({ "data-gramm": false, role: readOnly ? undefined : 'textbox' }, attributes, { // COMPAT: Certain browsers don't support the `beforeinput` event, so we'd // have to use hacks to make these replacement-based features work. spellCheck: !HAS_BEFORE_INPUT_SUPPORT ? undefined : attributes.spellCheck, autoCorrect: !HAS_BEFORE_INPUT_SUPPORT ? undefined : attributes.autoCorrect, autoCapitalize: !HAS_BEFORE_INPUT_SUPPORT ? undefined : attributes.autoCapitalize, "data-slate-editor": true, "data-slate-node": "value", contentEditable: readOnly ? undefined : true, suppressContentEditableWarning: true, ref: ref, style: _objectSpread({ // Prevent the default outline styles. outline: 'none', // Preserve adjacent whitespace and new lines. whiteSpace: 'pre-wrap', // Allow words to break if they are too long. wordWrap: 'break-word' }, style), onBeforeInput: React.useCallback(function (event) { // COMPAT: Certain browsers don't support the `beforeinput` event, so we // fall back to React's leaky polyfill instead just for it. It // only works for the `insertText` input type. if (!HAS_BEFORE_INPUT_SUPPORT && !readOnly && !isEventHandled(event, attributes.onBeforeInput) && hasEditableTarget(editor, event.target)) { event.preventDefault(); var text = event.data; slate.Editor.insertText(editor, text); } }, [readOnly]), onBlur: React.useCallback(function (event) { if (readOnly || state.isUpdatingSelection || !hasEditableTarget(editor, event.target) || isEventHandled(event, attributes.onBlur)) { return; } // COMPAT: If the current `activeElement` is still the previous // one, this is due to the window being blurred when the tab // itself becomes unfocused, so we want to abort early to allow to // editor to stay focused when the tab becomes focused again. if (state.latestElement === window.document.activeElement) { return; } var relatedTarget = event.relatedTarget; var el = ReactEditor.toDOMNode(editor, editor); // COMPAT: The event should be ignored if the focus is returning // to the editor from an embedded editable element (eg. an <input> // element inside a void node). if (relatedTarget === el) { return; } // COMPAT: The event should be ignored if the focus is moving from // the editor to inside a void node's spacer element. if (isDOMElement(relatedTarget) && relatedTarget.hasAttribute('data-slate-spacer')) { return; } // COMPAT: The event should be ignored if the focus is moving to a // non- editable section of an element that isn't a void node (eg. // a list item of the check list example). if (relatedTarget != null && isDOMNode(relatedTarget) && ReactEditor.hasDOMNode(editor, relatedTarget)) { var node = ReactEditor.toSlateNode(editor, relatedTarget); if (slate.Element.isElement(node) && !editor.isVoid(node)) { return; } } IS_FOCUSED["delete"](editor); }, [readOnly, attributes.onBlur]), onClick: React.useCallback(function (event) { if (!readOnly && hasTarget(editor, event.target) && !isEventHandled(event, attributes.onClick) && isDOMNode(event.target)) { var node = ReactEditor.toSlateNode(editor, event.target); var path = ReactEditor.findPath(editor, node); var _start = slate.Editor.start(editor, path); var end = slate.Editor.end(editor, path); var startVoid = slate.Editor["void"](editor, { at: _start }); var endVoid = slate.Editor["void"](editor, { at: end }); if (startVoid && endVoid && slate.Path.equals(startVoid[1], endVoid[1])) { var range = slate.Editor.range(editor, _start); slate.Transforms.select(editor, range); } } }, [readOnly, attributes.onClick]), onCompositionEnd: React.useCallback(function (event) { if (hasEditableTarget(editor, event.target) && !isEventHandled(event, attributes.onCompositionEnd)) { state.isComposing = false; // COMPAT: In Chrome, `beforeinput` events for compositions // aren't correct and never fire the "insertFromComposition" // type that we need. So instead, insert whenever a composition // ends since it will already have been committed to the DOM. if (!IS_SAFARI && !IS_FIREFOX_LEGACY && !IS_IOS && event.data) { slate.Editor.insertText(editor, event.data); } } }, [attributes.onCompositionEnd]), onCompositionStart: React.useCallback(function (event) { if (hasEditableTarget(editor, event.target) && !isEventHandled(event, attributes.onCompositionStart)) { state.isComposing = true; } }, [attributes.onCompositionStart]), onCopy: React.useCallback(function (event) { if (hasEditableTarget(editor, event.target) && !isEventHandled(event, attributes.onCopy)) { event.preventDefault(); ReactEditor.setFragmentData(editor, event.clipboardData); } }, [attributes.onCopy]), onCut: React.useCallback(function (event) { if (!readOnly && hasEditableTarget(editor, event.target) && !isEventHandled(event, attributes.onCut)) { event.preventDefault(); ReactEditor.setFragmentData(editor, event.clipboardData); var selection = editor.selection; if (selection && slate.Range.isExpanded(selection)) { slate.Editor.deleteFragment(editor); } } }, [readOnly, attributes.onCut]), onDragOver: React.useCallback(function (event) { if (hasTarget(editor, event.target) && !isEventHandled(event, attributes.onDragOver)) { // Only when the target is void, call `preventDefault` to signal // that drops are allowed. Editable content is droppable by // default, and calling `preventDefault` hides the cursor. var node = ReactEditor.toSlateNode(editor, event.target); if (slate.Editor.isVoid(editor, node)) { event.preventDefault(); } } }, [attributes.onDragOver]), onDragStart: React.useCallback(function (event) { if (hasTarget(editor, event.target) && !isEventHandled(event, attributes.onDragStart)) { var node = ReactEditor.toSlateNode(editor, event.target); var path = ReactEditor.findPath(editor, node); var voidMatch = slate.Editor["void"](editor, { at: path }); // If starting a drag on a void node, make sure it is selected // so that it shows up in the selection's fragment. if (voidMatch) { var range = slate.Editor.range(editor, path); slate.Transforms.select(editor, range); } ReactEditor.setFragmentData(editor, event.dataTransfer); } }, [attributes.onDragStart]), onDrop: React.useCallback(function (event) { if (hasTarget(editor, event.target) && !readOnly && !isEventHandled(event, attributes.onDrop)) { // COMPAT: Certain browsers don't fire `beforeinput` events at all, and // Chromium browsers don't properly fire them for files being // dropped into a `contenteditable`. (2019/11/26) // https://bugs.chromium.org/p/chromium/issues/detail?id=1028668 if (!HAS_BEFORE_INPUT_SUPPORT || !IS_SAFARI && event.dataTransfer.files.length > 0) { event.preventDefault(); var range = ReactEditor.findEventRange(editor, event); var data = event.dataTransfer; slate.Transforms.select(editor, range); ReactEditor.insertData(editor, data); } } }, [readOnly, attributes.onDrop]), onFocus: React.useCallback(function (event) { if (!readOnly && !state.isUpdatingSelection && hasEditableTarget(editor, event.target) && !isEventHandled(event, attributes.onFocus)) { var el = ReactEditor.toDOMNode(editor, editor); state.latestElement = window.document.activeElement; // COMPAT: If the editor has nested editable elements, the focus // can go to them. In Firefox, this must be prevented because it // results in issues with keyboard navigation. (2017/03/30) if (IS_FIREFOX && event.target !== el) { el.focus(); return; } IS_FOCUSED.set(editor, true); } }, [readOnly, attributes.onFocus]), onKeyDown: React.useCallback(function (event) { if (!readOnly && hasEditableTarget(editor, event.target) && !isEventHandled(event, attributes.onKeyDown)) { var nativeEvent = event.nativeEvent; var selection = editor.selection; // COMPAT: Since we prevent the default behavior on // `beforeinput` events, the browser doesn't think there's ever // any history stack to undo or redo, so we have to manage these // hotkeys ourselves. (2019/11/06) if (Hotkeys.isRedo(nativeEvent)) { event.preventDefault(); if (typeof editor.redo === 'function') { editor.redo(); } return; } if (Hotkeys.isUndo(nativeEvent)) { event.preventDefault(); if (typeof editor.undo