@nuxt/ui 4.2.1 → 4.4.0

package/dist/runtime/components/Editor.vue

@@ -0,0 +1,199 @@
+<script>
+import theme from "#build/ui/editor";
+</script>
+
+<script setup>
+import { computed, provide, useAttrs, watch } from "vue";
+import { defu } from "defu";
+import { Primitive, useForwardProps } from "reka-ui";
+import { mergeAttributes } from "@tiptap/core";
+import Code from "@tiptap/extension-code";
+import HorizontalRule from "@tiptap/extension-horizontal-rule";
+import Image from "@tiptap/extension-image";
+import Mention from "@tiptap/extension-mention";
+import Placeholder from "@tiptap/extension-placeholder";
+import { Markdown } from "@tiptap/markdown";
+import StarterKit from "@tiptap/starter-kit";
+import { useEditor, EditorContent } from "@tiptap/vue-3";
+import { reactiveOmit } from "@vueuse/core";
+import { useAppConfig } from "#imports";
+import { createHandlers } from "../utils/editor";
+import { tv } from "../utils/tv";
+defineOptions({ inheritAttrs: false });
+const props = defineProps({
+  as: { type: null, required: false },
+  modelValue: { type: null, required: false },
+  contentType: { type: String, required: false },
+  starterKit: { type: Object, required: false },
+  placeholder: { type: [String, Object], required: false },
+  markdown: { type: Object, required: false },
+  image: { type: [Boolean, Object], required: false, default: true },
+  mention: { type: [Boolean, Object], required: false, default: true },
+  handlers: { type: null, required: false },
+  class: { type: null, required: false },
+  ui: { type: null, required: false },
+  extensions: { type: Array, required: false },
+  injectCSS: { type: Boolean, required: false },
+  injectNonce: { type: null, required: false },
+  autofocus: { type: [String, Number, Boolean, null], required: false },
+  editable: { type: Boolean, required: false },
+  textDirection: { type: String, required: false },
+  editorProps: { type: Object, required: false },
+  parseOptions: { type: Object, required: false },
+  coreExtensionOptions: { type: Object, required: false },
+  enableInputRules: { type: [Array, Boolean], required: false },
+  enablePasteRules: { type: [Array, Boolean], required: false },
+  enableCoreExtensions: { type: [Boolean, Object], required: false },
+  enableContentCheck: { type: Boolean, required: false },
+  emitContentError: { type: Boolean, required: false },
+  onBeforeCreate: { type: Function, required: false },
+  onCreate: { type: Function, required: false },
+  onMount: { type: Function, required: false },
+  onUnmount: { type: Function, required: false },
+  onContentError: { type: Function, required: false },
+  onUpdate: { type: Function, required: false },
+  onSelectionUpdate: { type: Function, required: false },
+  onTransaction: { type: Function, required: false },
+  onFocus: { type: Function, required: false },
+  onBlur: { type: Function, required: false },
+  onDestroy: { type: Function, required: false },
+  onPaste: { type: Function, required: false },
+  onDrop: { type: Function, required: false },
+  onDelete: { type: Function, required: false },
+  enableExtensionDispatchTransaction: { type: Boolean, required: false }
+});
+const emits = defineEmits(["update:modelValue"]);
+defineSlots();
+const attrs = useAttrs();
+const appConfig = useAppConfig();
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.editor || {} })({
+  placeholderMode: typeof props.placeholder === "object" ? props.placeholder.mode : void 0
+}));
+const rootProps = useForwardProps(reactiveOmit(props, "starterKit", "extensions", "editorProps", "contentType", "class", "placeholder", "markdown", "image", "mention", "handlers"));
+const editorProps = computed(() => defu(props.editorProps, {
+  attributes: {
+    autocomplete: "off",
+    autocorrect: "off",
+    autocapitalize: "off",
+    ...attrs,
+    class: ui.value.base({ class: props.ui?.base })
+  }
+}));
+const contentType = computed(() => props.contentType || (typeof props.modelValue === "string" ? "html" : "json"));
+const starterKit = computed(() => defu(props.starterKit, {
+  code: false,
+  horizontalRule: false,
+  dropcursor: {
+    color: "var(--ui-primary)",
+    width: 2
+  },
+  link: {
+    openOnClick: false
+  }
+}));
+const placeholder = computed(() => {
+  const options = typeof props.placeholder === "string" ? { placeholder: props.placeholder } : props.placeholder;
+  const { mode, ...rest } = options || {};
+  return defu(rest, {
+    showOnlyWhenEditable: false,
+    showOnlyCurrent: true
+  });
+});
+const markdown = computed(() => defu(props.markdown, {
+  markedOptions: {
+    gfm: true
+  }
+}));
+const image = computed(() => typeof props.image === "boolean" ? {} : props.image);
+const mention = computed(() => defu(typeof props.mention === "boolean" ? {} : props.mention, {
+  HTMLAttributes: {
+    class: "mention"
+  }
+}));
+const extensions = computed(() => [
+  contentType.value === "markdown" && Markdown.configure(markdown.value),
+  StarterKit.configure(starterKit.value),
+  Code.extend({
+    excludes: "code"
+  }),
+  HorizontalRule.extend({
+    renderHTML() {
+      return [
+        "div",
+        mergeAttributes(this.options.HTMLAttributes, { "data-type": this.name }),
+        ["hr"]
+      ];
+    }
+  }),
+  props.image !== false && Image.configure(image.value),
+  props.mention !== false && Mention.configure(mention.value),
+  props.placeholder && Placeholder.configure(placeholder.value),
+  ...props.extensions || []
+].filter((extension) => !!extension));
+const editor = useEditor({
+  ...rootProps.value,
+  content: props.modelValue,
+  contentType: contentType.value,
+  extensions: extensions.value,
+  editorProps: editorProps.value,
+  onCreate: ({ editor: editor2 }) => {
+    if (props.placeholder) {
+      editor2.view.dispatch(editor2.state.tr);
+    }
+  },
+  onUpdate: ({ editor: editor2 }) => {
+    let value;
+    try {
+      if (contentType.value === "html") {
+        value = editor2.getHTML();
+      } else if (contentType.value === "json") {
+        value = editor2.getJSON();
+      } else if (contentType.value === "markdown") {
+        value = editor2.getMarkdown();
+      }
+    } catch (error) {
+      value = editor2.getText();
+    }
+    emits("update:modelValue", value);
+  }
+});
+watch(() => props.modelValue, (newVal) => {
+  if (!editor.value || newVal == null) {
+    return;
+  }
+  const currentContent = contentType.value === "html" ? editor.value.getHTML() : contentType.value === "json" ? JSON.stringify(editor.value.getJSON()) : contentType.value === "markdown" ? editor.value.getMarkdown() : editor.value.getText();
+  const newContent = contentType.value === "json" && typeof newVal === "object" ? JSON.stringify(newVal) : String(newVal);
+  if (currentContent !== newContent) {
+    const currentSelection = editor.value.state.selection;
+    const currentPos = currentSelection.from;
+    editor.value.commands.setContent(newVal, { contentType: contentType.value });
+    const newDoc = editor.value.state.doc;
+    if (currentPos <= newDoc.content.size) {
+      editor.value.commands.setTextSelection(currentPos);
+    }
+  }
+});
+const handlers = computed(() => ({
+  ...createHandlers(),
+  ...props.handlers
+}));
+provide("editorHandlers", handlers);
+defineExpose({
+  editor
+});
+</script>
+
+<template>
+  <Primitive :as="as" data-slot="root" :class="ui.root({ class: [props.ui?.root, props.class] })">
+    <template v-if="editor">
+      <slot :editor="editor" :handlers="handlers" />
+
+      <EditorContent
+        role="presentation"
+        :editor="editor"
+        data-slot="content"
+        :class="ui.content({ class: props.ui?.content })"
+      />
+    </template>
+  </Primitive>
+</template>

package/dist/runtime/components/Editor.vue.d.ts

@@ -0,0 +1,101 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { Editor as TiptapEditor, EditorOptions, Content } from '@tiptap/vue-3';
+import type { StarterKitOptions } from '@tiptap/starter-kit';
+import type { PlaceholderOptions } from '@tiptap/extension-placeholder';
+import type { MarkdownExtensionOptions } from '@tiptap/markdown';
+import type { ImageOptions } from '@tiptap/extension-image';
+import type { MentionOptions } from '@tiptap/extension-mention';
+import theme from '#build/ui/editor';
+import type { EditorHandlers, EditorCustomHandlers } from '../types/editor';
+import type { ComponentConfig } from '../types/tv';
+type Editor = ComponentConfig<typeof theme, AppConfig, 'editor'>;
+export type EditorContentType = 'json' | 'html' | 'markdown';
+export interface EditorProps<T extends Content = Content, H extends EditorCustomHandlers = EditorCustomHandlers> extends Omit<Partial<EditorOptions>, 'content' | 'element'> {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'div'
+     */
+    as?: any;
+    modelValue?: T;
+    /**
+     * The content type the content is provided as.
+     * When not specified, it's automatically inferred: strings are treated as 'html', objects as 'json'.
+     */
+    contentType?: EditorContentType;
+    /**
+     * The starter kit options to configure the editor.
+     * @defaultValue { horizontalRule: false, link: { openOnClick: false }, dropcursor: { color: 'var(--ui-primary)', width: 2 } }
+     * @see https://tiptap.dev/docs/editor/extensions/functionality/starterkit
+     */
+    starterKit?: Partial<StarterKitOptions>;
+    /**
+     * The placeholder text to show in empty paragraphs. Can be a string or PlaceholderOptions from `@tiptap/extension-placeholder`.
+     * @defaultValue { showOnlyWhenEditable: false, showOnlyCurrent: true, mode: 'everyLine' }
+     * @see https://tiptap.dev/docs/editor/extensions/functionality/placeholder
+     */
+    placeholder?: string | (Partial<PlaceholderOptions> & {
+        /**
+         * Control how placeholders are displayed in the editor.
+         * - `firstLine`: Display placeholder only on the first line when the editor is empty.
+         * - `everyLine`: Display placeholder on every empty line when focused.
+         * @defaultValue 'everyLine'
+         */
+        mode?: 'firstLine' | 'everyLine';
+    });
+    /**
+     * The markdown extension options to configure markdown parsing and serialization.
+     * @defaultValue { markedOptions: { gfm: true } }
+     * @see https://tiptap.dev/docs/editor/extensions/functionality/markdown
+     */
+    markdown?: Partial<MarkdownExtensionOptions>;
+    /**
+     * The image extension options to configure image handling. Set to `false` to disable the extension.
+     * @defaultValue {}
+     * @see https://tiptap.dev/docs/editor/extensions/nodes/image
+     */
+    image?: boolean | Partial<ImageOptions>;
+    /**
+     * The mention extension options to configure mention handling. Set to `false` to disable the extension.
+     * @defaultValue { HTMLAttributes: { class: 'mention' } }
+     * @see https://tiptap.dev/docs/editor/extensions/nodes/mention
+     */
+    mention?: boolean | Partial<MentionOptions>;
+    /**
+     * Custom item handlers to override or extend the default handlers.
+     * These handlers are provided to all child components (toolbar, suggestion menu, etc.).
+     */
+    handlers?: H;
+    class?: any;
+    ui?: Editor['slots'];
+}
+export interface EditorEmits<T extends Content = Content> {
+    'update:modelValue': [value: T];
+}
+export interface EditorSlots<H extends EditorCustomHandlers = EditorCustomHandlers> {
+    default(props: {
+        editor: TiptapEditor;
+        handlers: EditorHandlers<H>;
+    }): any;
+}
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: <T extends Content, H extends EditorCustomHandlers>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: import("vue").PublicProps & __VLS_PrettifyLocal<EditorProps<T, H> & {
+        "onUpdate:modelValue"?: ((value: T) => any) | undefined;
+    }> & (typeof globalThis extends {
+        __VLS_PROPS_FALLBACK: infer P;
+    } ? P : {});
+    expose: (exposed: import("vue").ShallowUnwrapRef<{
+        editor: import("vue").ShallowRef<TiptapEditor | undefined, TiptapEditor | undefined>;
+    }>) => void;
+    attrs: any;
+    slots: EditorSlots<H>;
+    emit: (evt: "update:modelValue", value: T) => void;
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};

package/dist/runtime/components/EditorDragHandle.d.vue.ts

@@ -0,0 +1,68 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { Editor, JSONContent } from '@tiptap/vue-3';
+import type { DragHandleProps } from '@tiptap/extension-drag-handle-vue-3';
+import theme from '#build/ui/editor-drag-handle';
+import type { ButtonProps, IconProps, LinkPropsKeys } from '../types';
+import type { FloatingUIOptions } from '../types/editor';
+import type { ComponentConfig } from '../types/tv';
+type EditorDragHandle = ComponentConfig<typeof theme, AppConfig, 'editorDragHandle'>;
+export interface EditorDragHandleProps extends Omit<DragHandleProps, 'editor' | 'element' | 'onNodeChange' | 'computePositionConfig' | 'class'>, Omit<ButtonProps, LinkPropsKeys | 'icon' | 'color' | 'variant'> {
+    /**
+     * @defaultValue appConfig.ui.icons.drag
+     * @IconifyIcon
+     */
+    icon?: IconProps['name'];
+    /**
+     * @defaultValue 'neutral'
+     */
+    color?: ButtonProps['color'];
+    /**
+     * @defaultValue 'ghost'
+     */
+    variant?: ButtonProps['variant'];
+    /**
+     * The options for positioning the drag handle. Those are passed to Floating UI and include options for the placement, offset, flip, shift, size, autoPlacement, hide, and inline middleware.
+     * @defaultValue { strategy: 'absolute', placement: 'left-start' }
+     * @see https://floating-ui.com/docs/computePosition#options
+     */
+    options?: FloatingUIOptions;
+    editor: Editor;
+    ui?: EditorDragHandle['slots'] & ButtonProps['ui'];
+}
+export interface EditorDragHandleSlots {
+    default(props: {
+        ui: EditorDragHandle['ui'];
+        onClick: () => {
+            node: JSONContent;
+            pos: number;
+        } | undefined;
+    }): any;
+}
+export interface EditorDragHandleEmits {
+    nodeChange: [{
+        node: JSONContent;
+        pos: number;
+    }];
+}
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<EditorDragHandleProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    nodeChange: (args_0: {
+        node: JSONContent;
+        pos: number;
+    }) => any;
+}, string, import("vue").PublicProps, Readonly<EditorDragHandleProps> & Readonly<{
+    onNodeChange?: ((args_0: {
+        node: JSONContent;
+        pos: number;
+    }) => any) | undefined;
+}>, {
+    size: "md" | "xs" | "sm" | "lg" | "xl";
+    color: "error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral";
+    variant: "link" | "solid" | "outline" | "soft" | "subtle" | "ghost";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, EditorDragHandleSlots>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/EditorDragHandle.vue

@@ -0,0 +1,127 @@
+<script>
+import theme from "#build/ui/editor-drag-handle";
+</script>
+
+<script setup>
+import { computed, ref } from "vue";
+import DragHandle from "@tiptap/extension-drag-handle-vue-3";
+import { useForwardProps } from "reka-ui";
+import { reactiveOmit, reactivePick } from "@vueuse/core";
+import { defu } from "defu";
+import { useAppConfig } from "#imports";
+import { buildFloatingUIMiddleware } from "../utils/editor";
+import { transformUI } from "../utils";
+import { tv } from "../utils/tv";
+import UButton from "./Button.vue";
+defineOptions({ inheritAttrs: false });
+const props = defineProps({
+  icon: { type: null, required: false },
+  color: { type: null, required: false, default: "neutral" },
+  variant: { type: null, required: false, default: "ghost" },
+  options: { type: Object, required: false },
+  editor: { type: Object, required: true },
+  ui: { type: void 0, required: false },
+  pluginKey: { type: [Object, String], required: false },
+  onElementDragStart: { type: Function, required: false },
+  onElementDragEnd: { type: Function, required: false },
+  getReferencedVirtualElement: { type: Function, required: false },
+  label: { type: String, required: false },
+  activeColor: { type: null, required: false },
+  activeVariant: { type: null, required: false },
+  size: { type: null, required: false, default: "sm" },
+  square: { type: Boolean, required: false },
+  block: { type: Boolean, required: false },
+  loadingAuto: { type: Boolean, required: false },
+  onClick: { type: [Function, Array], required: false },
+  class: { type: null, required: false },
+  avatar: { type: Object, required: false },
+  leading: { type: Boolean, required: false },
+  leadingIcon: { type: null, required: false },
+  trailing: { type: Boolean, required: false },
+  trailingIcon: { type: null, required: false },
+  loading: { type: Boolean, required: false },
+  loadingIcon: { type: null, required: false },
+  as: { type: null, required: false },
+  type: { type: null, required: false },
+  disabled: { type: Boolean, required: false },
+  exactActiveClass: { type: String, required: false },
+  viewTransition: { type: Boolean, required: false }
+});
+defineSlots();
+const emit = defineEmits(["nodeChange"]);
+const dragHandleProps = useForwardProps(reactivePick(props, "pluginKey", "onElementDragEnd", "onElementDragStart", "getReferencedVirtualElement"));
+const buttonProps = useForwardProps(reactiveOmit(props, "icon", "options", "editor", "pluginKey", "onElementDragEnd", "onElementDragStart", "getReferencedVirtualElement", "class", "ui"));
+const appConfig = useAppConfig();
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.editorDragHandle || {} })());
+const floatingUIOptions = computed(() => defu(props.options, {
+  strategy: "absolute",
+  placement: "left-start",
+  offset: ({ rects }) => {
+    const blockHeight = rects.reference.height;
+    const handleHeight = rects.floating.height;
+    if (blockHeight > 40) {
+      return {
+        alignmentAxis: 0,
+        mainAxis: 8
+      };
+    }
+    return {
+      alignmentAxis: (blockHeight - handleHeight) / 2,
+      mainAxis: 8
+    };
+  },
+  flip: {},
+  shift: {},
+  size: false,
+  autoPlacement: false,
+  hide: false,
+  inline: false
+}));
+const middleware = computed(() => buildFloatingUIMiddleware(floatingUIOptions.value));
+const computePositionConfig = computed(() => ({
+  placement: floatingUIOptions.value.placement,
+  strategy: floatingUIOptions.value.strategy,
+  middleware: middleware.value
+}));
+const currentNodePos = ref();
+function onNodeChange({ pos }) {
+  currentNodePos.value = pos;
+}
+function onClick() {
+  if (!props.editor) return;
+  const pos = currentNodePos.value;
+  if (pos == null) return;
+  const node = props.editor.state.doc.nodeAt(pos);
+  if (node) {
+    const selectedNode = { node: node.toJSON(), pos };
+    emit("nodeChange", selectedNode);
+    props.editor.chain().setNodeSelection(pos).run();
+    return selectedNode;
+  }
+}
+</script>
+
+<template>
+  <DragHandle
+    v-bind="dragHandleProps"
+    :compute-position-config="computePositionConfig"
+    :editor="editor"
+    :on-node-change="onNodeChange"
+    data-slot="root"
+    :class="ui.root({ class: [props.ui?.root, props.class] })"
+    @click="onClick"
+  >
+    <slot :ui="ui" :on-click="onClick">
+      <UButton
+        v-bind="{
+  ...buttonProps,
+  icon: props.icon || appConfig.ui.icons.drag,
+  ...$attrs
+}"
+        data-slot="handle"
+        :class="ui.handle({ class: [props.ui?.handle, props.class] })"
+        :ui="transformUI(ui, props.ui)"
+      />
+    </slot>
+  </DragHandle>
+</template>

package/dist/runtime/components/EditorDragHandle.vue.d.ts

@@ -0,0 +1,68 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { Editor, JSONContent } from '@tiptap/vue-3';
+import type { DragHandleProps } from '@tiptap/extension-drag-handle-vue-3';
+import theme from '#build/ui/editor-drag-handle';
+import type { ButtonProps, IconProps, LinkPropsKeys } from '../types';
+import type { FloatingUIOptions } from '../types/editor';
+import type { ComponentConfig } from '../types/tv';
+type EditorDragHandle = ComponentConfig<typeof theme, AppConfig, 'editorDragHandle'>;
+export interface EditorDragHandleProps extends Omit<DragHandleProps, 'editor' | 'element' | 'onNodeChange' | 'computePositionConfig' | 'class'>, Omit<ButtonProps, LinkPropsKeys | 'icon' | 'color' | 'variant'> {
+    /**
+     * @defaultValue appConfig.ui.icons.drag
+     * @IconifyIcon
+     */
+    icon?: IconProps['name'];
+    /**
+     * @defaultValue 'neutral'
+     */
+    color?: ButtonProps['color'];
+    /**
+     * @defaultValue 'ghost'
+     */
+    variant?: ButtonProps['variant'];
+    /**
+     * The options for positioning the drag handle. Those are passed to Floating UI and include options for the placement, offset, flip, shift, size, autoPlacement, hide, and inline middleware.
+     * @defaultValue { strategy: 'absolute', placement: 'left-start' }
+     * @see https://floating-ui.com/docs/computePosition#options
+     */
+    options?: FloatingUIOptions;
+    editor: Editor;
+    ui?: EditorDragHandle['slots'] & ButtonProps['ui'];
+}
+export interface EditorDragHandleSlots {
+    default(props: {
+        ui: EditorDragHandle['ui'];
+        onClick: () => {
+            node: JSONContent;
+            pos: number;
+        } | undefined;
+    }): any;
+}
+export interface EditorDragHandleEmits {
+    nodeChange: [{
+        node: JSONContent;
+        pos: number;
+    }];
+}
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<EditorDragHandleProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    nodeChange: (args_0: {
+        node: JSONContent;
+        pos: number;
+    }) => any;
+}, string, import("vue").PublicProps, Readonly<EditorDragHandleProps> & Readonly<{
+    onNodeChange?: ((args_0: {
+        node: JSONContent;
+        pos: number;
+    }) => any) | undefined;
+}>, {
+    size: "md" | "xs" | "sm" | "lg" | "xl";
+    color: "error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral";
+    variant: "link" | "solid" | "outline" | "soft" | "subtle" | "ghost";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, EditorDragHandleSlots>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/EditorEmojiMenu.d.vue.ts

@@ -0,0 +1,41 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { EditorMenuOptions } from '../composables/useEditorMenu';
+import type { ComponentConfig } from '../types/tv';
+import theme from '#build/ui/editor-emoji-menu';
+type EditorEmojiMenu = ComponentConfig<typeof theme, AppConfig, 'editorEmojiMenu'>;
+export interface EditorEmojiMenuItem {
+    name: string;
+    emoji?: string;
+    shortcodes: string[];
+    tags: string[];
+    group?: string;
+    fallbackImage?: string;
+    [key: string]: any;
+}
+export interface EditorEmojiMenuProps<T extends EditorEmojiMenuItem = EditorEmojiMenuItem> extends Partial<Pick<EditorMenuOptions<T>, 'editor' | 'char' | 'pluginKey' | 'filterFields' | 'limit' | 'options' | 'appendTo'>> {
+    /**
+     * @defaultValue 'md'
+     */
+    size?: EditorEmojiMenu['variants']['size'];
+    items?: T[] | T[][];
+    class?: any;
+    ui?: EditorEmojiMenu['slots'];
+}
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: <T extends EditorEmojiMenuItem>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: import("vue").PublicProps & __VLS_PrettifyLocal<EditorEmojiMenuProps<T>> & (typeof globalThis extends {
+        __VLS_PROPS_FALLBACK: infer P;
+    } ? P : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {};
+    emit: {};
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};

package/dist/runtime/components/EditorEmojiMenu.vue

@@ -0,0 +1,73 @@
+<script>
+import theme from "#build/ui/editor-emoji-menu";
+</script>
+
+<script setup>
+import { computed, h, onMounted, onBeforeUnmount, nextTick, toRef } from "vue";
+import { useAppConfig } from "#imports";
+import { useEditorMenu } from "../composables/useEditorMenu";
+import { tv } from "../utils/tv";
+defineOptions({ inheritAttrs: false });
+const props = defineProps({
+  size: { type: null, required: false },
+  items: { type: Array, required: false },
+  class: { type: null, required: false },
+  ui: { type: null, required: false },
+  editor: { type: Object, required: false },
+  char: { type: String, required: false, default: ":" },
+  pluginKey: { type: String, required: false, default: "emojiMenu" },
+  filterFields: { type: Array, required: false, default: () => ["name", "shortcodes", "tags"] },
+  limit: { type: Number, required: false },
+  options: { type: Object, required: false },
+  appendTo: { type: Function, required: false, skipCheck: true }
+});
+const appConfig = useAppConfig();
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.editorEmojiMenu || {} })({
+  size: props.size
+}));
+let menu = null;
+onMounted(async () => {
+  await nextTick();
+  if (!props.editor || props.editor.isDestroyed) {
+    return;
+  }
+  menu = useEditorMenu({
+    editor: props.editor,
+    char: props.char,
+    pluginKey: props.pluginKey,
+    items: toRef(() => props.items),
+    filterFields: props.filterFields,
+    limit: props.limit,
+    options: props.options,
+    appendTo: props.appendTo,
+    ui,
+    onSelect: (editor, range, item) => {
+      if (!item.emoji) return;
+      editor.chain().focus().deleteRange(range).insertContent(item.emoji).run();
+    },
+    renderItem: (item, styles) => {
+      const content = item.emoji || item.shortcodes[0] || item.name;
+      return [
+        h("span", { class: styles.value.itemLeadingIcon() }, content),
+        h("span", { class: styles.value.itemWrapper() }, [
+          h("span", { class: styles.value.itemLabel() }, item.name)
+        ])
+      ];
+    }
+  });
+  props.editor.registerPlugin(menu.plugin);
+});
+onBeforeUnmount(() => {
+  if (menu) {
+    menu.destroy();
+    menu = null;
+  }
+  if (props.editor && !props.editor.isDestroyed) {
+    props.editor.unregisterPlugin(props.pluginKey);
+  }
+});
+</script>
+
+<template>
+  <div />
+</template>