Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(web): Manual chapter - Accordion scroll bugfix #16511

Merged
merged 3 commits into from
Oct 22, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Oct 22, 2024

Manual chapter - Accordion scroll bugfix

What

  • Keep accordion items open instead of closing them when another opens

Why

  • To prevent the page from scrolling out of view

Screenshots / Gifs

Before

Screen.Recording.2024-10-22.at.14.27.25.mov

After

Screen.Recording.2024-10-22.at.14.28.27.mov

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Enhanced accordion component functionality to allow multiple items to be expanded simultaneously.
    • Improved state management for selected and expanded items within the accordion.

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Oct 22, 2024
@RunarVestmann RunarVestmann requested review from a team as code owners October 22, 2024 14:28
Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes in this pull request focus on enhancing the state management of the accordion component within the ManualChapter.tsx file. A new state variable, expandedItemIds, is introduced to allow multiple accordion items to be expanded simultaneously. Modifications include updates to the expanded prop of the AccordionItem and the onToggle function to manage the expanded state and selected item more effectively.

Changes

File Change Summary
apps/web/screens/Manual/ManualChapter.tsx Added expandedItemIds state variable to track expanded accordion items; modified expanded prop and onToggle function for improved state management.

Possibly related PRs

  • feat(web): FAQ List and Accordion - Set single expand to false #15984: This PR modifies the Accordion component to allow multiple items to be expanded simultaneously by setting the singleExpand prop to false, which directly relates to the changes made in the main PR that also enhances the accordion's functionality to support multiple expanded items.
  • feat(web): Manual chapter links #16314: This PR enhances navigation within the ManualChapter.tsx by adding links to previous and next chapters, which complements the changes in the main PR that improve the state management of the accordion component within the same file.

Suggested labels

deploy-feature

Suggested reviewers

  • mannipje

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
🪧 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.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1a9f3cb and 8185e39.

📒 Files selected for processing (1)
  • apps/web/screens/Manual/ManualChapter.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/screens/Manual/ManualChapter.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."

apps/web/screens/Manual/ManualChapter.tsx Outdated Show resolved Hide resolved
apps/web/screens/Manual/ManualChapter.tsx Outdated Show resolved Hide resolved
apps/web/screens/Manual/ManualChapter.tsx Outdated Show resolved Hide resolved
@datadog-island-is
Copy link

datadog-island-is bot commented Oct 22, 2024

Datadog Report

Branch report: fix/web-manual-chapter-scroll-bug
Commit report: 58b82d4
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 33.33s Total Time
➡️ Test Sessions change in coverage: 1 no change

Copy link

codecov bot commented Oct 22, 2024

Codecov Report

Attention: Patch coverage is 0% with 14 lines in your changes missing coverage. Please review.

Project coverage is 36.76%. Comparing base (1b1edbe) to head (0ccb6e7).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
apps/web/screens/Manual/ManualChapter.tsx 0.00% 14 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16511      +/-   ##
==========================================
- Coverage   36.77%   36.76%   -0.01%     
==========================================
  Files        6847     6847              
  Lines      141872   141884      +12     
  Branches    40423    40429       +6     
==========================================
  Hits        52167    52167              
- Misses      89705    89717      +12     
Flag Coverage Δ
web 1.81% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
apps/web/screens/Manual/ManualChapter.tsx 0.00% <0.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 49ba64d...0ccb6e7. Read the comment docs.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
apps/web/screens/Manual/ManualChapter.tsx (1)

189-202: LGTM: Improved state management for collapsing items

The logic for collapsing items is well-implemented. It correctly updates both expandedItemIds and selectedItemId, maintaining consistency between the two states. This change effectively supports the new behavior of keeping multiple items expanded.

A minor optimization could be to use Array.prototype.filter() instead of splicing:

setExpandedItemIds((prev) => prev.filter(id => id !== item.id))

This approach is more declarative and potentially easier to read.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8185e39 and 433347d.

📒 Files selected for processing (1)
  • apps/web/screens/Manual/ManualChapter.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/screens/Manual/ManualChapter.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (2)
apps/web/screens/Manual/ManualChapter.tsx (2)

78-80: LGTM: New state variable for managing expanded items

The introduction of expandedItemIds state variable is a good approach to track multiple expanded accordion items. This change aligns with the PR objective of allowing multiple items to remain open simultaneously, enhancing the user experience.


Line range hint 1-283: Overall assessment: Changes meet PR objectives with room for minor improvements

The implemented changes successfully achieve the PR objective of allowing multiple accordion items to remain open simultaneously. The state management has been thoughtfully updated to handle this new behavior, improving the user experience as intended.

While there are no critical issues, consider the following minor optimizations to further enhance the code quality:

  1. Simplify the expanded condition in the AccordionItem props.
  2. Prevent potential duplicate IDs in the expandedItemIds state.
  3. Use Array.prototype.filter() for a more declarative approach when removing items from expandedItemIds.

These suggestions aim to make the code more robust and easier to maintain. Great job on implementing this feature!

apps/web/screens/Manual/ManualChapter.tsx Show resolved Hide resolved
apps/web/screens/Manual/ManualChapter.tsx Show resolved Hide resolved
@kodiakhq kodiakhq bot merged commit 368b5fc into main Oct 22, 2024
33 checks passed
@kodiakhq kodiakhq bot deleted the fix/web-manual-chapter-scroll-bug branch October 22, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants