Skip to content

feat(header-flyout): optionally allow header actions#4164

Merged
mergify[bot] merged 9 commits intobox:masterfrom
jmcbgaston:header-flyout-add-isOverlayHeaderActionEnabled-prop
Jun 27, 2025
Merged

feat(header-flyout): optionally allow header actions#4164
mergify[bot] merged 9 commits intobox:masterfrom
jmcbgaston:header-flyout-add-isOverlayHeaderActionEnabled-prop

Conversation

@jmcbgaston
Copy link
Contributor

@jmcbgaston jmcbgaston commented Jun 26, 2025

Summary by CodeRabbit

  • New Features
    • Added a new option to enable or disable overlay header actions in flyout headers, allowing for more flexible interaction handling.

@jmcbgaston jmcbgaston requested review from a team as code owners June 26, 2025 22:39
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 26, 2025

"""

Walkthrough

A new optional boolean prop, isOverlayHeaderActionEnabled, was introduced to both the OverlayHeader and HeaderFlyout components. This prop controls whether click events on the overlay header are allowed to propagate. Event handling logic in OverlayHeader was updated to conditionally prevent or allow event propagation based on this prop.

Changes

File(s) Change Summary
src/components/flyout/OverlayHeader.tsx Added optional isOverlayHeaderActionEnabled prop; updated event handler to conditionally block events
src/features/header-flyout/HeaderFlyout.js Added optional isOverlayHeaderActionEnabled prop; passed it to OverlayHeader
src/components/flyout/tests/OverlayHeader.test.js Added tests verifying click event propagation behavior based on isOverlayHeaderActionEnabled

Sequence Diagram(s)

sequenceDiagram
    participant Parent as Parent Component
    participant HeaderFlyout
    participant OverlayHeader

    Parent->>HeaderFlyout: Render with isOverlayHeaderActionEnabled?
    HeaderFlyout->>OverlayHeader: Render with isOverlayHeaderActionEnabled?
    OverlayHeader->>OverlayHeader: OnClick event
    alt isOverlayHeaderActionEnabled is true
        OverlayHeader->>OverlayHeader: Allow event propagation
    else isOverlayHeaderActionEnabled is false/undefined
        OverlayHeader->>OverlayHeader: Prevent and stop event propagation
    end
Loading

Suggested labels

ready-to-merge

Suggested reviewers

  • JChan106
  • jackiejou

Poem

A header overlay, now quite aware,
Of when to let clicks float through the air.
With a boolean guide, events may roam,
Or stay right there, content at home.
The code now listens, nimble and keen—
Hopping forward, crisp and clean! 🐇✨
"""


📜 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 cbbfd86 and 35e5f75.

⛔ Files ignored due to path filters (1)
  • src/features/header-flyout/__tests__/__snapshots__/HeaderFlyout.test.js.snap is excluded by !**/*.snap
📒 Files selected for processing (3)
  • src/components/flyout/OverlayHeader.tsx (1 hunks)
  • src/components/flyout/__tests__/OverlayHeader.test.js (1 hunks)
  • src/features/header-flyout/HeaderFlyout.js (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • src/features/header-flyout/HeaderFlyout.js
  • src/components/flyout/tests/OverlayHeader.test.js
  • src/components/flyout/OverlayHeader.tsx
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: lint_test_build
  • GitHub Check: Summary
✨ 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
🪧 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.

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: 1

🧹 Nitpick comments (1)
src/components/flyout/__tests__/OverlayHeader.test.js (1)

56-68: Improve test description for clarity.

The test description could be more concise and focused on the expected behavior.

Apply this diff to improve the test description:

-        test('should prevent default and stop propagation when elements in handleClick called and isOverlayHeaderActionEnabled is false', () => {
+        test('should prevent event propagation when isOverlayHeaderActionEnabled is false', () => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc2e052 and c8c8b03.

📒 Files selected for processing (1)
  • src/components/flyout/__tests__/OverlayHeader.test.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: lint_test_build
  • GitHub Check: Summary
🔇 Additional comments (1)
src/components/flyout/__tests__/OverlayHeader.test.js (1)

56-83: LGTM! Comprehensive test coverage for the new prop.

The test logic correctly verifies the behavior of the isOverlayHeaderActionEnabled prop:

  • When false: prevents event propagation (0 calls)
  • When true: allows event propagation (1 call)

The tests follow the existing pattern and provide good coverage for the new functionality.

@jmcbgaston jmcbgaston force-pushed the header-flyout-add-isOverlayHeaderActionEnabled-prop branch from 987d6d4 to cbbfd86 Compare June 27, 2025 17:32
@jmcbgaston jmcbgaston force-pushed the header-flyout-add-isOverlayHeaderActionEnabled-prop branch from cbbfd86 to 35e5f75 Compare June 27, 2025 18:35
@mergify mergify bot merged commit 8f3ad6e into box:master Jun 27, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants