Skip to content

feat: add umo editor to modules#1392

Open
umodoc wants to merge 2 commits intonuxt:mainfrom
umodoc:feat/umo-editor-nuxt
Open

feat: add umo editor to modules#1392
umodoc wants to merge 2 commits intonuxt:mainfrom
umodoc:feat/umo-editor-nuxt

Conversation

@umodoc
Copy link

@umodoc umodoc commented Feb 7, 2026

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR introduces an official Nuxt module for UMO Editor, making it easy to integrate UMO Editor into Nuxt applications in a clean and idiomatic way.

The module is designed to follow Nuxt module conventions and provide a smooth developer experience for both client-side and SSR environments.

Key features include:

  • Provides an easy-to-use Nuxt module wrapper for UMO Editor, with automatic component registration
  • Supports automatic style imports
  • Offers SSR-friendly integration with full support for Nuxt 4
  • Allows plugin options to be customized via the Nuxt configuration
  • Automatically handles static assets and dependencies

🎯 Motivation

Umo Editor is an open-source document editor based on Vue3 and Tiptap, providing an online editing experience similar to Microsoft Word.

This module removes that friction by providing a first-class Nuxt integration, enabling developers to start using UMO Editor with minimal configuration and predictable behavior.

🧩 Usage Example

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['umo-editor-nuxt'],
  umoEditor: {
    theme: 'light',
    // other options
    // see: https://dev.umodoc.com/en/docs/editor/options/default
  }
})

@coderabbitai
Copy link

coderabbitai bot commented Feb 7, 2026

📝 Walkthrough

Walkthrough

A new manifest file modules/umo-editor.yml is added to describe the Umo editor module for Nuxt4 integration. The manifest contains metadata (name, description, repository, npm package, icon, links), a single maintainer entry, compatibility set to Nuxt ^4.0.0 with an empty requires field, and marks the module as a third-party library. No code logic, control flow, or exported/public API changes are introduced.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: add umo editor to modules' directly and clearly summarizes the main change—adding a new Nuxt module manifest for UMO Editor.
Description check ✅ Passed The description provides detailed context about the new UMO Editor Nuxt module, its features, motivation, and usage example, all of which align with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@modules/umo-editor.yml`:
- Around line 6-9: There are two identical YAML keys named "website" which
causes the second to override the first and breaks linting; remove the duplicate
by keeping a single "website" entry (preferably the official
https://www.umodoc.com) and either delete the other URL or move it to a
different, appropriate key (e.g., keep "github:
https://github.com/umodoc/editor-nuxt" as-is and remove the extra "website:
https://github.com/umodoc/editor-nuxt" or place that GitHub URL under a key like
"repository" or "source" if you need it distinct).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant