[WEB-2723] fix: callout content not being saved in description html

[aaryan610]

Fixes:

Callout content no being saved in the html format.

Summary by CodeRabbit

• New Features

  • Enhanced rendering of callout components with improved attribute handling.

• Bug Fixes

  • Adjusted the structure of attributes for better performance in the callout extension.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the CustomCalloutExtensionConfig within the extension-config.ts file. The renderHTML method has been updated to return an array with an additional parameter, enhancing the rendering of the callout component. Furthermore, the addAttributes method has been modified to use reduce instead of map for accumulating attributes, improving the structure of the attributes without altering the overall public interface or structure of the extension.

Changes

File Path	Change Summary
packages/editor/src/core/extensions/callout/...	- Modified renderHTML to return an array with an additional parameter 0.
packages/editor/src/core/extensions/callout/...	- Updated addAttributes to use reduce for accumulating attributes into an object.

Possibly related PRs

• [PE-68] fix: markdown transformation of mention and custom image components #5864: The changes in this PR involve enhancements to the CustomImageExtension and CustomMention extensions, which may relate to the modifications in the CustomCalloutExtensionConfig in the main PR, as both involve extensions that handle rendering and serialization of components in the editor.

Suggested reviewers

• SatishGandham
• pushya22

🐇 In the garden, I hop and play,
With callouts bright, they light the way.
Attributes gathered, neat in a row,
Rendering magic, watch them glow!
A tweak here, a change there,
In the editor's heart, joy fills the air! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/editor/src/core/extensions/callout/extension-config.ts (1)

66-66: Consider adding documentation for the renderHTML implementation.

The 0 parameter plays a crucial role in content preservation, but its purpose isn't immediately clear. Consider adding a comment explaining that this parameter specifies the content position in Tiptap's node rendering system.

Example documentation:

  renderHTML({ HTMLAttributes }) {
+   // The third parameter (0) indicates where the node's content should be rendered
+   // This is crucial for proper content preservation in Tiptap's node system
    return ["callout-component", mergeAttributes(HTMLAttributes), 0];
  },

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6113aef and f59c292.

📒 Files selected for processing (1)

• packages/editor/src/core/extensions/callout/extension-config.ts (1 hunks)

🔇 Additional comments (2)

packages/editor/src/core/extensions/callout/extension-config.ts (2)

Line range hint 21-29: LGTM! Good optimization of attribute handling.

The change from map to reduce is a good optimization as it directly accumulates attributes into an object without creating an intermediate array. However, this change appears unrelated to the core issue of callout content not being saved.

---

66-66: Correct fix for content preservation.

Adding the content position parameter (0) is the right fix for ensuring callout content is saved. This follows Tiptap's node rendering pattern where the third parameter indicates where the content should be rendered within the node.

Let's verify this pattern is consistent with other similar components: