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

Visually deconflict sync status from notifications button #3547

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

afv22
Copy link

@afv22 afv22 commented Oct 2, 2024

Fixes #3536

Increasing stack placement of the "Syncing..." alert so it does not visually conflict with the notifications button.

Before

Screenshot 2024-10-02 at 5 42 27 PM

After

Screenshot 2024-10-02 at 5 42 39 PM

Copy link

netlify bot commented Oct 2, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 4c9fb58
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/66fdc725c7601b0008d5bb7b
😎 Deploy Preview https://deploy-preview-3547.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
9 5.29 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/AppliedFilters.js 20.96 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 81.98 kB 0%
static/js/wide.js 225.26 kB 0%
static/js/ReportRouter.js 1.5 MB 0%
static/js/index.js 3.31 MB 0%

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.19 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.19 MB 0%

@afv22 afv22 changed the title [WIP] Hover 'Syncing' animation over notification button [WIP] Stack 'Syncing' animation over notification button Oct 2, 2024
@afv22 afv22 changed the title [WIP] Stack 'Syncing' animation over notification button [WIP] Visually deconflict sync status from notifications button Oct 2, 2024
@afv22 afv22 changed the title [WIP] Visually deconflict sync status from notifications button Visually deconflict sync status from notifications button Oct 2, 2024
@afv22 afv22 marked this pull request as ready for review October 2, 2024 22:25
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The pull request modifies the BankSyncStatus component by changing the zIndex style property from 501 to 1000. This adjustment affects the stacking order of the component within the user interface, ensuring it displays correctly relative to other notifications. No additional changes to functionality or structure are included in this update.

Changes

File Path Change Summary
packages/desktop-client/src/components/BankSyncStatus.tsx Updated zIndex from 501 to 1000 in View component.

Assessment against linked issues

Objective Addressed Explanation
Resolve overlapping notifications (#3536)

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • joel-jeremy

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.

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

🧹 Outside diff range and nitpick comments (1)
packages/desktop-client/src/components/BankSyncStatus.tsx (1)

Line range hint 1-72: Consider improvements for accessibility, customization, and testing.

While the current implementation addresses the immediate issue, here are some suggestions to enhance the component:

  1. Accessibility: Add appropriate ARIA attributes to improve screen reader support. For example:

    <View
      role="status"
      aria-live="polite"
      aria-atomic="true"
    >
      {/* ... */}
    </View>
  2. Customization: Consider extracting the styles into a separate constant or using a theming system for easier customization. This could make future adjustments simpler.

  3. Testing: Add test IDs to key elements to facilitate easier testing. For example:

    <View data-testid="bank-sync-status">
      {/* ... */}
    </View>

Would you like me to provide more detailed code examples for these improvements?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 125510c and 4c9fb58.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3547.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/BankSyncStatus.tsx (1 hunks)

@@ -35,7 +35,7 @@ export function BankSyncStatus() {
right: 0,
marginTop: 5,
alignItems: 'center',
zIndex: 501,
zIndex: 1000,
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 2, 2024

Choose a reason for hiding this comment

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

💡 Codebase verification

Potential z-index conflicts detected.

Several other components already use zIndex values of 1000 or higher. Setting zIndex: 1000 in BankSyncStatus.tsx may still lead to visual overlaps with these elements. Consider reviewing and adjusting the z-index hierarchy to ensure clear layering and avoid conflicts.

🔗 Analysis chain

Increased z-index addresses the visual overlap issue.

The change from zIndex: 501 to zIndex: 1000 should effectively resolve the visual conflict between the "Syncing..." alert and the notifications button. This aligns with the PR objective of deconflicting the sync status from the notifications button.

To ensure this change doesn't introduce any new conflicts, let's verify the z-index values of other components:

If this script returns any results, we may need to re-evaluate the chosen z-index value to ensure it doesn't conflict with other important UI elements.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any z-index values greater than or equal to 1000
# Expected result: No other components should have a z-index >= 1000

rg --type typescript --type javascript 'zIndex:?\s*(\d{4,}|[1-9]\d{3,})' -g '!**/BankSyncStatus.tsx'

Length of output: 137


Script:

#!/bin/bash
# Description: Check for any z-index values greater than or equal to 1000
# Expected result: No other components should have a z-index >= 1000

rg --type ts --type tsx --type js 'zIndex\s*:\s*(1000|[1-9]\d{3,})' -g '!**/BankSyncStatus.tsx'

Length of output: 125


Script:

#!/bin/bash
# Description: Check for any z-index values greater than or equal to 1000
# Expected result: No other components should have a z-index >= 1000

rg 'zIndex\s*:\s*(1000|[1-9]\d{3,})' -g '*.ts' -g '*.tsx' -g '*.js' -g '!packages/desktop-client/src/components/BankSyncStatus.tsx'

Length of output: 1719

Copy link
Author

Choose a reason for hiding this comment

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

Realized the increased zIndex conflicts with the left-hand menu button, making it impossible to open the menu when the 'syncing' message is present. Will update.

Copy link
Contributor

Choose a reason for hiding this comment

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

@afv22, glad you noticed the conflict! Let me know if you need any assistance resolving it.

(_/)
(•_•)
(/ ) Yay!


If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!

@afv22 afv22 marked this pull request as draft October 2, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Notifications overlapping
1 participant