@clevertask/scribe 0.1.2 → 0.1.3

package/dist/components/Scribe/extension/slashCommand/index.d.ts

@@ -1,5 +1,14 @@
 import { Extension } from "@tiptap/core";
 import { PluginKey } from "@tiptap/pm/state";
+import { SuggestionOptions } from "@tiptap/suggestion";
+import type { SlashCommandItemsProvider, SuggestionItem } from "./items";
 export declare const slashMenuPluginKey: PluginKey<any>;
-export declare const SlashCommand: Extension<any, any>;
+export type ScribeSlashCommandOptions = Omit<Partial<SuggestionOptions<SuggestionItem, SuggestionItem>>, "command" | "editor" | "items"> & {
+    items?: SlashCommandItemsProvider;
+};
+export type { SlashCommandContext, SlashCommandItemsProvider, SlashCommandItemsProviderProps, SuggestionItem, } from "./items";
+type SlashCommandOptions = {
+    slashSuggestion: Partial<SuggestionOptions<SuggestionItem, SuggestionItem>>;
+};
+export declare const SlashCommand: Extension<SlashCommandOptions, any>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/Scribe/extension/slashCommand/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../lib/components/Scribe/extension/slashCommand/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG7C,eAAO,MAAM,kBAAkB,gBAAmC,CAAC;AAEnE,eAAO,MAAM,YAAY,qBAyBvB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../lib/components/Scribe/extension/slashCommand/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAmB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzE,eAAO,MAAM,kBAAkB,gBAAmC,CAAC;AAEnE,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,OAAO,CAAC,iBAAiB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,EAC1D,SAAS,GAAG,QAAQ,GAAG,OAAO,CAC/B,GAAG;IACF,KAAK,CAAC,EAAE,yBAAyB,CAAC;CACnC,CAAC;AAEF,YAAY,EACV,mBAAmB,EACnB,yBAAyB,EACzB,8BAA8B,EAC9B,cAAc,GACf,MAAM,SAAS,CAAC;AAEjB,KAAK,mBAAmB,GAAG;IACzB,eAAe,EAAE,OAAO,CAAC,iBAAiB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;CAC7E,CAAC;AAEF,eAAO,MAAM,YAAY,qCAyBvB,CAAC"}

package/dist/components/Scribe/extension/slashCommand/items.d.ts

