refactor: use CellEditorHandler plugin in selected-features examples

[tbouffard]

This plugin allows you to edit cell labels, a feature enabled in related examples using Graph.

Also improve the JSDoc of CellEditorHandler.

Notes

Covers #760

Application/chunk size

example	before	now
JavaScript	411.2 kB	423.45 kB
TypeScript	368.72 kB	381.15 kB

[coderabbitai]

Walkthrough

The changes update documentation comments for the CellEditorHandler plugin and its related configuration in the core package, clarifying editor behavior and improving example code formatting. Additionally, the CellEditorHandler plugin is now imported and registered in both JavaScript and TypeScript example projects, enabling in-place cell label editing functionality. No functional or behavioral code changes were made; all modifications are limited to comments, documentation, and plugin registration.

Changes

Files/Paths	Change Summary
packages/core/src/view/mixins/EventsMixin.type.ts	Clarified and reformatted documentation for the enterStopsCellEditing property in the type definition.
packages/core/src/view/plugins/CellEditorHandler.ts	Extensively rewrote and reformatted documentation comments, improved example code, and updated references for clarity and consistency.
packages/js-example-selected-features/src/index.js packages/ts-example-selected-features/src/main.ts	Added import and registration of CellEditorHandler plugin to enable in-place cell label editing in example projects.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CustomGraph
    participant CellEditorHandler

    User->>CustomGraph: Initiates cell label edit (e.g., double-click)
    CustomGraph->>CellEditorHandler: Delegates editing request
    CellEditorHandler-->>CustomGraph: Handles in-place editing (shows editor)
    User->>CellEditorHandler: Edits label, presses Enter/F2/Escape
    CellEditorHandler-->>CustomGraph: Applies or cancels edit based on key

Loading

---

📜 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 3a1dc00 and 8d1a925.

📒 Files selected for processing (4)

• packages/core/src/view/mixins/EventsMixin.type.ts (1 hunks)
• packages/core/src/view/plugins/CellEditorHandler.ts (2 hunks)
• packages/js-example-selected-features/src/index.js (2 hunks)
• packages/ts-example-selected-features/src/main.ts (2 hunks)

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

• GitHub Check: build
• GitHub Check: build (windows-2022)
• GitHub Check: build (macos-14)
• GitHub Check: build (ubuntu-22.04)

🔇 Additional comments (12)

packages/core/src/view/mixins/EventsMixin.type.ts (1)

55-60: Documentation improvement clarifies key behavior and interactions.

The updated JSDoc comment now correctly references CellEditorHandler instead of the former class name, and provides clearer information about key interactions during cell editing. The documentation now explicitly states that F2 accepts changes and escape undoes changes, which is valuable context for developers.

packages/js-example-selected-features/src/index.js (2)

20-22: Added import for CellEditorHandler plugin.

The import statement is correctly added to enable cell label editing functionality.

---

83-85: Added CellEditorHandler to enable in-place editing.

The CellEditorHandler plugin is properly registered with a clear comment explaining its purpose. This change meets the PR objective of enabling cell label editing in example projects.

packages/ts-example-selected-features/src/main.ts (2)

20-22: Added import for CellEditorHandler plugin.

The import statement is correctly added to enable cell label editing functionality.

---

64-66: Added CellEditorHandler to enable in-place editing.

The CellEditorHandler plugin is properly registered with a clear comment explaining its purpose. This change matches the similar integration in the JavaScript example, providing consistent implementation across example projects.

packages/core/src/view/plugins/CellEditorHandler.ts (7)

56-66: Improved class documentation with clear control flags.

The documentation now clearly lists the three control flags that affect editing behavior and explains key interactions. This makes it easier for developers to understand how to configure the editor.

---

69-79: Updated example code with modern syntax.

The example code has been improved to use arrow functions and current method names, matching the overall coding style of the project.

---

83-86: Clarified autoSize property behavior.

The documentation now better explains the relationship between the autoSize property and the Shape.getLabelBounds method, which is important for understanding when custom editor bounds are applied.

---

94-98: Modernized code example for event handling.

Updated the event handling code example to use current API names and conventions.

---

102-114: Added clear section headers to organize documentation.

The documentation now has distinct sections for "Placeholder" and "Resize the textarea," making it easier to find specific customization options.

---

120-132: Improved key press event example.

The example for handling key press events has been updated with modern event utilities and proper formatting.

---

134-146: Improved container focus example.

The documentation for maintaining container focus has been updated with arrow functions and modern method naming.

✨ 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.
  • 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 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud