feat(EditorSuggestionMenu): expose TipTap suggestion matching options#6234
feat(EditorSuggestionMenu): expose TipTap suggestion matching options#6234Archetipo95 wants to merge 3 commits intonuxt:v4from
Conversation
📝 WalkthroughWalkthroughThis PR adds support for exposing TipTap suggestion matching options through a new optional Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/runtime/composables/useEditorMenu.ts`:
- Around line 68-71: The suggestion spread currently allows options.suggestion
to override core fields (pluginKey, editor, char) which can break plugin state;
update the construction around options.suggestion (where suggestion?:
Partial<SuggestionOptions> is used and options.suggestion is spread) so that
pluginKey, editor and char are applied after spreading user options OR
explicitly omit those keys from the spread (i.e., create a sanitizedSuggestion =
{ ...options.suggestion } without pluginKey/editor/char) and then build the
final suggestion object using pluginKeyInstance/pluginKey/editor/char last to
ensure the core values always take precedence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 709ec4e6-dd63-4a8c-bfb2-910d23119493
📒 Files selected for processing (5)
CHANGELOG.mddocs/content/docs/2.components/editor-suggestion-menu.mdsrc/runtime/components/EditorSuggestionMenu.vuesrc/runtime/composables/useEditorMenu.tstest/composables/useEditorMenu.spec.ts
| /** | ||
| * Optional TipTap Suggestion matching options. | ||
| */ | ||
| suggestion?: Partial<SuggestionOptions> |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
In the current @tiptap/suggestiontype/docs, doesSuggestionOptionsincludepluginKey, editor, and char, and are they intended to be externally overridden in wrapper APIs?
💡 Result:
No, in the current @tiptap/suggestion (v3.x as of 2026), the SuggestionOptions interface does not include pluginKey, editor, or char as configurable properties in the way typically used when configuring extensions via .configure. Instead, these are direct parameters to the standalone Suggestion function that returns a ProseMirror plugin. The official Tiptap documentation lists char, pluginKey, allow, shouldShow, etc., as "Settings" for the Suggestion utility, with examples like Suggestion({ char: '@', pluginKey: SuggestionPluginKey, ... }). This matches the source code signature: export function Suggestion({ pluginKey = SuggestionPluginKey, editor, // required char = '@', ... }: SuggestionOptions) editor is required when calling Suggestion directly (internal use by extensions like Mention), but omitted in extension .configure calls (e.g., suggestion: { char: '#', command: ... } uses Omit<SuggestionOptions, 'editor'>). They are not intended for external override in wrapper APIs like node extensions. Wrapper extensions (Mention, Hashtag) expose a suggestion prop that accepts a subset excluding editor, with pluginKey often hardcoded (e.g., MentionPluginKey), and char customizable. Users override via the extension's suggestion config, not raw SuggestionOptions.
Citations:
- 1: https://tiptap.dev/docs/editor/api/utilities/suggestion
- 2: https://tiptap.dev/api/utilities/suggestion
- 3: https://www.cold-air.eu
- 4: https://www.socialbandbands.com
- 5: https://app.unpkg.com/@tiptap/suggestion@3.19.0/files/src/suggestion.ts
🏁 Script executed:
# First, check if the file exists and get its line count
wc -l src/runtime/composables/useEditorMenu.tsRepository: nuxt/ui
Length of output: 95
🏁 Script executed:
# View the import section and the type definition around lines 68-71
head -n 90 src/runtime/composables/useEditorMenu.ts | tail -n +1Repository: nuxt/ui
Length of output: 3011
🏁 Script executed:
# View the Suggestion plugin config section around lines 496-501
sed -n '490,510p' src/runtime/composables/useEditorMenu.tsRepository: nuxt/ui
Length of output: 607
Prevent suggestion from overriding core plugin wiring (pluginKey/editor/char).
At lines 496–501, the spread of options.suggestion occurs after the core fields are defined, allowing pluginKey, editor, and char to be overridden. If pluginKey is overridden, your exit transaction (which uses pluginKeyInstance) can target a different plugin key and leave sessions in a bad state.
Constrain the suggestion option to exclude these fields and ensure they always take precedence by reordering the spread:
🔧 Proposed fix
+type EditorMenuSuggestionOptions = Omit<
+ Partial<SuggestionOptions>,
+ 'pluginKey' | 'editor' | 'char' | 'items' | 'command' | 'render'
+>
+
export interface EditorMenuOptions<T = any> {
editor: Editor
/**
* The trigger character (e.g., '/', '@', ':')
*/
char: string
/**
* Plugin key to identify this menu
*/
pluginKey: string
...
- suggestion?: Partial<SuggestionOptions>
+ suggestion?: EditorMenuSuggestionOptions const plugin = Suggestion({
- pluginKey: pluginKeyInstance,
- editor: options.editor,
- char: options.char,
...(options.suggestion || {}),
+ pluginKey: pluginKeyInstance,
+ editor: options.editor,
+ char: options.char,
items: ({ query: q }: { query: string }) => {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/runtime/composables/useEditorMenu.ts` around lines 68 - 71, The
suggestion spread currently allows options.suggestion to override core fields
(pluginKey, editor, char) which can break plugin state; update the construction
around options.suggestion (where suggestion?: Partial<SuggestionOptions> is used
and options.suggestion is spread) so that pluginKey, editor and char are applied
after spreading user options OR explicitly omit those keys from the spread
(i.e., create a sanitizedSuggestion = { ...options.suggestion } without
pluginKey/editor/char) and then build the final suggestion object using
pluginKeyInstance/pluginKey/editor/char last to ensure the core values always
take precedence.
commit: |
howwohmm
left a comment
howwohmm
left a comment
There was a problem hiding this comment.
nice addition — exposing TipTap's suggestion matching options is useful for custom slash commands.
one thing worth watching: the spread order in the suggestion config means options.suggestion could accidentally override pluginKey or editor since it's spread after those positional keys. a consumer passing suggestion: { pluginKey: ... } would silently replace the internal plugin key.
safest fix would be to destructure and omit the dangerous keys before spreading:
const { pluginKey: _pk, editor: _ed, char: _ch, ...safeSuggestion } = options.suggestion || {}or move pluginKey, editor, and char after the spread so they always win. either way it's a one-line guard against a subtle footgun.
2 participants
🔗 Linked issue
Resolves #6233
❓ Type of change
📚 Description
This PR exposes TipTap suggestion matching options on
UEditorSuggestionMenuso users can customize how trigger characters are matched.The main change is adding a new optional
suggestion?: Partial<SuggestionOptions>prop toUEditorSuggestionMenuand threading it throughEditorMenuOptionsinto the internal TipTapSuggestion(...)configuration.This allows opt-in use cases such as setting
allowedPrefixes: nullso a:trigger can open directly after/or letters, instead of only after whitespace.The implementation preserves existing behavior.
This PR also includes:
suggestionis omittedEditorSuggestionMenupage📝 Checklist