@kungal/editor-core 0.15.0 → 0.17.0

package/dist/preset/index.d.cts

@@ -187,12 +187,29 @@ declare const applyUploadConfig: (ctx: Ctx, uploadImage: UploadImage, options?:
  */
 declare const createUploadPlugin: (uploadImage: UploadImage, options?: UploadPluginOptions) => MilkdownPlugin[];
 
+type PlaceholderMode = 'doc' | 'block';
+interface PlaceholderConfig {
+    /** The placeholder text. Empty string disables the placeholder. */
+    text?: string;
+    /** `'block'` (default) shows on any empty block; `'doc'` only when empty. */
+    mode?: PlaceholderMode;
+}
+/**
+ * The placeholder plugin. `text` is baked in at creation (the editor is built
+ * once); pass it from `createKunEditorPlugins(..., { placeholder })`.
+ */
+declare const createPlaceholderPlugin: (config?: PlaceholderConfig) => MilkdownPlugin[];
+
 /** Extra, non-adapter options for the composed bundle. */
 interface KunEditorPluginOptions {
     /** UI language for plugin chrome (code-block toolbar labels). Default `'zh-cn'`. */
     locale?: KunEditorLocale;
     /** KaTeX options forwarded to the code-block `latex` preview. */
     katexOptions?: KatexOptions;
+    /** Placeholder text shown when empty. Omit / empty string → no placeholder. */
+    placeholder?: string;
+    /** `'block'` (default) shows on any empty block; `'doc'` only when empty. */
+    placeholderMode?: 'doc' | 'block';
 }
 /**
  * Assemble the KunEditor Milkdown plugin list.
@@ -209,4 +226,4 @@ interface KunEditorPluginOptions {
  */
 declare const createKunEditorPlugins: (adapters?: KunEditorAdapters, features?: KunEditorFeatures, options?: KunEditorPluginOptions) => MilkdownPlugin[];
 
-export { type CodeBlockOptions, type KunEditorPluginOptions, type MentionUrlConfig, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createHeadingPlugin, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, setHeadingCommand, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };
+export { type CodeBlockOptions, type KunEditorPluginOptions, type MentionUrlConfig, type PlaceholderConfig, type PlaceholderMode, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createHeadingPlugin, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createPlaceholderPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, setHeadingCommand, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };

package/dist/preset/index.d.ts

@@ -187,12 +187,29 @@ declare const applyUploadConfig: (ctx: Ctx, uploadImage: UploadImage, options?:
  */
 declare const createUploadPlugin: (uploadImage: UploadImage, options?: UploadPluginOptions) => MilkdownPlugin[];
 
+type PlaceholderMode = 'doc' | 'block';
+interface PlaceholderConfig {
+    /** The placeholder text. Empty string disables the placeholder. */
+    text?: string;
+    /** `'block'` (default) shows on any empty block; `'doc'` only when empty. */
+    mode?: PlaceholderMode;
+}
+/**
+ * The placeholder plugin. `text` is baked in at creation (the editor is built
+ * once); pass it from `createKunEditorPlugins(..., { placeholder })`.
+ */
+declare const createPlaceholderPlugin: (config?: PlaceholderConfig) => MilkdownPlugin[];
+
 /** Extra, non-adapter options for the composed bundle. */
 interface KunEditorPluginOptions {
     /** UI language for plugin chrome (code-block toolbar labels). Default `'zh-cn'`. */
     locale?: KunEditorLocale;
     /** KaTeX options forwarded to the code-block `latex` preview. */
     katexOptions?: KatexOptions;
+    /** Placeholder text shown when empty. Omit / empty string → no placeholder. */
+    placeholder?: string;
+    /** `'block'` (default) shows on any empty block; `'doc'` only when empty. */
+    placeholderMode?: 'doc' | 'block';
 }
 /**
  * Assemble the KunEditor Milkdown plugin list.
@@ -209,4 +226,4 @@ interface KunEditorPluginOptions {
  */
 declare const createKunEditorPlugins: (adapters?: KunEditorAdapters, features?: KunEditorFeatures, options?: KunEditorPluginOptions) => MilkdownPlugin[];
 
-export { type CodeBlockOptions, type KunEditorPluginOptions, type MentionUrlConfig, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createHeadingPlugin, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, setHeadingCommand, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };
+export { type CodeBlockOptions, type KunEditorPluginOptions, type MentionUrlConfig, type PlaceholderConfig, type PlaceholderMode, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createHeadingPlugin, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createPlaceholderPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, setHeadingCommand, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };

package/dist/preset/index.js

@@ -8,12 +8,12 @@ import { indent } from '@milkdown/kit/plugin/indent';
 import { trailing } from '@milkdown/kit/plugin/trailing';
 import { expectDomTypeError } from '@milkdown/kit/exception';
 import { InputRule, textblockTypeInputRule } from '@milkdown/kit/prose/inputrules';
-import { $nodeAttr, $nodeSchema, $command, $inputRule, $remark, $useKeymap } from '@milkdown/kit/utils';
+import { $nodeAttr, $nodeSchema, $command, $inputRule, $remark, $useKeymap, $prose } from '@milkdown/kit/utils';
 import { visit } from 'unist-util-visit';
-import { commandsCtx } from '@milkdown/kit/core';
+import { commandsCtx, editorViewOptionsCtx } from '@milkdown/kit/core';
 import { setBlockType } from '@milkdown/kit/prose/commands';
 import { findNodeInSelection, nodeRule } from '@milkdown/kit/prose';
-import { NodeSelection, TextSelection } from '@milkdown/kit/prose/state';
+import { NodeSelection, TextSelection, Plugin, PluginKey } from '@milkdown/kit/prose/state';
 import katex from 'katex';
 import remarkMath from 'remark-math';
 import { codeBlockComponent, codeBlockConfig } from '@milkdown/kit/component/code-block';
@@ -24,7 +24,7 @@ import { basicSetup } from 'codemirror';
 import { HighlightStyle, syntaxHighlighting } from '@codemirror/language';
 import { tags } from '@lezer/highlight';
 import { upload, uploadConfig } from '@milkdown/kit/plugin/upload';
-import { Decoration } from '@milkdown/kit/prose/view';
+import { Decoration, DecorationSet } from '@milkdown/kit/prose/view';
 
 var spoilerAttr = $nodeAttr("kun-spoiler", () => ({
   container: {
@@ -964,6 +964,62 @@ var uploadConfigPlugin = (uploadImage, options) => (ctx) => () => {
   applyUploadConfig(ctx, uploadImage, options);
 };
 var createUploadPlugin = (uploadImage, options = {}) => [...upload, uploadConfigPlugin(uploadImage, options)];
+var SKIP_PARENTS = /* @__PURE__ */ new Set([
+  "code_block",
+  "bullet_list",
+  "ordered_list",
+  "list_item",
+  "table"
+]);
+var isDocEmpty = (doc) => doc.childCount <= 1 && !doc.firstChild?.content.size;
+var isInSkippedParent = (state) => {
+  const { $anchor } = state.selection;
+  for (let depth = $anchor.depth; depth > 0; depth--) {
+    if (SKIP_PARENTS.has($anchor.node(depth).type.name)) {
+      return true;
+    }
+  }
+  return false;
+};
+var createPlaceholderPlugin = (config = {}) => {
+  const text = config.text ?? "";
+  const mode = config.mode ?? "block";
+  const plugin = $prose(
+    (ctx) => new Plugin({
+      key: new PluginKey("KUN_PLACEHOLDER"),
+      props: {
+        decorations: (state) => {
+          if (!text) {
+            return null;
+          }
+          const editable = ctx.get(editorViewOptionsCtx).editable;
+          if (editable && !editable(state)) {
+            return null;
+          }
+          if (mode === "doc" && !isDocEmpty(state.doc)) {
+            return null;
+          }
+          const { selection } = state;
+          if (!selection.empty || isInSkippedParent(state)) {
+            return null;
+          }
+          const node = selection.$anchor.parent;
+          if (node.content.size > 0) {
+            return null;
+          }
+          const before = selection.$anchor.before();
+          return DecorationSet.create(state.doc, [
+            Decoration.node(before, before + node.nodeSize, {
+              class: "kun-editor__placeholder",
+              "data-placeholder": text
+            })
+          ]);
+        }
+      }
+    })
+  );
+  return [plugin].flat();
+};
 
 // src/preset/index.ts
 var createKunEditorPlugins = (adapters = {}, features = {}, options = {}) => {
@@ -1018,9 +1074,17 @@ var createKunEditorPlugins = (adapters = {}, features = {}, options = {}) => {
   }
   plugins.push(createStopLinkPlugin());
   plugins.push(createHeadingPlugin());
+  if (options.placeholder) {
+    plugins.push(
+      createPlaceholderPlugin({
+        text: options.placeholder,
+        mode: options.placeholderMode
+      })
+    );
+  }
   return plugins.flat();
 };
 
-export { applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createHeadingPlugin, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, setHeadingCommand, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };
+export { applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createHeadingPlugin, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createPlaceholderPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, setHeadingCommand, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map