zurfyx-lexical-react 0.39.1-nightly.20251225.0

package/flow/LexicalMarkdownShortcutPlugin.js.flow

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {Transformer} from '@lexical/markdown';
+
+declare export var DEFAULT_TRANSFORMERS: Array<Transformer>;
+
+declare export function MarkdownShortcutPlugin({
+  transformers?: Array<Transformer>,
+}): React.Node;

package/flow/LexicalNestedComposer.js.flow

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {
+  LexicalEditor,
+  EditorThemeClasses,
+  LexicalNode,
+  LexicalNodeReplacement,
+} from 'lexical';
+
+export type LexicalNestedComposerProps = {
+  children?: React.Node;
+  initialEditor: LexicalEditor;
+  initialTheme?: EditorThemeClasses;
+  initialNodes?: $ReadOnlyArray<Class<LexicalNode> | LexicalNodeReplacement>;
+  skipCollabChecks?: void | true;
+  skipEditableListener?: void | true;
+};
+
+declare export function LexicalNestedComposer(props: LexicalNestedComposerProps): React.Node;

package/flow/LexicalNodeContextMenuPlugin.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * LexicalNodeContextMenuPlugin
+ */

package/flow/LexicalNodeEventPlugin.js.flow

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalEditor, LexicalNode, NodeKey} from 'lexical';
+
+declare export function NodeEventPlugin({
+  nodeType: Class<LexicalNode>;
+  eventType: string;
+  eventListener: (
+    event: Event,
+    editor: LexicalEditor,
+    nodeKey: NodeKey,
+  ) => void;
+}): null;

package/flow/LexicalNodeMenuPlugin.js.flow

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalCommand, LexicalEditor, NodeKey, TextNode} from 'lexical';
+import * as React from 'react';
+
+export type MenuTextMatch = {
+  leadOffset: number,
+  matchingString: string,
+  replaceableString: string,
+};
+
+export type MenuResolution = {
+  match?: MenuTextMatch,
+  getRect: () => ClientRect,
+};
+
+declare export class MenuOption {
+  key: string;
+  ref: {current: HTMLElement | null};
+  constructor(key: string): void;
+  setRefElement(element: HTMLElement | null): void;
+}
+
+export type MenuRenderFn<TOption> = (
+  anchorElementRef: {current: HTMLElement | null},
+  itemProps: {
+    selectedIndex: number | null,
+    selectOptionAndCleanUp: (option: TOption) => void,
+    setHighlightedIndex: (index: number) => void,
+    options: Array<TOption>,
+  },
+  matchingString: string,
+) => React.Portal | React.MixedElement | null;
+
+export type TriggerFn = (
+  text: string,
+  editor: LexicalEditor,
+) => MenuTextMatch | null;
+
+type NodeMenuPluginProps<TOption> = {
+  onSelectOption: (
+    option: TOption,
+    textNodeContainingQuery: TextNode | null,
+    closeMenu: () => void,
+    matchingString: string,
+  ) => void,
+  options: Array<TOption>,
+  nodeKey: NodeKey | null,
+  onClose?: () => void,
+  onOpen?: (resolution: MenuResolution) => void,
+  menuRenderFn: MenuRenderFn<TOption>,
+  anchorClassName?: string,
+};
+
+declare export function LexicalNodeMenuPlugin<TOption>(
+  options: NodeMenuPluginProps<TOption>,
+): React.MixedElement | null;

package/flow/LexicalOnChangePlugin.js.flow

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {EditorState, LexicalEditor} from 'lexical';
+
+declare export function OnChangePlugin({
+  ignoreHistoryMergeTagChange?: boolean,
+  ignoreSelectionChange?: boolean,
+  onChange: (editorState: EditorState, editor: LexicalEditor, tags: Set<string>) => void,
+}): null;