@@ -7,7 +7,26 @@ export declare enum SuggestionItemType {
 interface CommandProps {
     editor: Editor;
     range: Range;
+    props: SuggestionItem;
 }
+export interface SlashCommandContext {
+    isInsideListItem: boolean;
+    isInsideBulletList: boolean;
+    isInsideOrderedList: boolean;
+    isInsideTaskList: boolean;
+    listDepth: number;
+    parentListType: string | null;
+    parentNodeType: string;
+    selectionFrom: number;
+    selectionTo: number;
+}
+export interface SlashCommandItemsProviderProps {
+    query: string;
+    editor: Editor;
+    context: SlashCommandContext;
+    defaultItems: SuggestionItem[];
+}
+export type SlashCommandItemsProvider = (props: SlashCommandItemsProviderProps) => SuggestionItem[] | Promise<SuggestionItem[]>;
 export interface SuggestionItem {
     title: string;
     description: string;
@@ -16,6 +35,7 @@ export interface SuggestionItem {
     icon?: ReactNode;
     command: (props: CommandProps) => void;
 }
+export declare const getSlashCommandContext: (editor: Editor) => SlashCommandContext;
 export declare const getSuggestionItems: (props: {
     query: string;
     editor: Editor;

package/dist/components/Scribe/extension/slashCommand/items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../../../lib/components/Scribe/extension/slashCommand/items.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,oBAAY,kBAAkB;IAC5B,YAAY,UAAU;IACtB,eAAe,aAAa;CAC7B;AAED,UAAU,YAAY;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,kBAAkB,CAAC;IACzB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;CACxC;AAED,eAAO,MAAM,kBAAkB,GAAI,OAAO;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,qBAkM1E,CAAC"}
+{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../../../lib/components/Scribe/extension/slashCommand/items.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,oBAAY,kBAAkB;IAC5B,YAAY,UAAU;IACtB,eAAe,aAAa;CAC7B;AAED,UAAU,YAAY;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,8BAA8B;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,YAAY,EAAE,cAAc,EAAE,CAAC;CAChC;AAED,MAAM,MAAM,yBAAyB,GAAG,CACtC,KAAK,EAAE,8BAA8B,KAClC,cAAc,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;AAElD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,kBAAkB,CAAC;IACzB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;CACxC;AAED,eAAO,MAAM,sBAAsB,GAAI,QAAQ,MAAM,KAAG,mBA6BvD,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,OAAO;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,qBAkM1E,CAAC"}

package/dist/components/Scribe/extension/slashCommand/items.js

@@ -1,13 +1,31 @@
 import { jsx as t } from "react/jsx-runtime";
-var o = /* @__PURE__ */ ((c) => (c.BASIC_BLOCKS = "Basic", c.ADVANCED_BLOCKS = "Advanced", c))(o || {});
-const C = (c) => {
-  const { query: i } = c;
+var l = /* @__PURE__ */ ((i) => (i.BASIC_BLOCKS = "Basic", i.ADVANCED_BLOCKS = "Advanced", i))(l || {});
+const C = (i) => {
+  const { from: n, to: r } = i.state.selection, o = i.state.doc.resolve(n);
+  let s = 0, e = null;
+  for (let c = o.depth; c > 0; c -= 1) {
+    const a = o.node(c).type.name;
+    a === "listItem" && (s += 1), !e && ["bulletList", "orderedList", "taskList"].includes(a) && (e = a);
+  }
+  return {
+    isInsideListItem: s > 0,
+    isInsideBulletList: e === "bulletList",
+    isInsideOrderedList: e === "orderedList",
+    isInsideTaskList: e === "taskList",
+    listDepth: s,
+    parentListType: e,
+    parentNodeType: o.parent.type.name,
+    selectionFrom: n,
+    selectionTo: r
+  };
+}, L = (i) => {
+  const { query: n } = i;
   return [
     {
       title: "Text",
       description: "Start writing with plain text",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).toggleNode("paragraph", "paragraph").run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).toggleNode("paragraph", "paragraph").run(),
       searchTerms: ["p", "paragraph"],
       icon: /* @__PURE__ */ t("svg", { className: "slash-menu-icon", viewBox: "0 0 448 512", children: /* @__PURE__ */ t("path", { d: "M448 48v72a8 8 0 01-8 8h-16a8 8 0 01-8-8V64H240v384h72a8 8 0 018 8v16a8 8 0 01-8 8H136a8 8 0 01-8-8v-16a8 8 0 018-8h72V64H32v56a8 8 0 01-8 8H8a8 8 0 01-8-8V48a16 16 0 0116-16h416a16 16 0 0116 16z" }) })
     },
@@ -15,7 +33,7 @@ const C = (c) => {
       title: "H1",
       description: "Big heading",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).setNode("heading", { level: 1 }).run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).setNode("heading", { level: 1 }).run(),
       searchTerms: ["title", "big", "large"],
       icon: /* @__PURE__ */ t(
         "svg",
@@ -40,7 +58,7 @@ const C = (c) => {
       title: "H2",
       description: "Medium heading",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).setNode("heading", { level: 2 }).run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).setNode("heading", { level: 2 }).run(),
       searchTerms: ["subtitle", "medium"],
       icon: /* @__PURE__ */ t(
         "svg",
@@ -65,7 +83,7 @@ const C = (c) => {
       title: "H3",
       description: "Small heading",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).setNode("heading", { level: 3 }).run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).setNode("heading", { level: 3 }).run(),
       searchTerms: ["subtitle", "small"],
       icon: /* @__PURE__ */ t(
         "svg",
@@ -90,7 +108,7 @@ const C = (c) => {
       title: "Bullet List",
       description: "Create a simple bullet list",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).toggleBulletList().run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).toggleBulletList().run(),
       searchTerms: ["unordered", "point"],
       icon: /* @__PURE__ */ t("svg", { className: "slash-menu-icon", viewBox: "0 0 512 512", children: /* @__PURE__ */ t("path", { d: "M64 64c17.67 0 32 14.33 32 32 0 17.7-14.33 32-32 32s-32-14.3-32-32c0-17.67 14.33-32 32-32zm432 16c8.8 0 16 7.16 16 16 0 8.8-7.2 16-16 16H176c-8.8 0-16-7.2-16-16 0-8.84 7.2-16 16-16h320zm0 160c8.8 0 16 7.2 16 16s-7.2 16-16 16H176c-8.8 0-16-7.2-16-16s7.2-16 16-16h320zm0 160c8.8 0 16 7.2 16 16s-7.2 16-16 16H176c-8.8 0-16-7.2-16-16s7.2-16 16-16h320zM64 288c-17.67 0-32-14.3-32-32s14.33-32 32-32 32 14.3 32 32-14.33 32-32 32zm0 96c17.67 0 32 14.3 32 32s-14.33 32-32 32-32-14.3-32-32 14.33-32 32-32z" }) })
     },
@@ -98,7 +116,7 @@ const C = (c) => {
       title: "Numbered List",
       description: "Create a simple numbered list",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).toggleOrderedList().run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).toggleOrderedList().run(),
       searchTerms: ["ordered"],
       icon: /* @__PURE__ */ t("svg", { className: "slash-menu-icon", viewBox: "0 0 576 512", children: /* @__PURE__ */ t("path", { d: "M64 48.04c0-8.84 7.16-16 16-16h32c8.8 0 16 7.16 16 16V192h32c8.8 0 16 7.2 16 16 0 8.9-7.2 16-16 16H64c-8.84 0-16-7.1-16-16 0-8.8 7.16-16 16-16h32V64.04H80c-8.84 0-16-7.17-16-16zM224 96c0-8.84 7.2-16 16-16h288c8.8 0 16 7.16 16 16 0 8.8-7.2 16-16 16H240c-8.8 0-16-7.2-16-16zm0 160c0-8.8 7.2-16 16-16h288c8.8 0 16 7.2 16 16s-7.2 16-16 16H240c-8.8 0-16-7.2-16-16zm0 160c0-8.8 7.2-16 16-16h288c8.8 0 16 7.2 16 16s-7.2 16-16 16H240c-8.8 0-16-7.2-16-16zM75.31 339.3c-6.24 6.3-16.37 6.3-22.62 0-6.25-6.2-6.25-16.4 0-22.6l15.41-15.4c24.18-24.2 63.8-22.9 86.3 2.8 20 22 19.4 57.1-1.3 79.3L92.82 448H160c8.8 0 16 7.2 16 16s-7.2 16-16 16H56c-6.37 0-12.13-3.8-14.67-9.6-2.54-5.9-1.37-12.7 2.97-17.3l85.4-91.5c9.5-10.2 9.8-25.9.6-36.4-11.2-11.8-28.5-12.4-39.57-1.3l-15.42 15.4z" }) })
     },
@@ -106,7 +124,7 @@ const C = (c) => {
       title: "Divider",
       description: "Insert a dividing line",
       type: "Basic",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).setHorizontalRule().run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).setHorizontalRule().run(),
       searchTerms: ["separator"],
       icon: /* @__PURE__ */ t("svg", { className: "slash-menu-icon", viewBox: "0 0 24 24", children: /* @__PURE__ */ t("path", { d: "M21 12.75C21.4142 12.75 21.75 12.4142 21.75 12C21.75 11.5858 21.4142 11.25 21 11.25V12.75ZM3 11.25C2.58579 11.25 2.25 11.5858 2.25 12C2.25 12.4142 2.58579 12.75 3 12.75V11.25ZM7.54601 7.89101L7.8865 7.22275L7.54601 7.89101ZM7.10899 7.45399L7.77725 7.1135L7.10899 7.45399ZM16.891 7.45399L16.2228 7.1135L16.891 7.45399ZM16.454 7.89101L16.1135 7.22275L16.454 7.89101ZM16.454 4.10899L16.1135 4.77725L16.454 4.10899ZM16.891 4.54601L16.2228 4.8865L16.891 4.54601ZM7.54601 4.10899L7.8865 4.77725L7.54601 4.10899ZM7.10899 4.54601L7.77725 4.8865L7.10899 4.54601ZM7.54601 19.891L7.8865 19.2228L7.54601 19.891ZM7.10899 19.454L7.77725 19.1135L7.10899 19.454ZM16.891 19.454L16.2228 19.1135L16.891 19.454ZM16.454 19.891L16.1135 19.2228L16.454 19.891ZM16.454 16.109L16.1135 16.7772L16.454 16.109ZM16.891 16.546L16.2228 16.8865L16.891 16.546ZM7.54601 16.109L7.8865 16.7772L7.54601 16.109ZM7.10899 16.546L7.77725 16.8865L7.10899 16.546ZM21 11.25H3V12.75H21V11.25ZM8.6 4.75H15.4V3.25H8.6V4.75ZM16.25 5.6V6.4H17.75V5.6H16.25ZM15.4 7.25H8.6V8.75H15.4V7.25ZM7.75 6.4V5.6H6.25V6.4H7.75ZM8.6 7.25C8.3076 7.25 8.1334 7.24942 8.00428 7.23887C7.8839 7.22903 7.87011 7.2144 7.8865 7.22275L7.20552 8.55926C7.43582 8.67661 7.669 8.71647 7.88213 8.73388C8.08651 8.75058 8.33235 8.75 8.6 8.75V7.25ZM6.25 6.4C6.25 6.66765 6.24942 6.91349 6.26611 7.11787C6.28353 7.331 6.32339 7.56418 6.44074 7.79448L7.77725 7.1135C7.7856 7.12989 7.77097 7.1161 7.76113 6.99572C7.75058 6.8666 7.75 6.6924 7.75 6.4H6.25ZM7.8865 7.22275C7.83946 7.19878 7.80122 7.16054 7.77725 7.1135L6.44074 7.79448C6.60852 8.12377 6.87623 8.39148 7.20552 8.55926L7.8865 7.22275ZM16.25 6.4C16.25 6.6924 16.2494 6.8666 16.2389 6.99572C16.229 7.1161 16.2144 7.12989 16.2228 7.1135L17.5593 7.79448C17.6766 7.56418 17.7165 7.331 17.7339 7.11787C17.7506 6.91349 17.75 6.66765 17.75 6.4H16.25ZM15.4 8.75C15.6677 8.75 15.9135 8.75058 16.1179 8.73388C16.331 8.71647 16.5642 8.67661 16.7945 8.55926L16.1135 7.22275C16.1299 7.2144 16.1161 7.22903 15.9957 7.23887C15.8666 7.24942 15.6924 7.25 15.4 7.25V8.75ZM16.2228 7.1135C16.1988 7.16054 16.1605 7.19878 16.1135 7.22275L16.7945 8.55926C17.1238 8.39148 17.3915 8.12377 17.5593 7.79448L16.2228 7.1135ZM15.4 4.75C15.6924 4.75 15.8666 4.75058 15.9957 4.76113C16.1161 4.77097 16.1299 4.7856 16.1135 4.77725L16.7945 3.44074C16.5642 3.32339 16.331 3.28353 16.1179 3.26612C15.9135 3.24942 15.6677 3.25 15.4 3.25V4.75ZM17.75 5.6C17.75 5.33235 17.7506 5.08651 17.7339 4.88213C17.7165 4.669 17.6766 4.43582 17.5593 4.20552L16.2228 4.8865C16.2144 4.87011 16.229 4.8839 16.2389 5.00428C16.2494 5.1334 16.25 5.3076 16.25 5.6H17.75ZM16.1135 4.77725C16.1605 4.80122 16.1988 4.83946 16.2228 4.8865L17.5593 4.20552C17.3915 3.87623 17.1238 3.60852 16.7945 3.44074L16.1135 4.77725ZM8.6 3.25C8.33235 3.25 8.08651 3.24942 7.88213 3.26612C7.669 3.28353 7.43582 3.32339 7.20552 3.44074L7.8865 4.77725C7.87011 4.7856 7.8839 4.77097 8.00428 4.76113C8.1334 4.75058 8.3076 4.75 8.6 4.75V3.25ZM7.75 5.6C7.75 5.3076 7.75058 5.1334 7.76113 5.00428C7.77097 4.8839 7.7856 4.87011 7.77725 4.8865L6.44074 4.20552C6.32339 4.43582 6.28353 4.669 6.26611 4.88213C6.24942 5.08651 6.25 5.33235 6.25 5.6H7.75ZM7.20552 3.44074C6.87623 3.60852 6.60852 3.87623 6.44074 4.20552L7.77725 4.8865C7.80122 4.83946 7.83946 4.80122 7.8865 4.77725L7.20552 3.44074ZM8.6 16.75H15.4V15.25H8.6V16.75ZM16.25 17.6V18.4H17.75V17.6H16.25ZM15.4 19.25H8.6V20.75H15.4V19.25ZM7.75 18.4V17.6H6.25V18.4H7.75ZM8.6 19.25C8.3076 19.25 8.1334 19.2494 8.00428 19.2389C7.8839 19.229 7.87011 19.2144 7.8865 19.2228L7.20552 20.5593C7.43582 20.6766 7.669 20.7165 7.88213 20.7339C8.08651 20.7506 8.33235 20.75 8.6 20.75V19.25ZM6.25 18.4C6.25 18.6677 6.24942 18.9135 6.26611 19.1179C6.28353 19.331 6.32339 19.5642 6.44074 19.7945L7.77725 19.1135C7.7856 19.1299 7.77097 19.1161 7.76113 18.9957C7.75058 18.8666 7.75 18.6924 7.75 18.4H6.25ZM7.8865 19.2228C7.83946 19.1988 7.80122 19.1605 7.77725 19.1135L6.44074 19.7945C6.60852 20.1238 6.87623 20.3915 7.20552 20.5593L7.8865 19.2228ZM16.25 18.4C16.25 18.6924 16.2494 18.8666 16.2389 18.9957C16.229 19.1161 16.2144 19.1299 16.2228 19.1135L17.5593 19.7945C17.6766 19.5642 17.7165 19.331 17.7339 19.1179C17.7506 18.9135 17.75 18.6677 17.75 18.4H16.25ZM15.4 20.75C15.6677 20.75 15.9135 20.7506 16.1179 20.7339C16.331 20.7165 16.5642 20.6766 16.7945 20.5593L16.1135 19.2228C16.1299 19.2144 16.1161 19.229 15.9957 19.2389C15.8666 19.2494 15.6924 19.25 15.4 19.25V20.75ZM16.2228 19.1135C16.1988 19.1605 16.1605 19.1988 16.1135 19.2228L16.7945 20.5593C17.1238 20.3915 17.3915 20.1238 17.5593 19.7945L16.2228 19.1135ZM15.4 16.75C15.6924 16.75 15.8666 16.7506 15.9957 16.7611C16.1161 16.771 16.1299 16.7856 16.1135 16.7772L16.7945 15.4407C16.5642 15.3234 16.331 15.2835 16.1179 15.2661C15.9135 15.2494 15.6677 15.25 15.4 15.25V16.75ZM17.75 17.6C17.75 17.3323 17.7506 17.0865 17.7339 16.8821C17.7165 16.669 17.6766 16.4358 17.5593 16.2055L16.2228 16.8865C16.2144 16.8701 16.229 16.8839 16.2389 17.0043C16.2494 17.1334 16.25 17.3076 16.25 17.6H17.75ZM16.1135 16.7772C16.1605 16.8012 16.1988 16.8395 16.2228 16.8865L17.5593 16.2055C17.3915 15.8762 17.1238 15.6085 16.7945 15.4407L16.1135 16.7772ZM8.6 15.25C8.33235 15.25 8.08651 15.2494 7.88213 15.2661C7.66899 15.2835 7.43582 15.3234 7.20552 15.4407L7.8865 16.7772C7.87011 16.7856 7.8839 16.771 8.00428 16.7611C8.1334 16.7506 8.3076 16.75 8.6 16.75V15.25ZM7.75 17.6C7.75 17.3076 7.75058 17.1334 7.76113 17.0043C7.77097 16.8839 7.7856 16.8701 7.77725 16.8865L6.44074 16.2055C6.32339 16.4358 6.28353 16.669 6.26611 16.8821C6.24942 17.0865 6.25 17.3323 6.25 17.6H7.75ZM7.20552 15.4407C6.87623 15.6085 6.60852 15.8762 6.44074 16.2055L7.77725 16.8865C7.80122 16.8395 7.83946 16.8012 7.8865 16.7772L7.20552 15.4407Z" }) })
     },
