@lexical/react 0.7.8 → 0.8.0

package/LexicalTypeaheadMenuPlugin.dev.js

@@ -18,6 +18,7 @@ var React = require('react');
  * LICENSE file in the root directory of this source tree.
  *
  */
+
 const CAN_USE_DOM = typeof window !== 'undefined' && typeof window.document !== 'undefined' && typeof window.document.createElement !== 'undefined';
 
 /**
@@ -46,216 +47,171 @@ class TypeaheadOption {
     };
     this.setRefElement = this.setRefElement.bind(this);
   }
-
   setRefElement(element) {
     this.ref = {
       current: element
     };
   }
-
 }
-
 const scrollIntoViewIfNeeded = target => {
   const container = document.getElementById('typeahead-menu');
   if (!container) return;
   const typeaheadContainerNode = container.querySelector('.typeahead-popover');
   if (!typeaheadContainerNode) return;
   const typeaheadRect = typeaheadContainerNode.getBoundingClientRect();
-
   if (typeaheadRect.top + typeaheadRect.height > window.innerHeight) {
     typeaheadContainerNode.scrollIntoView({
       block: 'center'
     });
   }
-
   if (typeaheadRect.top < 0) {
     typeaheadContainerNode.scrollIntoView({
       block: 'center'
     });
   }
-
   target.scrollIntoView({
     block: 'nearest'
   });
 };
-
 function getTextUpToAnchor(selection) {
   const anchor = selection.anchor;
-
   if (anchor.type !== 'text') {
     return null;
   }
-
   const anchorNode = anchor.getNode();
-
   if (!anchorNode.isSimpleText()) {
     return null;
   }
-
   const anchorOffset = anchor.offset;
   return anchorNode.getTextContent().slice(0, anchorOffset);
 }
-
 function tryToPositionRange(leadOffset, range) {
   const domSelection = window.getSelection();
-
   if (domSelection === null || !domSelection.isCollapsed) {
     return false;
   }
-
   const anchorNode = domSelection.anchorNode;
   const startOffset = leadOffset;
   const endOffset = domSelection.anchorOffset;
-
   if (anchorNode == null || endOffset == null) {
     return false;
   }
-
   try {
     range.setStart(anchorNode, startOffset);
     range.setEnd(anchorNode, endOffset);
   } catch (error) {
     return false;
   }
-
   return true;
 }
-
 function getQueryTextForSearch(editor) {
   let text = null;
   editor.getEditorState().read(() => {
     const selection = lexical.$getSelection();
-
     if (!lexical.$isRangeSelection(selection)) {
       return;
     }
-
     text = getTextUpToAnchor(selection);
   });
   return text;
 }
+
 /**
  * Walk backwards along user input and forward through entity title to try
  * and replace more of the user's text with entity.
  */
-
-
 function getFullMatchOffset(documentText, entryText, offset) {
   let triggerOffset = offset;
-
   for (let i = triggerOffset; i <= entryText.length; i++) {
     if (documentText.substr(-i) === entryText.substr(0, i)) {
       triggerOffset = i;
     }
   }
-
   return triggerOffset;
 }
+
 /**
  * Split Lexical TextNode and return a new TextNode only containing matched text.
  * Common use cases include: removing the node, replacing with a new node.
  */
-
-
 function splitNodeContainingQuery(editor, match) {
   const selection = lexical.$getSelection();
-
   if (!lexical.$isRangeSelection(selection) || !selection.isCollapsed()) {
     return null;
   }
-
   const anchor = selection.anchor;
-
   if (anchor.type !== 'text') {
     return null;
   }
-
   const anchorNode = anchor.getNode();
-
   if (!anchorNode.isSimpleText()) {
     return null;
   }
-
   const selectionOffset = anchor.offset;
   const textContent = anchorNode.getTextContent().slice(0, selectionOffset);
   const characterOffset = match.replaceableString.length;
   const queryOffset = getFullMatchOffset(textContent, match.matchingString, characterOffset);
   const startOffset = selectionOffset - queryOffset;
-
   if (startOffset < 0) {
     return null;
   }
-
   let newNode;
-
   if (startOffset === 0) {
     [newNode] = anchorNode.splitText(selectionOffset);
   } else {
     [, newNode] = anchorNode.splitText(startOffset, selectionOffset);
   }
-
   return newNode;
 }
-
 function isSelectionOnEntityBoundary(editor, offset) {
   if (offset !== 0) {
     return false;
   }
-
   return editor.getEditorState().read(() => {
     const selection = lexical.$getSelection();
-
     if (lexical.$isRangeSelection(selection)) {
       const anchor = selection.anchor;
       const anchorNode = anchor.getNode();
       const prevSibling = anchorNode.getPreviousSibling();
       return lexical.$isTextNode(prevSibling) && prevSibling.isTextEntity();
     }
-
     return false;
   });
 }
-
 function startTransition(callback) {
   if (React.startTransition) {
     React.startTransition(callback);
   } else {
     callback();
   }
-} // Got from https://stackoverflow.com/a/42543908/2013580
-
+}
 
+// Got from https://stackoverflow.com/a/42543908/2013580
 function getScrollParent(element, includeHidden) {
   let style = getComputedStyle(element);
   const excludeStaticParent = style.position === 'absolute';
   const overflowRegex = includeHidden ? /(auto|scroll|hidden)/ : /(auto|scroll)/;
-
   if (style.position === 'fixed') {
     return document.body;
   }
-
   for (let parent = element; parent = parent.parentElement;) {
     style = getComputedStyle(parent);
-
     if (excludeStaticParent && style.position === 'static') {
       continue;
     }
-
     if (overflowRegex.test(style.overflow + style.overflowY + style.overflowX)) {
       return parent;
     }
   }
-
   return document.body;
 }
-
 function isTriggerVisibleInNearestScrollContainer(targetElement, containerElement) {
   const tRect = targetElement.getBoundingClientRect();
   const cRect = containerElement.getBoundingClientRect();
   return tRect.top > cRect.top && tRect.top < cRect.bottom;
-} // Reposition the menu on scroll, window resize, and element resize.
-
+}
 