package/flow/LexicalPlainTextPlugin.js.flow

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {EditorState, LexicalEditor} from 'lexical';
+
+import {typeof LexicalErrorBoundary} from '@lexical/react/LexicalErrorBoundary';
+
+import * as React from 'react';
+
+type InitialEditorStateType =
+  | null
+  | string
+  | EditorState
+  | ((editor: LexicalEditor) => void);
+
+declare export function PlainTextPlugin({
+  contentEditable: React.Node,
+  placeholder?:
+  | ((isEditable: boolean) => null | React.Node)
+  | null
+  | React.Node;
+  ErrorBoundary: LexicalErrorBoundary,
+}): React.Node;

package/flow/LexicalReactExtension.js.flow

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * LexicalReactExtension
+ */
+
+import type {LexicalExtension} from 'lexical';
+import type {LexicalComposerContextWithEditor} from '@lexical/react/LexicalComposerContext';
+
+export interface EditorChildrenComponentProps {
+  context: LexicalComposerContextWithEditor;
+  contentEditable: null | React.Node;
+  children?: React.Node;
+}
+
+export type EditorChildrenComponentType = (
+  props: EditorChildrenComponentProps,
+) => React.Node | null;
+
+export interface DecoratorComponentProps {
+  context: LexicalComposerContextWithEditor;
+}
+export type DecoratorComponentType =
+  | React.Node
+  | ((props: DecoratorComponentProps) => React.Node | null);
+
+export type EditorComponentProps = {
+  EditorChildrenComponent: EditorChildrenComponentType;
+  children?: React.Node;
+  contentEditable: React.Node | null;
+  ErrorBoundary: ErrorBoundaryType;
+};
+
+export type EditorComponentType = (
+  props: Partial<EditorComponentProps>,
+) => React.Node;
+
+export type ReactConfig = {
+  contentEditable: React.Node | null;
+  ErrorBoundary: ErrorBoundaryType;
+  EditorChildrenComponent: EditorChildrenComponentType;
+  decorators: $ReadOnlyArray<DecoratorComponentType>;
+};
+
+export type ReactOutputs = {
+  Component: EditorComponentType;
+  context: LexicalComposerContextWithEditor;
+};
+
+export type ErrorBoundaryProps = {
+  children: React.Node;
+  onError: (error: Error) => void;
+};
+
+export type ErrorBoundaryType = React.ComponentType<ErrorBoundaryProps>;
+
+declare export function DefaultEditorChildrenComponent(props: EditorChildrenComponentProps): React.Node;
+declare export var ReactExtension: LexicalExtension<ReactConfig, "@lexical/react/React", {
+    Component: (props: Partial<EditorComponentProps>) => React.Node;
+    context: LexicalComposerContextWithEditor;
+}, void>;

package/flow/LexicalReactPluginHostExtension.js.flow

@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * LexicalReactPluginHostExtension
+ */
+import type {
+  LexicalExtension,
+  AnyLexicalExtension,
+  LexicalEditor,
+  LexicalExtensionOutput,
+  LexicalCommand,
+  ExtensionConfigBase,
+} from 'lexical';
+import type {Signal} from '@lexical/extension';
+import type {DecoratorComponentProps} from '@lexical/react/ReactExtension';
+export type {DecoratorComponentProps};
+
+type Container = DocumentFragment | Element;
+// TODO: Not sure how to import RootType from react-dom/client
+type Root = mixed;
+
+export interface HostMountCommandArg {
+  root: Root;
+}
+
+export interface MountPluginCommandArg {
+  key: string;
+  element: React.Node | null;
+  domNode?: Container | null;
+}
+
+declare export function mountReactExtensionComponent<
+  Extension: AnyLexicalExtension,
+>(
+  editor: LexicalEditor,
+  opts: {
+    extension: Extension;
+    props: [LexicalExtensionOutput<Extension>] extends [
+      {
+        // $FlowFixMe[unclear-type]: defined by user
+        Component: infer OutputComponentType extends React.ComponentType<any>;
+      },
+    ]
+      ? React.PropsOf<OutputComponentType> | null
+      : empty;
+  } & Omit<MountPluginCommandArg, 'element'>,
+): void;
+
+declare export function mountReactPluginComponent<
+  P: {...} = {...},
+>(
+  editor: LexicalEditor,
+  opts: {
+    Component: React.ComponentType<P>;
+    props: (P & {key?: null | void | React.Key}) | null;
+  } & Omit<MountPluginCommandArg, 'element'>,
+): void;
+
+declare export function mountReactPluginElement(
+  editor: LexicalEditor,
+  opts: MountPluginCommandArg,
+): void;
+
+declare export function mountReactPluginHost(
+  editor: LexicalEditor,
+  container: Container,
+): void;
+
+declare export var REACT_PLUGIN_HOST_MOUNT_ROOT_COMMAND: LexicalCommand<HostMountCommandArg>;
+declare export var REACT_PLUGIN_HOST_MOUNT_PLUGIN_COMMAND: LexicalCommand<MountPluginCommandArg>;
+declare export var ReactPluginHostExtension: LexicalExtension<ExtensionConfigBase, "@lexical/react/ReactPluginHost", {
+    mountReactPlugin: (arg: MountPluginCommandArg) => void;
+    mountReactPluginHost: (container: Container) => boolean;
+    mountedPluginsStore: Signal<{
+        plugins: Map<string, MountPluginCommandArg>;
+    }>;
+}, void>;

package/flow/LexicalReactProviderExtension.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * LexicalReactProviderExtension
+ */

package/flow/LexicalRichTextPlugin.js.flow

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {EditorState, LexicalEditor} from 'lexical';
+
+import {typeof LexicalErrorBoundary} from '@lexical/react/LexicalErrorBoundary';
+
+import * as React from 'react';
+
+type InitialEditorStateType =
+  | null
+  | string
+  | EditorState
+  | ((editor: LexicalEditor) => void);
+
+declare export function RichTextPlugin({
+  contentEditable: React.Node,
+  placeholder?:
+  | ((isEditable: boolean) => null | React.Node)
+  | null
+  | React.Node;
+  ErrorBoundary: LexicalErrorBoundary,
+}): React.Node;

package/flow/LexicalSelectionAlwaysOnDisplay.js.flow

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * LexicalSelectionAlwaysOnDisplay
+ */
+declare export function SelectionAlwaysOnDisplay(): null;

package/flow/LexicalTabIndentationPlugin.js.flow

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalEditor} from 'lexical';
+
+declare export function registerTabIndentation(
+  editor: LexicalEditor,
+  maxIndent?: number,
+): () => void;
+
+type Props = $ReadOnly<{
+  maxIndent?: number,
+}>;
+
+declare export function TabIndentationPlugin(props: Props): null;

package/flow/LexicalTableOfContentsPlugin.js.flow

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {HeadingTagType} from '@lexical/rich-text';
+import type {LexicalEditor, NodeKey} from 'lexical';
+
+declare export function TableOfContentsPlugin({
+  children: (
+    tableOfContents: Array<[NodeKey, string, HeadingTagType]>,
+    editor: LexicalEditor,
+  ) => React.Node,
+}): React.Node;

package/flow/LexicalTablePlugin.js.flow

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+type Props = $ReadOnly<{
+  hasCellMerge?: boolean,
+  hasCellBackgroundColor?: boolean,
+  hasTabHandler?: boolean,
+}>;
+declare export function TablePlugin(props: Props): null;

package/flow/LexicalTreeView.js.flow

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {CustomPrintNodeFn} from '@lexical/devtools-core';
+import type {LexicalEditor} from 'lexical';
+
+declare export function TreeView(props: {
+  timeTravelPanelClassName: string,
+  timeTravelPanelSliderClassName: string,
+  timeTravelPanelButtonClassName: string,
+  timeTravelButtonClassName: string,
+  viewClassName: string,
+  editor: LexicalEditor,
+  customPrintNode?: CustomPrintNodeFn,
+}): React.Node;

package/flow/LexicalTreeViewExtension.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * LexicalTreeViewExtension
+ */

package/flow/LexicalTypeaheadMenuPlugin.js.flow

@@ -0,0 +1,83 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalCommand, LexicalEditor, NodeKey, TextNode} from 'lexical';
+import * as React from 'react';
+
+export type MenuTextMatch = {
+  leadOffset: number,
+  matchingString: string,
+  replaceableString: string,
+};
+
+export type MenuResolution = {
+  match?: MenuTextMatch,
+  getRect: () => ClientRect,
+};
+
+export const PUNCTUATION: string =
+  '\\.,\\+\\*\\?\\$\\@\\|#{}\\(\\)\\^\\-\\[\\]\\\\/!%\'"~=<>_:;';
+
+declare export class MenuOption {
+  key: string;
+  ref: {current: HTMLElement | null};
+  constructor(key: string): void;
+  setRefElement(element: HTMLElement | null): void;
+}
+
+declare export var SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND: LexicalCommand<{
+  index: number,
+  option: MenuOption,
+}>;
+
+export type MenuRenderFn<TOption> = (
+  anchorElementRef: {current: HTMLElement | null},
+  itemProps: {
+    selectedIndex: number | null,
+    selectOptionAndCleanUp: (option: TOption) => void,
+    setHighlightedIndex: (index: number) => void,
+    options: Array<TOption>,
+  },
+  matchingString: string,
+) => React.Portal | React.MixedElement | null;
+
+declare export function getScrollParent(
+  element: HTMLElement,
+  includeHidden: boolean,
+): HTMLElement | HTMLBodyElement;
+
+declare export function useBasicTypeaheadTriggerMatch(
+  trigger: string,
+  options: {minLength?: number, maxLength?: number},
+): TriggerFn;
+
+export type TypeaheadMenuPluginProps<TOption> = {
+  onQueryChange: (matchingString: string | null) => void,
+  onSelectOption: (
+    option: TOption,
+    textNodeContainingQuery: TextNode | null,
+    closeMenu: () => void,
+    matchingString: string,
+  ) => void,
+  options: Array<TOption>,
+  menuRenderFn: MenuRenderFn<TOption>,
+  triggerFn: TriggerFn,
+  onOpen?: (resolution: MenuResolution) => void,
+  onClose?: () => void,
+  anchorClassName?: string,
+};
+
+export type TriggerFn = (
+  text: string,
+  editor: LexicalEditor,
+) => MenuTextMatch | null;
+
+declare export function LexicalTypeaheadMenuPlugin<TOption>(
+  options: TypeaheadMenuPluginProps<TOption>,
+): React.MixedElement | null;

package/flow/useLexicalEditable.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalEditor} from 'lexical';
+
+declare export function useLexicalEditable(): boolean;

package/flow/useLexicalExtensionComponent.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+/**
+ * useLexicalExtensionComponent
+ */

package/flow/useLexicalIsTextContentEmpty.js.flow

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalEditor} from 'lexical';
+
+declare export function useLexicalIsTextContentEmpty(
+  editor: LexicalEditor,
+  trim?: boolean,
+): boolean;

package/flow/useLexicalNodeSelection.js.flow

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {NodeKey} from 'lexical';
+
+declare export function useLexicalNodeSelection(
+  key: NodeKey,
+): [boolean, (boolean) => void, () => void];

package/flow/useLexicalSubscription.js.flow

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {LexicalEditor} from 'lexical';
+
+export type LexicalSubscription<T> = {
+  initialValueFn: () => T,
+  subscribe: (callback: (value: T) => void) => () => void,
+};
+
+declare export function useLexicalSubscription<T>(
+  subscription: (editor: LexicalEditor) => LexicalSubscription<T>,
+): T;

package/flow/useLexicalTextEntity.js.flow

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {TextNode} from 'lexical';
+
+export type EntityMatch = {end: number, start: number};
+
+declare export function useLexicalTextEntity<N: TextNode>(
+  getMatch: (text: string) => null | EntityMatch,
+  targetNode: Class<N>,
+  createNode: (textNode: TextNode) => N,
+): void;