@lofcz/platejs-mention 52.0.15

package/LICENSE

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) Ziad Beyens, Dylan Schiemann, Joe Anderson, Felix Feng
+
+Unless otherwise specified in a LICENSE file within an individual package directory,
+this license applies to all files in this repository outside of those package directories.
+
+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/README.md

@@ -0,0 +1,12 @@
+# Plate mention plugin
+
+This package implements the mention plugin for Plate. It allows
+autocompletion from user input.
+
+## Documentation
+
+Check out [Mention](https://platejs.org/docs/mention).
+
+## License
+
+[MIT](../../LICENSE)

package/dist/BaseMentionPlugin-uPSCCRSr.js

@@ -0,0 +1,43 @@
+import { withTriggerCombobox } from "@platejs/combobox";
+import { KEYS, createSlatePlugin, createTSlatePlugin } from "platejs";
+
+//#region src/lib/BaseMentionPlugin.ts
+const BaseMentionInputPlugin = createSlatePlugin({
+	key: KEYS.mentionInput,
+	node: {
+		isElement: true,
+		isInline: true,
+		isVoid: true
+	}
+});
+/** Enables support for autocompleting @mentions. */
+const BaseMentionPlugin = createTSlatePlugin({
+	key: KEYS.mention,
+	node: {
+		isElement: true,
+		isInline: true,
+		isMarkableVoid: true,
+		isVoid: true
+	},
+	options: {
+		trigger: "@",
+		triggerPreviousCharPattern: /^\s?$/,
+		createComboboxInput: (trigger) => ({
+			children: [{ text: "" }],
+			trigger,
+			type: KEYS.mentionInput
+		})
+	},
+	plugins: [BaseMentionInputPlugin]
+}).extendEditorTransforms(({ editor, type }) => ({ insert: { mention: ({ key, value }) => {
+	editor.tf.insertNodes({
+		key,
+		children: [{ text: "" }],
+		type,
+		value
+	});
+} } })).overrideEditor(withTriggerCombobox);
+
+//#endregion
+export { BaseMentionPlugin as n, BaseMentionInputPlugin as t };
+//# sourceMappingURL=BaseMentionPlugin-uPSCCRSr.js.map

package/dist/BaseMentionPlugin-uPSCCRSr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMentionPlugin-uPSCCRSr.js","names":["TriggerComboboxPluginOptions","withTriggerCombobox","PluginConfig","TMentionElement","createSlatePlugin","createTSlatePlugin","KEYS","MentionConfig","insertSpaceAfterMention","insert","mention","options","search","value","key","BaseMentionInputPlugin","mentionInput","node","isElement","isInline","isVoid","BaseMentionPlugin","isMarkableVoid","trigger","triggerPreviousCharPattern","createComboboxInput","children","text","type","plugins","extendEditorTransforms","editor","tf","insertNodes","overrideEditor"],"sources":["../src/lib/BaseMentionPlugin.ts"],"sourcesContent":["import {\n  type TriggerComboboxPluginOptions,\n  withTriggerCombobox,\n} from '@platejs/combobox';\nimport {\n  type PluginConfig,\n  type TMentionElement,\n  createSlatePlugin,\n  createTSlatePlugin,\n  KEYS,\n} from 'platejs';\n\nexport type MentionConfig = PluginConfig<\n  'mention',\n  {\n    insertSpaceAfterMention?: boolean;\n  } & TriggerComboboxPluginOptions,\n  {},\n  {\n    insert: {\n      mention: (options: { search: string; value: any; key?: any }) => void;\n    };\n  }\n>;\n\nexport const BaseMentionInputPlugin = createSlatePlugin({\n  key: KEYS.mentionInput,\n  node: { isElement: true, isInline: true, isVoid: true },\n});\n\n/** Enables support for autocompleting @mentions. */\nexport const BaseMentionPlugin = createTSlatePlugin<MentionConfig>({\n  key: KEYS.mention,\n  node: { isElement: true, isInline: true, isMarkableVoid: true, isVoid: true },\n  options: {\n    trigger: '@',\n    triggerPreviousCharPattern: /^\\s?$/,\n    createComboboxInput: (trigger) => ({\n      children: [{ text: '' }],\n      trigger,\n      type: KEYS.mentionInput,\n    }),\n  },\n  plugins: [BaseMentionInputPlugin],\n})\n  .extendEditorTransforms<MentionConfig['transforms']>(({ editor, type }) => ({\n    insert: {\n      mention: ({ key, value }) => {\n        editor.tf.insertNodes<TMentionElement>({\n          key,\n          children: [{ text: '' }],\n          type,\n          value,\n        });\n      },\n    },\n  }))\n  .overrideEditor(withTriggerCombobox as any);\n"],"mappings":";;;;AAyBA,MAAae,yBAAyBX,kBAAkB;CACtDU,KAAKR,KAAKU;CACVC,MAAM;EAAEC,WAAW;EAAMC,UAAU;EAAMC,QAAQ;EAAK;CACvD,CAAC;;AAGF,MAAaC,oBAAoBhB,mBAAkC;CACjES,KAAKR,KAAKI;CACVO,MAAM;EAAEC,WAAW;EAAMC,UAAU;EAAMG,gBAAgB;EAAMF,QAAQ;EAAM;CAC7ET,SAAS;EACPY,SAAS;EACTC,4BAA4B;EAC5BC,sBAAsBF,aAAa;GACjCG,UAAU,CAAC,EAAEC,MAAM,IAAI,CAAC;GACxBJ;GACAK,MAAMtB,KAAKU;GACZ;EACF;CACDa,SAAS,CAACd,uBAAsB;CACjC,CAAC,CACCe,wBAAqD,EAAEC,QAAQH,YAAY,EAC1EnB,QAAQ,EACNC,UAAU,EAAEI,KAAKD,YAAY;AAC3BkB,QAAOC,GAAGC,YAA6B;EACrCnB;EACAY,UAAU,CAAC,EAAEC,MAAM,IAAI,CAAC;EACxBC;EACAf;EACD,CAAC;GAEN,EACD,EAAE,CACFqB,eAAejC,oBAA2B"}

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { TriggerComboboxPluginOptions } from "@platejs/combobox";
+import { PluginConfig, SlateEditor } from "platejs";
+
+//#region src/lib/BaseMentionPlugin.d.ts
+type MentionConfig = PluginConfig<'mention', {
+  insertSpaceAfterMention?: boolean;
+} & TriggerComboboxPluginOptions, {}, {
+  insert: {
+    mention: (options: {
+      search: string;
+      value: any;
+      key?: any;
+    }) => void;
+  };
+}>;
+declare const BaseMentionInputPlugin: any;
+/** Enables support for autocompleting @mentions. */
+declare const BaseMentionPlugin: any;
+//#endregion
+//#region src/lib/types.d.ts
+type TMentionItemBase = {
+  text: string;
+  key?: any;
+};
+//#endregion
+//#region src/lib/getMentionOnSelectItem.d.ts
+type MentionOnSelectItem<TItem extends TMentionItemBase = TMentionItemBase> = (editor: SlateEditor, item: TItem, search?: string) => void;
+declare const getMentionOnSelectItem: <TItem extends TMentionItemBase = TMentionItemBase>({
+  key
+}?: {
+  key?: string;
+}) => MentionOnSelectItem<TItem>;
+//#endregion
+export { BaseMentionInputPlugin, BaseMentionPlugin, MentionConfig, MentionOnSelectItem, TMentionItemBase, getMentionOnSelectItem };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib/BaseMentionPlugin.ts","../src/lib/types.ts","../src/lib/getMentionOnSelectItem.ts"],"sourcesContent":[],"mappings":";;;;KAYY,aAAA,GAAgB;;AAA5B,CAAA,GAIM,4BAAA,EAAA,CAAA,CAAA,EAAA;EASO,MAAA,EAAA;IAMA,OAAA,EAAA,CAAA,OA0BgC,EAAA;;;;ICzDjC,CAAA,EAAA,GAAA,IAAA;;;cDyBC;AEpBb;AACgB,cFyBH,iBEzBG,EAAA,GAAA;;;KDNJ,gBAAA;;;;;;KCKA,kCACI,mBAAmB,6BACtB,mBAAmB;cAEnB,uCACI,mBAAmB;;AFepC,CAAA;EAbY,GAAA,CAAA,EAAA,MAAA;AAaZ,CAAA,EAAA,GEXW,mBFWE,CEXkB,KFc7B,CAAA"}

package/dist/index.js

@@ -0,0 +1,20 @@
+import { n as BaseMentionPlugin, t as BaseMentionInputPlugin } from "./BaseMentionPlugin-uPSCCRSr.js";
+import { KEYS, getEditorPlugin } from "platejs";
+
+//#region src/lib/getMentionOnSelectItem.ts
+const getMentionOnSelectItem = ({ key = KEYS.mention } = {}) => (editor, item, search = "") => {
+	const { getOptions, tf } = getEditorPlugin(editor, { key });
+	const { insertSpaceAfterMention } = getOptions();
+	tf.insert.mention({
+		key: item.key,
+		search,
+		value: item.text
+	});
+	editor.tf.move({ unit: "offset" });
+	const pathAbove = editor.api.block()?.[1];
+	if (editor.selection && pathAbove && editor.api.isEnd(editor.selection.anchor, pathAbove) && insertSpaceAfterMention) editor.tf.insertText(" ");
+};
+
+//#endregion
+export { BaseMentionInputPlugin, BaseMentionPlugin, getMentionOnSelectItem };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["SlateEditor","getEditorPlugin","KEYS","MentionConfig","TMentionItemBase","MentionOnSelectItem","editor","item","TItem","search","getMentionOnSelectItem","key","mention","getOptions","tf","insertSpaceAfterMention","insert","value","text","move","unit","pathAbove","api","block","isBlockEnd","selection","isEnd","anchor","insertText"],"sources":["../src/lib/getMentionOnSelectItem.ts"],"sourcesContent":["import { type SlateEditor, getEditorPlugin, KEYS } from 'platejs';\n\nimport type { MentionConfig } from './BaseMentionPlugin';\nimport type { TMentionItemBase } from './types';\n\nexport type MentionOnSelectItem<\n  TItem extends TMentionItemBase = TMentionItemBase,\n> = (editor: SlateEditor, item: TItem, search?: string) => void;\n\nexport const getMentionOnSelectItem =\n  <TItem extends TMentionItemBase = TMentionItemBase>({\n    key = KEYS.mention,\n  }: {\n    key?: string;\n  } = {}): MentionOnSelectItem<TItem> =>\n  (editor, item, search = '') => {\n    const { getOptions, tf } = getEditorPlugin<MentionConfig>(editor, {\n      key: key as any,\n    });\n    const { insertSpaceAfterMention } = getOptions();\n\n    tf.insert.mention({ key: item.key, search, value: item.text });\n\n    // move the selection after the element\n    editor.tf.move({ unit: 'offset' });\n\n    const pathAbove = editor.api.block()?.[1];\n\n    const isBlockEnd =\n      editor.selection &&\n      pathAbove &&\n      editor.api.isEnd(editor.selection.anchor, pathAbove);\n\n    if (isBlockEnd && insertSpaceAfterMention) {\n      editor.tf.insertText(' ');\n    }\n  };\n"],"mappings":";;;;AASA,MAAaU,0BACyC,EAClDC,MAAMT,KAAKU,YAGT,EAAE,MACLN,QAAQC,MAAME,SAAS,OAAO;CAC7B,MAAM,EAAEI,YAAYC,OAAOb,gBAA+BK,QAAQ,EAC3DK,KACN,CAAC;CACF,MAAM,EAAEI,4BAA4BF,YAAY;AAEhDC,IAAGE,OAAOJ,QAAQ;EAAED,KAAKJ,KAAKI;EAAKF;EAAQQ,OAAOV,KAAKW;EAAM,CAAC;AAG9DZ,QAAOQ,GAAGK,KAAK,EAAEC,MAAM,UAAU,CAAC;CAElC,MAAMC,YAAYf,OAAOgB,IAAIC,OAAO,GAAG;AAOvC,KAJEjB,OAAOmB,aACPJ,aACAf,OAAOgB,IAAII,MAAMpB,OAAOmB,UAAUE,QAAQN,UAAU,IAEpCN,wBAChBT,QAAOQ,GAAGc,WAAW,IAAI"}

package/dist/react/index.d.ts

@@ -0,0 +1,6 @@
+//#region src/react/MentionPlugin.d.ts
+declare const MentionPlugin: any;
+declare const MentionInputPlugin: any;
+//#endregion
+export { MentionInputPlugin, MentionPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/react/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/react/MentionPlugin.tsx"],"sourcesContent":[],"mappings":";cAIa;AAAA,cAEA,kBAFgD,EAAA,GAAA"}

package/dist/react/index.js

@@ -0,0 +1,10 @@
+import { n as BaseMentionPlugin, t as BaseMentionInputPlugin } from "../BaseMentionPlugin-uPSCCRSr.js";
+import { toPlatePlugin } from "platejs/react";
+
+//#region src/react/MentionPlugin.tsx
+const MentionPlugin = toPlatePlugin(BaseMentionPlugin);
+const MentionInputPlugin = toPlatePlugin(BaseMentionInputPlugin);
+
+//#endregion
+export { MentionInputPlugin, MentionPlugin };
+//# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["toPlatePlugin","BaseMentionInputPlugin","BaseMentionPlugin","MentionPlugin","MentionInputPlugin"],"sources":["../../src/react/MentionPlugin.tsx"],"sourcesContent":["import { toPlatePlugin } from 'platejs/react';\n\nimport { BaseMentionInputPlugin, BaseMentionPlugin } from '../lib';\n\nexport const MentionPlugin = toPlatePlugin(BaseMentionPlugin);\n\nexport const MentionInputPlugin = toPlatePlugin(BaseMentionInputPlugin);\n"],"mappings":";;;;AAIA,MAAaG,gBAAgBH,cAAcE,kBAAkB;AAE7D,MAAaE,qBAAqBJ,cAAcC,uBAAuB"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@lofcz/platejs-mention",
+  "version": "52.0.15",
+  "description": "Mention plugin for Plate",
+  "keywords": [
+    "plate",
+    "plugin",
+    "slate"
+  ],
+  "homepage": "https://platejs.org",
+  "bugs": {
+    "url": "https://github.com/udecode/plate/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lofcz/plate.git",
+    "directory": "packages/mention"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.js",
+    "./react": "./dist/react/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "dependencies": {
+    "react-compiler-runtime": "^1.0.0",
+    "@platejs/combobox": "npm:@lofcz/platejs-combobox@52.0.15"
+  },
+  "devDependencies": {
+    "@plate/scripts": "1.0.0"
+  },
+  "peerDependencies": {
+    "platejs": ">=52.0.15",
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "module": "./dist/index.js",
+  "scripts": {
+    "brl": "plate-pkg p:brl",
+    "build": "plate-pkg p:build",
+    "build:watch": "plate-pkg p:build:watch",
+    "clean": "plate-pkg p:clean",
+    "lint": "plate-pkg p:lint",
+    "lint:fix": "plate-pkg p:lint:fix",
+    "test": "plate-pkg p:test",
+    "test:watch": "plate-pkg p:test:watch",
+    "typecheck": "plate-pkg p:typecheck"
+  }
+}