[WEB-4361] fix: add onChange to collaborative editor

[prateekshourya29]

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)

Summary by CodeRabbit

• New Features
  • The collaborative editor now supports an onChange handler, allowing it to respond to content changes in real time.

[coderabbitai]

Walkthrough

The useCollaborativeEditor hook was updated to accept an onChange callback in its props and forward it to the underlying useEditor hook. This enables the collaborative editor to handle change events through the provided callback.

Changes

File(s)	Change Summary
packages/editor/src/core/hooks/use-collaborative-editor.ts	Added onChange prop to useCollaborativeEditor and passed it to useEditor.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant useCollaborativeEditor
    participant useEditor

    Caller->>useCollaborativeEditor: Call with { onChange }
    useCollaborativeEditor->>useEditor: Call with { onChange }
    useEditor-->>useCollaborativeEditor: Returns editor instance
    useCollaborativeEditor-->>Caller: Returns collaborative editor

Loading

Poem

A nibble, a hop, a change in the air—
Now editors listen with collaborative care.
With onChange in tow,
The updates will flow,
As rabbits rejoice in features we share!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f26b4d3 and fbd468f.

📒 Files selected for processing (1)

• packages/editor/src/core/hooks/use-collaborative-editor.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (3)

packages/editor/src/core/hooks/use-collaborative-editor.ts (3)

16-16: Clean implementation of onChange prop forwarding.

The implementation follows a clear and consistent prop forwarding pattern that aligns well with the existing codebase structure. The changes are minimal and focused, which is appropriate for adding this functionality.

Also applies to: 109-109

---

109-109: Verify that useEditor accepts the onChange parameter.

The prop forwarding looks consistent with the existing pattern, but ensure that the useEditor hook accepts and properly handles the onChange parameter.

#!/bin/bash
# Description: Verify that useEditor hook accepts onChange parameter
# Expected: The useEditor hook definition should include onChange in its parameters

# Search for the useEditor hook definition and its parameters
ast-grep --pattern 'export const useEditor = ($PARAMS) => {
  $$$
}'

# Also search for useEditor type definition
ast-grep --pattern 'type $TYPE = {
  $$$
  onChange$$$
  $$$
}'

# Search for any onChange usage within useEditor implementation
rg -A 10 -B 5 "onChange" packages/editor/src/hooks/use-editor.ts

---

16-16: Let’s pinpoint the actual useEditor implementation and check for onChange support:

#!/bin/bash
set -e

# Locate the useEditor hook in its file
FILE="packages/editor/src/core/hooks/use-editor.ts"

if [ -f "$FILE" ]; then
  echo "Showing useEditor signature and body excerpts from $FILE:"
  sed -n '/export const useEditor/,/^}/p' "$FILE"
  echo
  echo "Looking for onChange in the signature or body:"
  grep -n "onChange" "$FILE" || echo "⚠️ onChange not referenced"
else
  echo "❌ $FILE not found"
  exit 1
fi

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[makeplane]

Pull Request Linked with Plane Work Items

• [WEB-4361] Add back onChange callback in Collaborative Editor

Comment Automatically Generated by Plane