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

004-nov-21-vendorsemptystate-newsvg #272

Merged

Conversation

salmanja
Copy link
Contributor

@salmanja salmanja commented Nov 21, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced TableWithPlaceholder component to display a message when no data is available, improving user feedback.
    • Updated rendering logic for the placeholder, now using a flex layout for better alignment.
  • Style

    • Adjusted styling for the placeholder image, explicitly setting its width and enhancing visual separation with added margins.
    • Updated text message styling for consistency and improved readability.

Copy link

coderabbitai bot commented Nov 21, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The TableWithPlaceholder component in the project has been updated to enhance its layout and presentation. The import statement for Typography has been streamlined by removing an unused import of Stack. The rendering logic for the placeholder when no vendor data is available has been adjusted to use a flex layout instead of grid, with improved alignment and spacing. The placeholder image's width is explicitly set to 150 pixels, and additional margins have been added. The text message displayed when no data is present has been updated for better styling consistency.

Changes

File Path Change Summary
Clients/src/presentation/components/Table/WithPlaceholder/index.tsx Enhanced layout of TableWithPlaceholder, removed unused Stack import, updated placeholder rendering to flex, adjusted styling, set placeholder image width to 150 pixels, and improved text styling for no data message.

Possibly related PRs

Suggested labels

Frontend Devs

Suggested reviewers

  • popovaevgeniya
  • melpsh
  • MatthewSharpOTU

Poem

In a table where data once lay bare,
A placeholder now dances with flair.
With a message so bright,
It brings hope to the night,
As rabbits hop by, with nary a care! 🐇✨


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.

@salmanja salmanja changed the title new svg in vendor empty state 004-nov-21-vendorsemptystate-newsvg Nov 21, 2024
Copy link

@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 (2)
Clients/src/presentation/components/Table/WithPlaceholder/index.tsx (2)

169-177: Consider formatting the style object consistently.

The style properties have inconsistent spacing. Some properties have spaces after the colon while others don't.

Apply this formatting for consistency:

 style={{
   display: "flex",
   justifyContent: "center",
   flexDirection: "column",
   alignItems: "center",
   border: "1px solid #EEEEEE",
   borderRadius: "4px",
   borderTop: "none",
   padding: theme.spacing(5),
   paddingTop: theme.spacing(10),
   paddingBottom: theme.spacing(20),
   marginTop: theme.spacing(4),
 }}

180-184: Consider extracting and formatting the image style object.

The inline style prop is hard to read and has inconsistent formatting. Consider extracting it to improve readability.

Apply this refactor:

- <img src={Placeholder} alt="Placeholder"
-   style={{width: "150px",
-   height:"auto",
-   marginTop: theme.spacing(4),
-   marginBottom:theme.spacing(4)}} />
+ <img
+   src={Placeholder}
+   alt="Placeholder"
+   style={{
+     width: "150px",
+     height: "auto",
+     marginTop: theme.spacing(4),
+     marginBottom: theme.spacing(4),
+   }}
+ />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2519ac8 and d7705ab.

📒 Files selected for processing (1)
  • Clients/src/presentation/components/Table/WithPlaceholder/index.tsx (2 hunks)
🔇 Additional comments (2)
Clients/src/presentation/components/Table/WithPlaceholder/index.tsx (2)

28-28: LGTM! Good choice switching to SVG format.

The switch from PNG to SVG for the placeholder image is a good improvement as SVGs are resolution-independent and typically smaller in file size.

Also applies to: 31-31


185-187: LGTM! Well-structured empty state message.

The Typography component is appropriately used with good styling choices for the empty state message.

Comment on lines +180 to +187
<img src={Placeholder} alt="Placeholder"
style={{width: "150px",
height:"auto",
marginTop: theme.spacing(4),
marginBottom:theme.spacing(4)}} />
<Typography variant="body2" color="text.secondary" style={{marginTop: theme.spacing(4)}}>
There is currently no data in this table
</Typography>
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider improving accessibility for the empty state.

The empty state could be more accessible to screen readers.

Apply these improvements:

- <img src={Placeholder} alt="Placeholder"
+ <img 
+   src={Placeholder}
+   alt="Empty table illustration"
    style={{
      width: "150px",
      height: "auto",
      marginTop: theme.spacing(4),
      marginBottom: theme.spacing(4),
    }}
  />
  <Typography
+   role="status"
+   aria-live="polite"
    variant="body2"
    color="text.secondary"
    style={{marginTop: theme.spacing(4)}}
  >
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<img src={Placeholder} alt="Placeholder"
style={{width: "150px",
height:"auto",
marginTop: theme.spacing(4),
marginBottom:theme.spacing(4)}} />
<Typography variant="body2" color="text.secondary" style={{marginTop: theme.spacing(4)}}>
There is currently no data in this table
</Typography>
<img
src={Placeholder}
alt="Empty table illustration"
style={{
width: "150px",
height: "auto",
marginTop: theme.spacing(4),
marginBottom: theme.spacing(4),
}}
/>
<Typography
role="status"
aria-live="polite"
variant="body2"
color="text.secondary"
style={{marginTop: theme.spacing(4)}}
>
There is currently no data in this table
</Typography>

@salmanja salmanja merged commit 59eccde into bluewave-labs:master Nov 22, 2024
1 check was pending
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.

2 participants