Skip to content

feat(Editor): allow disabling starter kit for plain text#6713

Merged
benjamincanac merged 1 commit into
v4from
editor-starter-kit-false
Jul 10, 2026
Merged

feat(Editor): allow disabling starter kit for plain text#6713
benjamincanac merged 1 commit into
v4from
editor-starter-kit-false

Conversation

@benjamincanac

Copy link
Copy Markdown
Member

🔗 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

The starter-kit prop now accepts a boolean. Setting it to false gives a plain text editor: it keeps the essential nodes (document, paragraph, text) plus history and hard breaks, and disables every formatting feature such as bold, italic, headings, lists, code, blockquote, links and horizontal rules. The custom Code and HorizontalRule extensions are skipped too.

Previously the only way to get a plain text editor was to turn off each formatting feature by hand through the starter-kit object, for example when building a plain text ChatPrompt:

:starter-kit="{ bold: false, italic: false, strike: false, code: false, underline: false, heading: false, blockquote: false, bulletList: false, orderedList: false, listItem: false, codeBlock: false }"

This now becomes:

<UEditor :starter-kit="false" />

starter-kit set to true or an object keeps the current behavior unchanged.

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Accept a boolean for the `starter-kit` prop so `starter-kit="false"` gives a plain text editor, keeping the essential nodes and history while disabling every formatting feature.
@github-actions github-actions Bot added the v4 #4488 label Jul 10, 2026
@pkg-pr-new

pkg-pr-new Bot commented Jul 10, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/@nuxt/ui@6713

commit: 3c0b258

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bf14efc8-4276-4521-a2c5-f0189b99d888

📥 Commits

Reviewing files that changed from the base of the PR and between 7e6d8b0 and 3c0b258.

📒 Files selected for processing (2)
  • docs/content/docs/2.components/editor.md
  • src/runtime/components/Editor.vue

📝 Walkthrough

Walkthrough

The editor’s starterKit prop now accepts false in addition to partial configuration objects and defaults to true. When disabled, the component applies plain-text options that retain essential nodes while disabling rich-text formatting. Code and horizontal-rule overrides are omitted in this mode. Documentation now describes the resulting plain-text configuration.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: disabling the starter kit to enable plain-text editing.
Description check ✅ Passed The description is directly related to the changes and accurately explains the new plain-text starter-kit behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch editor-starter-kit-false

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.

@benjamincanac
benjamincanac merged commit 76d613c into v4 Jul 10, 2026
24 checks passed
@benjamincanac
benjamincanac deleted the editor-starter-kit-false branch July 10, 2026 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v4 #4488

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant