@ekz/lexical-overflow 0.40.0

package/EkzLexicalOverflow.dev.js

@@ -0,0 +1,71 @@
+/**
+ * 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.
+ *
+ */
+
+'use strict';
+
+var lexical = require('@ekz/lexical');
+
+/**
+ * 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.
+ *
+ */
+
+/** @noInheritDoc */
+class OverflowNode extends lexical.ElementNode {
+  /** @internal */
+  $config() {
+    return this.config('overflow', {
+      $transform(node) {
+        if (node.isEmpty()) {
+          node.remove();
+        }
+      },
+      extends: lexical.ElementNode
+    });
+  }
+  createDOM(config) {
+    const div = document.createElement('span');
+    const className = config.theme.characterLimit;
+    if (typeof className === 'string') {
+      div.className = className;
+    }
+    return div;
+  }
+  updateDOM(prevNode, dom) {
+    return false;
+  }
+  insertNewAfter(selection, restoreSelection = true) {
+    const parent = this.getParentOrThrow();
+    return parent.insertNewAfter(selection, restoreSelection);
+  }
+  excludeFromCopy() {
+    return true;
+  }
+}
+function $createOverflowNode() {
+  return lexical.$applyNodeReplacement(new OverflowNode());
+}
+function $isOverflowNode(node) {
+  return node instanceof OverflowNode;
+}
+
+/**
+ * Configures {@link OverflowNode}
+ */
+const OverflowExtension = lexical.defineExtension({
+  name: '@ekz/lexical-overflow',
+  nodes: () => [OverflowNode]
+});
+
+exports.$createOverflowNode = $createOverflowNode;
+exports.$isOverflowNode = $isOverflowNode;
+exports.OverflowExtension = OverflowExtension;
+exports.OverflowNode = OverflowNode;

package/EkzLexicalOverflow.dev.mjs

@@ -0,0 +1,66 @@
+/**
+ * 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.
+ *
+ */
+
+import { defineExtension, ElementNode, $applyNodeReplacement } from '@ekz/lexical';
+
+/**
+ * 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.
+ *
+ */
+
+/** @noInheritDoc */
+class OverflowNode extends ElementNode {
+  /** @internal */
+  $config() {
+    return this.config('overflow', {
+      $transform(node) {
+        if (node.isEmpty()) {
+          node.remove();
+        }
+      },
+      extends: ElementNode
+    });
+  }
+  createDOM(config) {
+    const div = document.createElement('span');
+    const className = config.theme.characterLimit;
+    if (typeof className === 'string') {
+      div.className = className;
+    }
+    return div;
+  }
+  updateDOM(prevNode, dom) {
+    return false;
+  }
+  insertNewAfter(selection, restoreSelection = true) {
+    const parent = this.getParentOrThrow();
+    return parent.insertNewAfter(selection, restoreSelection);
+  }
+  excludeFromCopy() {
+    return true;
+  }
+}
+function $createOverflowNode() {
+  return $applyNodeReplacement(new OverflowNode());
+}
+function $isOverflowNode(node) {
+  return node instanceof OverflowNode;
+}
+
+/**
+ * Configures {@link OverflowNode}
+ */
+const OverflowExtension = defineExtension({
+  name: '@ekz/lexical-overflow',
+  nodes: () => [OverflowNode]
+});
+
+export { $createOverflowNode, $isOverflowNode, OverflowExtension, OverflowNode };

package/EkzLexicalOverflow.js

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ */
+
+'use strict'
+const EkzLexicalOverflow = process.env.NODE_ENV !== 'production' ? require('./EkzLexicalOverflow.dev.js') : require('./EkzLexicalOverflow.prod.js');
+module.exports = EkzLexicalOverflow;

package/EkzLexicalOverflow.mjs

@@ -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.
+ *
+ */
+
+import * as modDev from './EkzLexicalOverflow.dev.mjs';
+import * as modProd from './EkzLexicalOverflow.prod.mjs';
+const mod = process.env.NODE_ENV !== 'production' ? modDev : modProd;
+export const $createOverflowNode = mod.$createOverflowNode;
+export const $isOverflowNode = mod.$isOverflowNode;
+export const OverflowExtension = mod.OverflowExtension;
+export const OverflowNode = mod.OverflowNode;

package/EkzLexicalOverflow.node.mjs

@@ -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.
+ *
+ */
+
+const mod = await (process.env.NODE_ENV !== 'production' ? import('./EkzLexicalOverflow.dev.mjs') : import('./EkzLexicalOverflow.prod.mjs'));
+export const $createOverflowNode = mod.$createOverflowNode;
+export const $isOverflowNode = mod.$isOverflowNode;
+export const OverflowExtension = mod.OverflowExtension;
+export const OverflowNode = mod.OverflowNode;