@@ -115,7 +133,7 @@ const C = (c) => {
       title: "Code Block",
       description: "Add a block of code",
       type: "Advanced",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).toggleCodeBlock().run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).toggleCodeBlock().run(),
       searchTerms: ["codeblock"],
       icon: /* @__PURE__ */ t(
         "svg",
@@ -140,19 +158,20 @@ const C = (c) => {
       title: "Quote",
       description: "Add a quote",
       type: "Advanced",
-      command: ({ editor: e, range: s }) => e.chain().focus().deleteRange(s).toggleNode("paragraph", "paragraph").toggleBlockquote().run(),
+      command: ({ editor: s, range: e }) => s.chain().focus().deleteRange(e).toggleNode("paragraph", "paragraph").toggleBlockquote().run(),
       searchTerms: ["blockquote"],
       icon: /* @__PURE__ */ t("svg", { className: "slash-menu-icon", viewBox: "0 0 448 512", children: /* @__PURE__ */ t("path", { d: "M432 80c8.8 0 16 7.16 16 16 0 8.8-7.2 16-16 16H16c-8.836 0-16-7.2-16-16 0-8.84 7.164-16 16-16h416zm0 160c8.8 0 16 7.2 16 16s-7.2 16-16 16H144c-8.8 0-16-7.2-16-16s7.2-16 16-16h288zM128 416c0-8.8 7.2-16 16-16h288c8.8 0 16 7.2 16 16s-7.2 16-16 16H144c-8.8 0-16-7.2-16-16zM0 240c0-8.8 7.164-16 16-16 8.84 0 16 7.2 16 16v192c0 8.8-7.16 16-16 16-8.836 0-16-7.2-16-16V240z" }) })
     }
-  ].filter((e) => {
-    if (typeof i == "string" && i.length > 0) {
-      const s = i.toLowerCase();
-      return e.title.toLowerCase().includes(s) || e.description.toLowerCase().includes(s) || e.searchTerms?.some((n) => n.includes(s));
+  ].filter((s) => {
+    if (typeof n == "string" && n.length > 0) {
+      const e = n.toLowerCase();
+      return s.title.toLowerCase().includes(e) || s.description.toLowerCase().includes(e) || s.searchTerms?.some((c) => c.includes(e));
     }
     return !0;
   });
 };
 export {
-  o as SuggestionItemType,
-  C as getSuggestionItems
+  l as SuggestionItemType,
+  C as getSlashCommandContext,
+  L as getSuggestionItems
 };

package/dist/components/Scribe/index.d.ts

@@ -1,8 +1,11 @@
 import "katex/dist/katex.css";
 import { ClassValue } from "clsx";
+import type { ScribeSlashCommandOptions } from "./extension/slashCommand";
 import type { ScribeTableOfContentsChangeHandler, ScribeTableOfContentsScrollTarget } from "./extension/tableOfContents";
 import { Content, Editor, Extension, JSONContent, UseEditorOptions } from "@tiptap/react";
 import { KeyboardEventHandler } from "react";
+export type { ScribeSlashCommandOptions, SlashCommandContext, SlashCommandItemsProvider, SlashCommandItemsProviderProps, SuggestionItem, } from "./extension/slashCommand";
+export { SuggestionItemType } from "./extension/slashCommand/items";
 export type { ScribeTableOfContentsChangeHandler, ScribeTableOfContentsItem, ScribeTableOfContentsScrollTarget, } from "./extension/tableOfContents";
 export type ScribeOnChangeContents = {
     jsonContent: Content;
@@ -38,6 +41,11 @@ export interface ScribeProps {
     mainContainerClassName?: ClassValue;
     onKeyDown?: KeyboardEventHandler;
     mobile?: boolean;
+    /**
+     * Allows callers to customize Scribe's slash command menu while keeping
+     * Scribe's default command list available.
+     */
+    slashCommand?: ScribeSlashCommandOptions;
     /** @experimental Enables Scribe's app-owned table-of-contents API. */
     enableTableOfContents?: boolean;
     /** @experimental Receives the current table-of-contents items when they change. */

package/dist/components/Scribe/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/components/Scribe/index.tsx"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAQ,MAAM,MAAM,CAAC;AAIxC,OAAO,KAAK,EACV,kCAAkC,EAElC,iCAAiC,EAClC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,OAAO,EACP,MAAM,EAGN,SAAS,EACT,WAAW,EACX,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAEL,oBAAoB,EAMrB,MAAM,OAAO,CAAC;AAGf,YAAY,EACV,kCAAkC,EAClC,yBAAyB,EACzB,iCAAiC,GAClC,MAAM,6BAA6B,CAAC;AAErC,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC;CACjC,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,UAAU,EAAE,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,KAAK,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAC5F,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,2FAA2F;IAC3F,2BAA2B,EAAE,CAAC,MAAM,EAAE,iCAAiC,KAAK,IAAI,CAAC;IACjF,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACzC,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,kBAAkB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACzC,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,SAAS,CAAC,EAAE,oBAAoB,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sEAAsE;IACtE,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,mFAAmF;IACnF,uBAAuB,CAAC,EAAE,kCAAkC,CAAC;CAC9D;AAED,eAAO,MAAM,MAAM,mGAyMjB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/components/Scribe/index.tsx"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAQ,MAAM,MAAM,CAAC;AAGxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAE1E,OAAO,KAAK,EACV,kCAAkC,EAElC,iCAAiC,EAClC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,OAAO,EACP,MAAM,EAGN,SAAS,EACT,WAAW,EACX,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAEL,oBAAoB,EAMrB,MAAM,OAAO,CAAC;AAGf,YAAY,EACV,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,EACzB,8BAA8B,EAC9B,cAAc,GACf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,YAAY,EACV,kCAAkC,EAClC,yBAAyB,EACzB,iCAAiC,GAClC,MAAM,6BAA6B,CAAC;AAErC,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC;CACjC,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,UAAU,EAAE,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,KAAK,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAC5F,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,2FAA2F;IAC3F,2BAA2B,EAAE,CAAC,MAAM,EAAE,iCAAiC,KAAK,IAAI,CAAC;IACjF,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACzC,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,kBAAkB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACzC,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,SAAS,CAAC,EAAE,oBAAoB,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC,sEAAsE;IACtE,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,mFAAmF;IACnF,uBAAuB,CAAC,EAAE,kCAAkC,CAAC;CAC9D;AAED,eAAO,MAAM,MAAM,mGAyMjB,CAAC"}

package/dist/components/Scribe/index.js

@@ -1,6 +1,6 @@
-import { jsxs as x, jsx as a } from "react/jsx-runtime";
+import { jsxs as I, jsx as a } from "react/jsx-runtime";
 import { B as A, c as b } from "../../BarMenu-DaKIz3zZ.js";
-import { html2md as I } from "../../utils/html-to-markdown.js";
+import { html2md as N } from "../../utils/html-to-markdown.js";
 import "../../markdown-to-html-pL7ckd-m.js";
 import "../../purify.es-exIQuqhb.js";
 import { E as F } from "../../index-BiBV5TQx.js";
@@ -9,6 +9,7 @@ import { SCRIBE_TABLE_OF_CONTENTS_META as U } from "./extension/tableOfContents.
 import { E as V } from "../../index-DxF-1P4n.js";
 import { forwardRef as K, useRef as E, useEffect as c, useCallback as r, useState as q, useImperativeHandle as G } from "react";
 import { ListOptionBar as Q } from "../Menu/Mobile/ListOptionBar.js";
+import { SuggestionItemType as mt } from "./extension/slashCommand/items.js";
 import '../../assets/index.css';const it = K((h, B) => {
   const {
     autoFocus: g = !1,
@@ -26,25 +27,25 @@ import '../../assets/index.css';const it = K((h, B) => {
     externalEditor: T,
     mobile: D,
     onTableOfContentsChange: f
-  } = h, O = E(!T && i !== void 0), y = E([]), M = E(f);
+  } = h, y = E(!T && i !== void 0), O = E([]), M = E(f);
   c(() => {
     M.current = f;
   }, [f]);
   const z = r(
     (e, s) => {
-      y.current = e, M.current?.(e, s);
+      O.current = e, M.current?.(e, s);
     },
     []
-  ), u = r(
+  ), p = r(
     ({ editor: e, transaction: s }) => {
       if (s.getMeta(U))
         return;
-      const n = e.getHTML(), m = e.getJSON(), p = !o;
+      const n = e.getHTML(), m = e.getJSON(), u = !o;
       l && l({
         jsonContent: e.isEmpty ? "" : m,
         htmlContent: e.isEmpty ? "" : n,
-        markdownContent: e.isEmpty ? "" : I(n),
-        source: p ? "programmatic" : "user"
+        markdownContent: e.isEmpty ? "" : N(n),
+        source: u ? "programmatic" : "user"
       });
     },
     [o, l]
@@ -65,29 +66,29 @@ import '../../assets/index.css';const it = K((h, B) => {
       },
       ...d?.editorProps
     }
-  })), v = r(() => {
+  })), S = r(() => {
     t.commands.setContent("");
-  }, [t]), w = r(
+  }, [t]), v = r(
     (e) => {
       const s = {
         html: () => t.getHTML(),
         json: () => t.getJSON(),
-        markdown: () => I(t.getHTML())
+        markdown: () => N(t.getHTML())
       };
       return t.isEmpty ? "" : s[e]?.();
     },
     [t]
-  ), N = r(
+  ), w = r(
     (e) => {
       t.commands.setContent(e);
     },
     [t]
-  ), S = r(
+  ), x = r(
     (e) => {
-      const s = typeof e == "string" ? e : e.id, n = y.current.find((C) => C.id === s) ?? (typeof e == "string" ? void 0 : e);
+      const s = typeof e == "string" ? e : e.id, n = O.current.find((C) => C.id === s) ?? (typeof e == "string" ? void 0 : e);
       if (!n || t.isDestroyed)
         return;
-      const m = t.view.nodeDOM(n.pos), p = m instanceof HTMLElement ? m : n.dom;
+      const m = t.view.nodeDOM(n.pos), u = m instanceof HTMLElement ? m : n.dom;
       if (t.isEditable) {
         const C = Math.max(
           0,
@@ -95,38 +96,38 @@ import '../../assets/index.css';const it = K((h, B) => {
         );
         t.commands.focus(C, { scrollIntoView: !1 });
       }
-      p.scrollIntoView({ behavior: "smooth", block: "start" });
+      u.scrollIntoView({ behavior: "smooth", block: "start" });
     },
     [t]
   );
   return G(B, () => ({
-    resetContent: v,
-    setContent: N,
-    getContent: w,
-    scrollToTableOfContentsItem: S,
+    resetContent: S,
+    setContent: w,
+    getContent: v,
+    scrollToTableOfContentsItem: x,
     editor: t
-  }), [t, w, v, S, N]), c(() => {
+  }), [t, v, S, x, w]), c(() => {
     if (i !== void 0) {
-      if (O.current) {
-        O.current = !1;
+      if (y.current) {
+        y.current = !1;
         return;
       }
       t.commands.setContent(i, { emitUpdate: !1 });
     }
   }, [i, t]), c(() => {
     t.setEditable(!!o);
-  }, [o, t]), c(() => (t.off("update"), t.on("update", u), () => {
-    t.off("update", u);
-  }), [t, u]), c(() => {
+  }, [o, t]), c(() => (t.off("update"), t.on("update", p), () => {
+    t.off("update", p);
+  }), [t, p]), c(() => {
     g && t.commands.focus("end");
-  }, [g, t]), /* @__PURE__ */ x(
+  }, [g, t]), /* @__PURE__ */ I(
     "div",
     {
       className: b("scribe-wrapper", "scribe-root", k),
       "data-scribe-root": !0,
       style: P,
       children: [
-        /* @__PURE__ */ x("div", { className: b("scribe-frame", o && "scribe-frame--editable"), children: [
+        /* @__PURE__ */ I("div", { className: b("scribe-frame", o && "scribe-frame--editable"), children: [
           t && R ? /* @__PURE__ */ a(A, { editor: t }) : null,
           /* @__PURE__ */ a(
             "div",
@@ -148,5 +149,6 @@ import '../../assets/index.css';const it = K((h, B) => {
   );
 });
 export {
-  it as Scribe
+  it as Scribe,
+  mt as SuggestionItemType
 };

package/dist/main.js

@@ -1,14 +1,16 @@
 import { Scribe as o } from "./components/Scribe/index.js";
 import { html2md as m } from "./utils/html-to-markdown.js";
-import { m as p } from "./markdown-to-html-pL7ckd-m.js";
+import { m as i } from "./markdown-to-html-pL7ckd-m.js";
 import { isInViewport as x } from "./utils/is-in-viewport.js";
 import { convertLegacyMathDelimiters as a } from "./utils/convert-legacy-math-delimiters.js";
-import { createScribeEditor as h } from "./utils/create-scribe-editor.js";
+import { createScribeEditor as d } from "./utils/create-scribe-editor.js";
+import { SuggestionItemType as h } from "./components/Scribe/extension/slashCommand/items.js";
 export {
   o as Scribe,
+  h as SuggestionItemType,
   a as convertLegacyMathDelimiters,
-  h as createScribeEditor,
+  d as createScribeEditor,
   m as html2md,
   x as isInViewport,
-  p as md2html
+  i as md2html
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clevertask/scribe",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "private": false,
   "description": "A Radix-based Tiptap rich text editor with a Notion-style block interface for viewing and creating content. Perfect for diverse needs like notes, documents, AI chat, Markdown parsing, and comments.",
   "keywords": [