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

Allow the report table columns to grow to fill available space #3872

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

matt-fidd
Copy link
Contributor

I'll need someone with more experience here to tell me if/why this is a bad idea, but it fixes my problem of the first column being far too small for account names etc.

Before:
image

After:
image

@actual-github-bot actual-github-bot bot changed the title Allow the report table columns to grow to fill available space [WIP] Allow the report table columns to grow to fill available space Nov 21, 2024
Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 3e96a73
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/673fa25efd7b830008bc1a39
😎 Deploy Preview https://deploy-preview-3872.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

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
10 5.46 MB → 5.46 MB (+50 B) +0.00%
Changeset
File Δ Size
src/components/reports/graphs/tableGraph/ReportTableHeader.tsx 📈 +25 B (+0.95%) 2.57 kB → 2.6 kB
src/components/reports/graphs/tableGraph/ReportTableRow.tsx 📈 +25 B (+0.34%) 7.22 kB → 7.24 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/ReportRouter.js 1.52 MB → 1.52 MB (+50 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.72 kB 0%
static/js/wide.js 241.19 kB 0%
static/js/index.js 3.44 MB 0%

Copy link
Contributor

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.32 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.32 MB 0%

@matt-fidd
Copy link
Contributor Author

/update-vrt

@matt-fidd matt-fidd changed the title [WIP] Allow the report table columns to grow to fill available space Allow the report table columns to grow to fill available space Nov 21, 2024
Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Walkthrough

This pull request introduces layout modifications to two components: ReportTableHeader and ReportTableRow. In ReportTableHeader.tsx, a new style property, flexGrow: 1, has been added to the first Cell component, allowing it to expand and occupy available space within its flex container. This adjustment is intended to enhance the layout behavior of the header cells without altering the overall structure, logic, or rendering of the component. Similarly, in ReportTableRow.tsx, the Cell component has also been updated with the flexGrow: 1 property, enabling it to fill available space in its flex container. The changes focus solely on layout adjustments, and there are no modifications to the component's logic, error handling, or public entity declarations.

Possibly related PRs

  • ✨ polishing report responsitivity #3636: The changes in this PR focus on enhancing the responsiveness of report components, which directly relates to the layout modifications made in the ReportTableHeader and ReportTableRow components by introducing flexGrow properties to improve their layout behavior.

Suggested reviewers

  • MikesGlitch

Warning

Rate limit exceeded

@actual-github-bot[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between c626fc2 and 3e96a73.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint (1.23.1)

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableHeader.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


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

🧹 Outside diff range and nitpick comments (3)
packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableHeader.tsx (2)

Line range hint 69-74: Consider a more flexible width approach.

Instead of combining fixed width with flexGrow, consider using minWidth for better flexibility:

 <Cell
   style={{
-    width: compact ? 80 : 125,
+    minWidth: compact ? 80 : 125,
     flexShrink: 0,
     flexGrow: 1,
   }}

This would:

  1. Ensure minimum width for readability
  2. Allow more natural growth based on content
  3. Prevent potential layout issues when viewport size changes

Line range hint 46-74: Consider adding max-width constraint.

To prevent the first column from dominating the layout, especially with longer account names, consider adding a maximum width constraint:

 <Cell
   style={{
     width: compact ? 80 : 125,
     flexShrink: 0,
     flexGrow: 1,
+    maxWidth: '33%', // Prevents the column from taking too much space
   }}

This would help maintain a balanced layout while still providing more space for account names.

packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx (1)

126-126: LGTM! Consider adding a comment to document the flex behavior.

The addition of flexGrow: 1 effectively addresses the issue of narrow first columns by allowing them to expand and utilize available space. This change aligns well with the component's existing flex layout structure.

Consider adding a comment to document this important layout behavior:

             flexShrink: 0,
+            // Allow the first column to grow and fill available space
             flexGrow: 1,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c626fc2 and 3e96a73.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3872.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableHeader.tsx (1 hunks)
  • packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx (1 hunks)
🔇 Additional comments (1)
packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableHeader.tsx (1)

73-73: LGTM! Consider monitoring fixed width behavior.

The addition of flexGrow: 1 aligns with the PR objective to better accommodate account names. However, the combination of fixed width with flexGrow might lead to unexpected behavior in certain viewport sizes.

Let's verify the visual consistency across different viewport sizes:

✅ Verification successful

Styling is consistent, change is safe

The flexGrow: 1 addition in the header aligns perfectly with the row implementation, as the first Cell in ReportTableRow also uses flexGrow: 1 with the same width constraints (80px for compact, 125px for regular mode). The styling is consistent across both components, ensuring proper column alignment.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find related table components to verify consistent styling
# Look for other table components that might need similar flexGrow adjustments
rg -t tsx "ReportTable(Row|Cell)" packages/desktop-client/src/components/

Length of output: 103


Script:

#!/bin/bash
# Search for related table components using ripgrep without file type restriction
rg "ReportTable(Row|Cell)" packages/desktop-client/src/components/

Length of output: 887


Script:

#!/bin/bash
# Check the styling in ReportTableRow to verify consistency with the header's flexGrow
cat packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx

Length of output: 10101

Copy link
Contributor

@MikesGlitch MikesGlitch left a comment

Choose a reason for hiding this comment

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

LGTM

@matt-fidd matt-fidd merged commit 022b9b7 into actualbudget:master Nov 21, 2024
20 checks passed
@matt-fidd matt-fidd deleted the report-table-grow branch November 21, 2024 22:36
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.

2 participants