package/EkzLexicalOverflow.prod.js

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ *
+ */
+
+"use strict";var e=require("@ekz/lexical");class t extends e.ElementNode{$config(){return this.config("overflow",{$transform(e){e.isEmpty()&&e.remove()},extends:e.ElementNode})}createDOM(e){const t=document.createElement("span"),r=e.theme.characterLimit;return"string"==typeof r&&(t.className=r),t}updateDOM(e,t){return!1}insertNewAfter(e,t=!0){return this.getParentOrThrow().insertNewAfter(e,t)}excludeFromCopy(){return!0}}const r=e.defineExtension({name:"@ekz/lexical-overflow",nodes:()=>[t]});exports.$createOverflowNode=function(){return e.$applyNodeReplacement(new t)},exports.$isOverflowNode=function(e){return e instanceof t},exports.OverflowExtension=r,exports.OverflowNode=t;

package/EkzLexicalOverflow.prod.mjs

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ *
+ */
+
+import{defineExtension as e,ElementNode as t,$applyNodeReplacement as r}from"@ekz/lexical";class n extends t{$config(){return this.config("overflow",{$transform(e){e.isEmpty()&&e.remove()},extends:t})}createDOM(e){const t=document.createElement("span"),r=e.theme.characterLimit;return"string"==typeof r&&(t.className=r),t}updateDOM(e,t){return!1}insertNewAfter(e,t=!0){return this.getParentOrThrow().insertNewAfter(e,t)}excludeFromCopy(){return!0}}function o(){return r(new n)}function s(e){return e instanceof n}const c=e({name:"@ekz/lexical-overflow",nodes:()=>[n]});export{o as $createOverflowNode,s as $isOverflowNode,c as OverflowExtension,n as OverflowNode};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LexicalOverflow.js.flow

@@ -0,0 +1,35 @@
+/**
+ * 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 {
+  EditorConfig,
+  LexicalNode,
+  NodeKey,
+  RangeSelection,
+  SerializedElementNode,
+  LexicalExtension,
+  ExtensionConfigBase,
+} from '@ekz/lexical';
+import {ElementNode} from '@ekz/lexical';
+declare export class OverflowNode extends ElementNode {
+  static getType(): string;
+  static clone(node: OverflowNode): OverflowNode;
+  constructor(key?: NodeKey): void;
+  createDOM(config: EditorConfig): HTMLElement;
+  insertNewAfter(selection: RangeSelection): null | LexicalNode;
+  excludeFromCopy(): boolean;
+  static importJSON(serializedNode: SerializedOverflowNode): OverflowNode;
+}
+declare export function $createOverflowNode(): OverflowNode;
+declare export function $isOverflowNode(
+  node: ?LexicalNode,
+): node is OverflowNode;
+
+export type SerializedOverflowNode = SerializedElementNode;
+
+declare export var OverflowExtension: LexicalExtension<ExtensionConfigBase, "@ekz/lexical-overflow", void, void>;

package/README.md

@@ -0,0 +1,5 @@
+# `@lexical/overflow`
+
+[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_overflow)
+
+This package contains selection overflow helpers and nodes for Lexical.

package/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ *
+ */
+import type { EditorConfig, LexicalNode, RangeSelection, SerializedElementNode } from '@ekz/lexical';
+import { ElementNode } from '@ekz/lexical';
+export type SerializedOverflowNode = SerializedElementNode;
+/** @noInheritDoc */
+export declare class OverflowNode extends ElementNode {
+    /** @internal */
+    $config(): import("@ekz/lexical").StaticNodeConfigRecord<"overflow", {
+        $transform(node: OverflowNode): void;
+        extends: typeof ElementNode;
+    }>;
+    createDOM(config: EditorConfig): HTMLElement;
+    updateDOM(prevNode: this, dom: HTMLElement): boolean;
+    insertNewAfter(selection: RangeSelection, restoreSelection?: boolean): null | LexicalNode;
+    excludeFromCopy(): boolean;
+}
+export declare function $createOverflowNode(): OverflowNode;
+export declare function $isOverflowNode(node: LexicalNode | null | undefined): node is OverflowNode;
+/**
+ * Configures {@link OverflowNode}
+ */
+export declare const OverflowExtension: import("@ekz/lexical").LexicalExtension<import("@ekz/lexical").ExtensionConfigBase, "@ekz/lexical-overflow", unknown, unknown>;

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@ekz/lexical-overflow",
+  "description": "This package contains selection overflow helpers and nodes for Lexical.",
+  "keywords": [
+    "lexical",
+    "editor",
+    "rich-text",
+    "overflow"
+  ],
+  "license": "MIT",
+  "version": "0.40.0",
+  "main": "LexicalOverflow.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/facebook/lexical.git",
+    "directory": "packages/lexical-overflow"
+  },
+  "module": "LexicalOverflow.mjs",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "development": "./LexicalOverflow.dev.mjs",
+        "production": "./LexicalOverflow.prod.mjs",
+        "node": "./LexicalOverflow.node.mjs",
+        "default": "./LexicalOverflow.mjs"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "development": "./LexicalOverflow.dev.js",
+        "production": "./LexicalOverflow.prod.js",
+        "default": "./LexicalOverflow.js"
+      }
+    }
+  },
+  "dependencies": {
+    "@ekz/lexical": "0.40.0"
+  }
+}