+// Reposition the menu on scroll, window resize, and element resize.
 function useDynamicPositioning(resolution, targetElement, onReposition, onVisibilityChange) {
   const [editor] = LexicalComposerContext.useLexicalComposerContext();
   React.useEffect(() => {
@@ -264,7 +220,6 @@ function useDynamicPositioning(resolution, targetElement, onReposition, onVisibi
       const rootScrollParent = rootElement != null ? getScrollParent(rootElement, false) : document.body;
       let ticking = false;
       let previousIsInView = isTriggerVisibleInNearestScrollContainer(targetElement, rootScrollParent);
-
       const handleScroll = function () {
         if (!ticking) {
           window.requestAnimationFrame(function () {
@@ -273,18 +228,14 @@ function useDynamicPositioning(resolution, targetElement, onReposition, onVisibi
           });
           ticking = true;
         }
-
         const isInView = isTriggerVisibleInNearestScrollContainer(targetElement, rootScrollParent);
-
         if (isInView !== previousIsInView) {
           previousIsInView = isInView;
-
           if (onVisibilityChange != null) {
             onVisibilityChange(isInView);
           }
         }
       };
-
       const resizeObserver = new ResizeObserver(onReposition);
       window.addEventListener('resize', onReposition);
       document.addEventListener('scroll', handleScroll, {
@@ -301,7 +252,6 @@ function useDynamicPositioning(resolution, targetElement, onReposition, onVisibi
   }, [targetElement, editor, onVisibilityChange, onReposition, resolution]);
 }
 const SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND = lexical.createCommand('SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND');
-
 function LexicalPopoverMenu({
   close,
   editor,
@@ -323,7 +273,6 @@ function LexicalPopoverMenu({
   }, [close, editor, resolution.match, onSelectOption]);
   const updateSelectedIndex = React.useCallback(index => {
     const rootElem = editor.getRootElement();
-
     if (rootElem !== null) {
       rootElem.setAttribute('aria-activedescendant', 'typeahead-item-' + index);
       setHighlightedIndex(index);
@@ -332,7 +281,6 @@ function LexicalPopoverMenu({
   React.useEffect(() => {
     return () => {
       const rootElem = editor.getRootElement();
-
       if (rootElem !== null) {
         rootElem.removeAttribute('aria-activedescendant');
       }
@@ -353,47 +301,38 @@ function LexicalPopoverMenu({
         scrollIntoViewIfNeeded(option.ref.current);
         return true;
       }
-
       return false;
     }, lexical.COMMAND_PRIORITY_LOW));
   }, [editor, updateSelectedIndex]);
   React.useEffect(() => {
     return utils.mergeRegister(editor.registerCommand(lexical.KEY_ARROW_DOWN_COMMAND, payload => {
       const event = payload;
-
       if (options !== null && options.length && selectedIndex !== null) {
         const newSelectedIndex = selectedIndex !== options.length - 1 ? selectedIndex + 1 : 0;
         updateSelectedIndex(newSelectedIndex);
         const option = options[newSelectedIndex];
-
         if (option.ref != null && option.ref.current) {
           editor.dispatchCommand(SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND, {
             index: newSelectedIndex,
             option
           });
         }
-
         event.preventDefault();
         event.stopImmediatePropagation();
       }
-
       return true;
     }, lexical.COMMAND_PRIORITY_LOW), editor.registerCommand(lexical.KEY_ARROW_UP_COMMAND, payload => {
       const event = payload;
-
       if (options !== null && options.length && selectedIndex !== null) {
         const newSelectedIndex = selectedIndex !== 0 ? selectedIndex - 1 : options.length - 1;
         updateSelectedIndex(newSelectedIndex);
         const option = options[newSelectedIndex];
-
         if (option.ref != null && option.ref.current) {
           scrollIntoViewIfNeeded(option.ref.current);
         }
-
         event.preventDefault();
         event.stopImmediatePropagation();
       }
-
       return true;
     }, lexical.COMMAND_PRIORITY_LOW), editor.registerCommand(lexical.KEY_ESCAPE_COMMAND, payload => {
       const event = payload;
@@ -403,11 +342,9 @@ function LexicalPopoverMenu({
       return true;
     }, lexical.COMMAND_PRIORITY_LOW), editor.registerCommand(lexical.KEY_TAB_COMMAND, payload => {
       const event = payload;
-
       if (options === null || selectedIndex === null || options[selectedIndex] == null) {
         return false;
       }
-
       event.preventDefault();
       event.stopImmediatePropagation();
       selectOptionAndCleanUp(options[selectedIndex]);
@@ -416,12 +353,10 @@ function LexicalPopoverMenu({
       if (options === null || selectedIndex === null || options[selectedIndex] == null) {
         return false;
       }
-
       if (event !== null) {
         event.preventDefault();
         event.stopImmediatePropagation();
       }
-
       selectOptionAndCleanUp(options[selectedIndex]);
       return true;
     }, lexical.COMMAND_PRIORITY_LOW));
@@ -434,7 +369,6 @@ function LexicalPopoverMenu({
   }), [selectOptionAndCleanUp, selectedIndex, options]);
   return menuRenderFn(anchorElementRef, listItemProps, resolution.match.matchingString);
 }
-
 function useBasicTypeaheadTriggerMatch(trigger, {
   minLength = 1,
   maxLength = 75
@@ -443,11 +377,9 @@ function useBasicTypeaheadTriggerMatch(trigger, {
     const validChars = '[^' + trigger + PUNCTUATION + '\\s]';
     const TypeaheadTriggerRegex = new RegExp('(^|\\s|\\()(' + '[' + trigger + ']' + '((?:' + validChars + '){0,' + maxLength + '})' + ')$');
     const match = TypeaheadTriggerRegex.exec(text);
-
     if (match !== null) {
       const maybeLeadingWhitespace = match[1];
       const matchingString = match[3];
-
       if (matchingString.length >= minLength) {
         return {
           leadOffset: match.index + maybeLeadingWhitespace.length,
@@ -456,18 +388,15 @@ function useBasicTypeaheadTriggerMatch(trigger, {
         };
       }
     }
-
     return null;
   }, [maxLength, minLength, trigger]);
 }
-
 function useMenuAnchorRef(resolution, setResolution, className) {
   const [editor] = LexicalComposerContext.useLexicalComposerContext();
   const anchorElementRef = React.useRef(document.createElement('div'));
   const positionMenu = React.useCallback(() => {
     const rootElement = editor.getRootElement();
     const containerDiv = anchorElementRef.current;
-
     if (rootElement !== null && resolution !== null) {
       const {
         left,
@@ -479,12 +408,10 @@ function useMenuAnchorRef(resolution, setResolution, className) {
       containerDiv.style.left = `${left + window.pageXOffset}px`;
       containerDiv.style.height = `${height}px`;
       containerDiv.style.width = `${width}px`;
-
       if (!containerDiv.isConnected) {
         if (className != null) {
           containerDiv.className = className;
         }
-
         containerDiv.setAttribute('aria-label', 'Typeahead menu');
         containerDiv.setAttribute('id', 'typeahead-menu');
         containerDiv.setAttribute('role', 'listbox');
@@ -492,23 +419,19 @@ function useMenuAnchorRef(resolution, setResolution, className) {
         containerDiv.style.position = 'absolute';
         document.body.append(containerDiv);
       }
-
       anchorElementRef.current = containerDiv;
       rootElement.setAttribute('aria-controls', 'typeahead-menu');
     }
   }, [editor, resolution, className]);
   React.useEffect(() => {
     const rootElement = editor.getRootElement();
-
     if (resolution !== null) {
       positionMenu();
       return () => {
         if (rootElement !== null) {
           rootElement.removeAttribute('aria-controls');
         }
-
         const containerDiv = anchorElementRef.current;
-
         if (containerDiv !== null && containerDiv.isConnected) {
           containerDiv.remove();
         }
@@ -525,7 +448,6 @@ function useMenuAnchorRef(resolution, setResolution, className) {
   useDynamicPositioning(resolution, anchorElementRef.current, positionMenu, onVisibilityChange);
   return anchorElementRef;
 }
-
 function LexicalTypeaheadMenuPlugin({
   options,
   onQueryChange,
@@ -541,14 +463,12 @@ function LexicalTypeaheadMenuPlugin({
   const anchorElementRef = useMenuAnchorRef(resolution, setResolution, anchorClassName);
   const closeTypeahead = React.useCallback(() => {
     setResolution(null);
-
     if (onClose != null && resolution !== null) {
       onClose();
     }
   }, [onClose, resolution]);
   const openTypeahead = React.useCallback(res => {
     setResolution(res);
-
     if (onOpen != null && resolution === null) {
       onOpen(res);
     }
@@ -559,18 +479,14 @@ function LexicalTypeaheadMenuPlugin({
         const range = document.createRange();
         const selection = lexical.$getSelection();
         const text = getQueryTextForSearch(editor);
-
         if (!lexical.$isRangeSelection(selection) || !selection.isCollapsed() || text === null || range === null) {
           closeTypeahead();
           return;
         }
-
         const match = triggerFn(text, editor);
         onQueryChange(match ? match.matchingString : null);
-
         if (match !== null && !isSelectionOnEntityBoundary(editor, match.leadOffset)) {
           const isRangePositioned = tryToPositionRange(match.leadOffset, range);
-
           if (isRangePositioned !== null) {
             startTransition(() => openTypeahead({
               getRect: () => range.getBoundingClientRect(),
@@ -579,11 +495,9 @@ function LexicalTypeaheadMenuPlugin({
             return;
           }
         }
-
         closeTypeahead();
       });
     };
-
     const removeUpdateListener = editor.registerUpdateListener(updateListener);
     return () => {
       removeUpdateListener();
@@ -613,14 +527,12 @@ function LexicalNodeMenuPlugin({
   const anchorElementRef = useMenuAnchorRef(resolution, setResolution, anchorClassName);
   const closeNodeMenu = React.useCallback(() => {
     setResolution(null);
-
     if (onClose != null && resolution !== null) {
       onClose();
     }
   }, [onClose, resolution]);
   const openNodeMenu = React.useCallback(res => {
     setResolution(res);
-
     if (onOpen != null && resolution === null) {
       onOpen(res);
     }
@@ -630,7 +542,6 @@ function LexicalNodeMenuPlugin({
       editor.update(() => {
         const node = lexical.$getNodeByKey(nodeKey);
         const domElement = editor.getElementByKey(nodeKey);
-
         if (node != null && domElement != null) {
           const text = node.getTextContent();
           startTransition(() => openNodeMenu({

package/package.json

@@ -8,29 +8,29 @@
     "rich-text"
   ],
   "license": "MIT",
-  "version": "0.7.8",
+  "version": "0.8.0",
   "dependencies": {
-    "@lexical/clipboard": "0.7.8",
-    "@lexical/code": "0.7.8",
-    "@lexical/dragon": "0.7.8",
-    "@lexical/hashtag": "0.7.8",
-    "@lexical/history": "0.7.8",
-    "@lexical/link": "0.7.8",
-    "@lexical/list": "0.7.8",
-    "@lexical/mark": "0.7.8",
-    "@lexical/markdown": "0.7.8",
-    "@lexical/overflow": "0.7.8",
-    "@lexical/plain-text": "0.7.8",
-    "@lexical/rich-text": "0.7.8",
-    "@lexical/selection": "0.7.8",
-    "@lexical/table": "0.7.8",
-    "@lexical/text": "0.7.8",
-    "@lexical/utils": "0.7.8",
-    "@lexical/yjs": "0.7.8",
+    "@lexical/clipboard": "0.8.0",
+    "@lexical/code": "0.8.0",
+    "@lexical/dragon": "0.8.0",
+    "@lexical/hashtag": "0.8.0",
+    "@lexical/history": "0.8.0",
+    "@lexical/link": "0.8.0",
+    "@lexical/list": "0.8.0",
+    "@lexical/mark": "0.8.0",
+    "@lexical/markdown": "0.8.0",
+    "@lexical/overflow": "0.8.0",
+    "@lexical/plain-text": "0.8.0",
+    "@lexical/rich-text": "0.8.0",
+    "@lexical/selection": "0.8.0",
+    "@lexical/table": "0.8.0",
+    "@lexical/text": "0.8.0",
+    "@lexical/utils": "0.8.0",
+    "@lexical/yjs": "0.8.0",
     "react-error-boundary": "^3.1.4"
   },
   "peerDependencies": {
-    "lexical": "0.7.8",
+    "lexical": "0.8.0",
     "react": ">=17.x",
     "react-dom": ">=17.x"
   },

package/shared/useYjsCollaboration.d.ts

@@ -7,9 +7,9 @@
  */
 import type { Binding } from '@lexical/yjs';
 import type { LexicalEditor } from 'lexical';
-import type { Doc } from 'yjs';
 import * as React from 'react';
 import { WebsocketProvider } from 'y-websocket';
+import { Doc } from 'yjs';
 import { InitialEditorStateType } from '../LexicalComposer';
 export declare type CursorsContainerRef = React.MutableRefObject<HTMLElement | null>;
 export declare function useYjsCollaboration(editor: LexicalEditor, id: string, provider: WebsocketProvider, docMap: Map<string, Doc>, name: string, color: string, shouldBootstrap: boolean, cursorsContainerRef?: CursorsContainerRef, initialEditorState?: InitialEditorStateType): [JSX.Element, Binding];

package/useLexicalEditable.dev.js

@@ -16,6 +16,7 @@ var react = require('react');
  * LICENSE file in the root directory of this source tree.
  *
  */
+
 const CAN_USE_DOM = typeof window !== 'undefined' && typeof window.document !== 'undefined' && typeof window.document.createElement !== 'undefined';
 
 /**
@@ -35,7 +36,6 @@ var useLayoutEffect = useLayoutEffectImpl;
  * LICENSE file in the root directory of this source tree.
  *
  */
-
 /**
  * Shortcut to Lexical subscriptions when values are used for render.
  */
@@ -50,12 +50,10 @@ function useLexicalSubscription(subscription) {
       subscribe
     } = initializedSubscription;
     const currentValue = initialValueFn();
-
     if (valueRef.current !== currentValue) {
       valueRef.current = currentValue;
       setValue(currentValue);
     }
-
     return subscribe(newValue => {
       valueRef.current = newValue;
       setValue(newValue);
@@ -71,7 +69,6 @@ function useLexicalSubscription(subscription) {
  * LICENSE file in the root directory of this source tree.
  *
  */
-
 function subscription(editor) {
   return {
     initialValueFn: () => editor.isEditable(),
@@ -80,7 +77,6 @@ function subscription(editor) {
     }
   };
 }
-
 function useLexicalEditable() {
   return useLexicalSubscription(subscription);
 }

package/useLexicalIsTextContentEmpty.dev.js

@@ -16,6 +16,7 @@ var react = require('react');
  * LICENSE file in the root directory of this source tree.
  *
  */
+
 const CAN_USE_DOM = typeof window !== 'undefined' && typeof window.document !== 'undefined' && typeof window.document.createElement !== 'undefined';
 
 /**

package/useLexicalNodeSelection.dev.js

@@ -17,19 +17,15 @@ var react = require('react');
  * LICENSE file in the root directory of this source tree.
  *
  */
-
 function isNodeSelected(editor, key) {
   return editor.getEditorState().read(() => {
     const node = lexical.$getNodeByKey(key);
-
     if (node === null) {
       return false;
     }
-
     return node.isSelected();
   });
 }
-
 function useLexicalNodeSelection(key) {
   const [editor] = LexicalComposerContext.useLexicalComposerContext();
   const [isSelected, setIsSelected] = react.useState(() => isNodeSelected(editor, key));
@@ -48,12 +44,10 @@ function useLexicalNodeSelection(key) {
   const setSelected = react.useCallback(selected => {
     editor.update(() => {
       let selection = lexical.$getSelection();
-
       if (!lexical.$isNodeSelection(selection)) {
         selection = lexical.$createNodeSelection();
         lexical.$setSelection(selection);
       }
-
       if (selected) {
         selection.add(key);
       } else {
@@ -64,7 +58,6 @@ function useLexicalNodeSelection(key) {
   const clearSelected = react.useCallback(() => {
     editor.update(() => {
       const selection = lexical.$getSelection();
-
       if (lexical.$isNodeSelection(selection)) {
         selection.clear();
       }

package/useLexicalSubscription.dev.js

@@ -16,6 +16,7 @@ var react = require('react');
  * LICENSE file in the root directory of this source tree.
  *
  */
+
 const CAN_USE_DOM = typeof window !== 'undefined' && typeof window.document !== 'undefined' && typeof window.document.createElement !== 'undefined';
 
 /**
@@ -35,7 +36,6 @@ var useLayoutEffect = useLayoutEffectImpl;
  * LICENSE file in the root directory of this source tree.
  *
  */
-
 /**
  * Shortcut to Lexical subscriptions when values are used for render.
  */
@@ -50,12 +50,10 @@ function useLexicalSubscription(subscription) {
       subscribe
     } = initializedSubscription;
     const currentValue = initialValueFn();
-
     if (valueRef.current !== currentValue) {
       valueRef.current = currentValue;
       setValue(currentValue);
     }
-
     return subscribe(newValue => {
       valueRef.current = newValue;
       setValue(newValue);