Table of contents fixes

[eliandoran]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refines the Table of Contents functionality by improving the detection mechanism for changes that necessitate a TOC update. It introduces a dedicated utility to accurately identify when attribute modifications within the CKEditor model affect headings, ensuring the Table of Contents remains synchronized with the document structure. Additionally, it optimizes the update process by deferring TOC rendering to the next animation frame, enhancing overall UI responsiveness.

Highlights

• Improved Heading Change Detection: Introduced a new utility function, attributeChangeAffectsHeading, to accurately determine if a CKEditor model attribute change impacts a heading element, ensuring more reliable Table of Contents updates.
• Optimized Table of Contents Updates: The Table of Contents component now uses the new utility for detecting relevant changes and defers its updates using requestAnimationFrame to enhance rendering performance and prevent potential UI issues.
• New Utility Module: A new utils.ts file was added to the ckeditor5 package, encapsulating helper functions for identifying heading elements and their ancestors, which are crucial for the improved change detection.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• apps/client/src/widgets/sidebar/TableOfContents.tsx
  • Imported the new attributeChangeAffectsHeading utility from @triliumnext/ckeditor5.
  • Modified the change detection logic within the EditableTextTableOfContents component to leverage attributeChangeAffectsHeading for attribute changes.
  • Wrapped the setHeadings call within requestAnimationFrame to defer DOM updates for improved rendering performance.
• packages/ckeditor5/src/index.ts
  • Exported all functions and types from the newly created utils.ts file, making them accessible to other modules.
• packages/ckeditor5/src/utils.ts
  • Added isHeadingElement helper function to check if a given ModelNode is a heading element.
  • Added hasHeadingAncestor helper function to determine if a ModelNode has a heading element as an ancestor.
  • Added attributeChangeAffectsHeading function to robustly determine if an attribute change within the CKEditor model affects a heading, considering both direct parent and full range traversal.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces fixes for the Table of Contents (ToC) functionality. The changes improve the detection of updates within heading elements by introducing a more robust attributeChangeAffectsHeading utility. Additionally, wrapping the ToC update logic in requestAnimationFrame is a good practice to prevent potential race conditions. The overall approach is sound. I've added a couple of suggestions to the new utils.ts file to enhance code quality and resolve a circular dependency.