Skip to content

Comments

chore: outlines support toggle h1-h6#72

Merged
qinluhe merged 2 commits intomainfrom
chore/support-toggle-heading-on-outline
Mar 31, 2025
Merged

chore: outlines support toggle h1-h6#72
qinluhe merged 2 commits intomainfrom
chore/support-toggle-heading-on-outline

Conversation

@qinluhe
Copy link
Contributor

@qinluhe qinluhe commented Mar 31, 2025

Description


Checklist

General

  • I've included relevant documentation or comments for the changes introduced.
  • I've tested the changes in multiple environments (e.g., different browsers, operating systems).

Testing

  • I've added or updated tests to validate the changes introduced for AppFlowy Web.

Feature-Specific

  • For feature additions, I've added a preview (video, screenshot, or demo) in the "Feature Preview" section.
  • I've verified that this feature integrates seamlessly with existing functionality.

Summary by Sourcery

Enhancements:

  • Update heading extraction and nesting logic to support toggle list blocks with levels

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 31, 2025

Reviewer's Guide by Sourcery

This pull request modifies the extractHeadings function to support extracting headings from ToggleListBlocks in addition to HeadingBlocks. This allows the outline to display headings within toggle lists.

Updated class diagram for HeadingNode

classDiagram
    class HeadingNode {
        BlockType type
        Object data
        Element[] children
    }

    HeadingNode : +BlockType type
    HeadingNode : +Object data
    HeadingNode : +Element[] children

    note for HeadingNode "HeadingNode now supports ToggleListBlock"
Loading

File-Level Changes

Change Details Files
Extends extractHeadings to include ToggleListBlock elements.
  • Modified the condition within the traverse function to include BlockType.ToggleListBlock when identifying headings.
  • Added a check to ensure the block has a 'level' property in its data before considering it a heading.
src/components/editor/components/blocks/outline/utils.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @qinluhe - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment explaining why ToggleListBlock is being included in the outline.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

if (block.type === BlockType.HeadingBlock && (block as HeadingNode).data?.level <= maxDepth) {
function traverse(children: (Element | Text)[]) {
for(const block of children) {
if(Text.isText(block)) continue;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (code-quality): Use block braces for ifs, whiles, etc. (use-braces)

Suggested change
if(Text.isText(block)) continue;
if (Text.isText(block)) {


ExplanationIt is recommended to always use braces and create explicit statement blocks.

Using the allowed syntax to just write a single statement can lead to very confusing
situations, especially where subsequently a developer might add another statement
while forgetting to add the braces (meaning that this wouldn't be included in the condition).

@qinluhe qinluhe force-pushed the chore/support-toggle-heading-on-outline branch from a2efbad to f884ebd Compare March 31, 2025 05:29
@qinluhe qinluhe merged commit 71c7ff5 into main Mar 31, 2025
3 checks passed
@qinluhe qinluhe deleted the chore/support-toggle-heading-on-outline branch March 31, 2025 06:11
appflowy added a commit that referenced this pull request Nov 14, 2025
…established. At this point, the (#72)

WebSocket instance is fully initialized and ready for configuration
josue693 pushed a commit to josue693/AppFlowy-Web that referenced this pull request Dec 21, 2025
* chore: outlines support toggle h1-h6

* fix: add anchor point to outline content
josue693 pushed a commit to josue693/AppFlowy-Web that referenced this pull request Dec 21, 2025
…established. At this point, the (AppFlowy-IO#72)

WebSocket instance is fully initialized and ready for configuration
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant