@umoteam/umo-editor-nuxt 0.0.1

package/README.md

@@ -0,0 +1,71 @@
+# Umo Editor Nuxt
+
+<p style="text-align: center; margin: 2rem 0;">
+<a href="https://umodoc.com" target="_blank"><img src="https://unpkg.com/@umoteam/editor-external@latest/static/logo.svg" alt="umodoc.com" width="280" /></a>
+</p>
+
+<p style="text-align: center;">
+<a href="https://github.com/umodoc/editor/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/npm/l/@umoteam/editor" /></a>
+<a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/v/@umoteam/editor" /></a>
+<a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/d18m/@umoteam/editor" /></a>
+<a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/unpacked-size/%40umoteam%2Feditor" /></a>
+<a href="https://github.com/umodoc/editor/commits" target="_blank"><img src="https://img.shields.io/github/commit-activity/m/umodoc/editor" /></a>
+</p>
+
+A powerful integration that brings the full capabilities of Umo Editor to your Nuxt3 applications.
+
+# 中文介绍
+
+Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
+
+Umo Editor 最大的特点是代码完全开源且自主可控，支持私有部署，您可以内网环境中使用，而无需担心数据安全问题。同时 Umo Editor 基于 Vue3 和 Tiptap，两者都有丰富的生态系统和社区支持，在遇到问题时可以迅速得到解决。
+
+## Introduction
+
+Umo Editor is an open-source document editor based on Vue3 and Tiptap. It provides powerful document editing capabilities and AI-assisted creation features. Umo Editor supports pagination, Markdown syntax, rich text editing, insertion of various node types, page style settings, document export, and printing. Additionally, it supports custom extensions, multi-language settings, and a dark theme.
+
+Umo Editor's largest feature is that its code is completely open source and controllable. It supports private deployment, allowing you to use it in an intranet environment without worrying about data security issues. At the same time, Umo Editor is based on Vue3 and Tiptap, both of which have rich ecosystems and communities, making it easy to solve problems when needed.
+![Umo Editor](https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-en@2x.png)
+
+As an independent Vue3 plugin, Umo Editor can be easily integrated into various Vue3 projects with zero configuration. For non-Vue3 projects, you can embed Umo Editor into your project via an iframe.
+
+[Documentation](https://editor.umodoc.com/en/docs) | [中文文档](https://editor.umodoc.com/cn/docs) | [Playground](https://demo.umodoc.com/editor?lang=en-US) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
+
+## Install
+
+```bash
+npx nuxi module add umo-editor-nuxt
+```
+
+## Usage
+
+1. Install and Configure the module
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['@umoteam/umo-editor-nuxt'],
+  umoEditor: {
+    // Global configuration, see default options at:
+    // https://editor.umodoc.com/en/docs/options/default
+    locale: 'en-US',
+  },
+})
+```
+
+2. Use the Umo Editor component in your pages
+```vue
+<template>
+  <div style="height: 600px;">
+    <UmoEditor />
+  </div>
+</template>
+
+<script setup>
+const options = $ref({
+    // Configuration options, see:
+    // https://editor.umodoc.com/en/docs/options/default
+})
+</script>
+```
+
+That's it! You can now use Umo Editor in your Nuxt app ✨

package/dist/module.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "umo-editor",
+  "configKey": "umoEditor",
+  "compatibility": {
+    "nuxt": "^3.0.0"
+  },
+  "version": "0.0.1",
+  "builder": {
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,50 @@
+import { defineNuxtModule, createResolver, addPluginTemplate } from '@nuxt/kit';
+import serialize from 'serialize-javascript';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "umo-editor",
+    configKey: "umoEditor",
+    compatibility: {
+      nuxt: "^3.0.0"
+    }
+  },
+  defaults: {},
+  setup(_options, _nuxt) {
+    const resolver = createResolver(import.meta.url);
+    const runtimeDir = resolver.resolve("./runtime");
+    const options = serialize(_options, {});
+    const alias = {
+      "dayjs": "dayjs",
+      "debug": "debug",
+      "@braintree/sanitize-url": "@braintree/sanitize-url",
+      "ndarray": "ndarray",
+      "highlight.js": "highlight.js",
+      "jsbarcode": "jsbarcode",
+      "file-saver": "file-saver",
+      "dom-to-image-more": "dom-to-image-more",
+      "nzh": "nzh",
+      "qrcode-svg": "qrcode-svg",
+      "@tiptap-extend/columns": "@tiptap-extend/columns",
+      "file64": "file64"
+    };
+    _nuxt.options.alias = {
+      ..._nuxt.options.alias,
+      ...alias
+    };
+    addPluginTemplate({
+      filename: "umo-editor.js",
+      getContents() {
+        return `import { defineNuxtPlugin } from '#imports';
+        import UmoEditor from '${runtimeDir}/components'
+
+        export default defineNuxtPlugin(({ vueApp }) => {
+          vueApp.config.globalProperties.$umoEditorOptions = ${options}
+          vueApp.component('UmoEditor', UmoEditor)
+        })`;
+      }
+    });
+  }
+});
+
+export { module as default };

package/dist/runtime/components/index.vue

@@ -0,0 +1,13 @@
+<script setup>
+import { useNuxtApp } from "#imports";
+import { UmoEditor } from "@umoteam/editor";
+defineOptions({ name: "UmoEditor" });
+const { vueApp } = useNuxtApp();
+const options = vueApp.config.globalProperties.$umoEditorOptions;
+</script>
+
+<template>
+  <client-only>
+    <umo-editor v-bind="options" />
+  </client-only>
+</template>

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

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@umoteam/umo-editor-nuxt",
+  "version": "0.0.1",
+  "author": {
+    "name": "umodoc",
+    "email": "contact@umodoc.com",
+    "url": "https://www.umodoc.com"
+  },
+  "description": "Quickly integrate Umo editor into your Nuxt3 applications",
+  "repository": "umodoc/umo-editor-nuxt",
+  "license": "MIT",
+  "type": "module",
+  "keywords": [
+    "umo editor",
+    "umodoc editor",
+    "document editor",
+    "docs editor",
+    "word editor",
+    "office edtior",
+    "web editor",
+    "richtext editor",
+    "wysiwyg editor",
+    "vue editor",
+    "vue3 editor",
+    "ai editor",
+    "editor",
+    "web office",
+    "online office",
+    "tiptap",
+    "nuxt module"
+  ],
+  "homepage": "https://editor.umodoc.com/en/docs",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "types": "./dist/types.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint ."
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.17.4",
+    "@umoteam/editor": "latest",
+    "serialize-javascript": "^6.0.2"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^2.4.1",
+    "@nuxt/eslint-config": "^1.4.1",
+    "@nuxt/module-builder": "^1.0.1",
+    "@nuxt/schema": "^3.17.4",
+    "@types/node": "latest",
+    "changelogen": "^0.6.1",
+    "eslint": "^9.27.0",
+    "nuxt": "^3.17.4",
+    "typescript": "~5.8.3",
+    "vitest": "^3.1.4",
+    "vue-tsc": "^2.2.10"
+  }
+}