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

JNG-6002 fix logo dimensions #483

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

noherczeg
Copy link
Contributor

@noherczeg noherczeg commented Nov 4, 2024

BugJNG-6002 Fix application logo dimensions

Copy link

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes introduce modifications to the DrawerHeader and LogoMain components in the judo-ui-react project. In DrawerHeader, a new paddingRight property is added to the sx prop to enhance styling based on the component's state. In LogoMain, the style attribute of the image is updated by removing the height property and adding a maxHeight property, affecting the image's display constraints. Overall, these changes focus on improving layout responsiveness and image rendering.

Changes

File Path Change Summary
src/layout/Drawer/DrawerHeader.tsx.hbs Added paddingRight to sx prop in DrawerHeaderStyled, conditionally set based on isHorizontal and open states.
src/layout/logo/LogoMain.tsx.hbs Modified <img> style by removing height and adding maxHeight, changing display constraints.

Poem

In the drawer where shadows play,
Padding right makes a grand display.
Logos shine with heights anew,
Maxed out, they dance in view.
Oh, what joy these changes bring,
A rabbit's cheer for styling's spring! 🐇✨


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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

@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 (2)
judo-ui-react/src/main/resources/actor/src/layout/logo/LogoMain.tsx.hbs (1)

Line range hint 5-7: Clean up unused code.

The reverse prop and spread operator (...others) are not being used. Consider removing them if they're no longer needed. Also, the commented theme code suggests an incomplete dark/light mode implementation.

-export const LogoMain = ({ reverse, ...others }: { reverse?: boolean }) => {
-  // const theme = useTheme(); // we an use theme in the future to detect light/dark modes
+export const LogoMain = () => {
   const logoProps = useLogoProps();
judo-ui-react/src/main/resources/actor/src/layout/Drawer/DrawerHeader.tsx.hbs (1)

39-40: LGTM! Symmetrical padding improves visual balance.

The addition of paddingRight that mirrors the paddingLeft logic creates better visual symmetry in both horizontal and vertical orientations. This change complements the logo dimension fixes by ensuring consistent spacing around the logo.

Consider extracting these common padding values into theme spacing tokens or constants if they're used across multiple components, making it easier to maintain consistent spacing throughout the application.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8f76da2 and d1c94d0.

📒 Files selected for processing (2)
  • judo-ui-react/src/main/resources/actor/src/layout/Drawer/DrawerHeader.tsx.hbs (1 hunks)
  • judo-ui-react/src/main/resources/actor/src/layout/logo/LogoMain.tsx.hbs (1 hunks)
🔇 Additional comments (1)
judo-ui-react/src/main/resources/actor/src/layout/logo/LogoMain.tsx.hbs (1)

10-10: LGTM! The maxHeight change prevents logo distortion.

The switch from height to maxHeight is a good fix as it maintains the logo's aspect ratio while preventing overflow.

@@ -7,6 +7,6 @@ export const LogoMain = ({ reverse, ...others }: { reverse?: boolean }) => {
const logoProps = useLogoProps();

return (
<img src={logoProps.imgSrc} style={ { height: '100%', maxWidth: '100%' } } />
<img src={logoProps.imgSrc} style={ { maxHeight: '100%', maxWidth: '100%' } } />
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add alt text for accessibility.

The image lacks an alt attribute which is essential for accessibility. Screen readers need this to provide context to users.

-    <img src={logoProps.imgSrc} style={ { maxHeight: '100%', maxWidth: '100%' } } />
+    <img 
+      src={logoProps.imgSrc} 
+      alt="Company Logo"
+      style={ { maxHeight: '100%', maxWidth: '100%' } } 
+    />
📝 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={logoProps.imgSrc} style={ { maxHeight: '100%', maxWidth: '100%' } } />
<img
src={logoProps.imgSrc}
alt="Company Logo"
style={ { maxHeight: '100%', maxWidth: '100%' } }
/>

🛠️ Refactor suggestion

Add error handling for image load failures.

Consider adding an onError handler to gracefully handle cases where the logo fails to load.

-    <img src={logoProps.imgSrc} style={ { maxHeight: '100%', maxWidth: '100%' } } />
+    <img 
+      src={logoProps.imgSrc} 
+      style={ { maxHeight: '100%', maxWidth: '100%' } }
+      onError={(e) => {
+        e.currentTarget.style.display = 'none';
+        console.error('Failed to load logo:', logoProps.imgSrc);
+      }}
+    />
📝 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={logoProps.imgSrc} style={ { maxHeight: '100%', maxWidth: '100%' } } />
<img
src={logoProps.imgSrc}
style={ { maxHeight: '100%', maxWidth: '100%' } }
onError={(e) => {
e.currentTarget.style.display = 'none';
console.error('Failed to load logo:', logoProps.imgSrc);
}}
/>

@noherczeg noherczeg merged commit b2be7d9 into develop Nov 4, 2024
3 checks passed
@noherczeg noherczeg deleted the bugfix/JNG-6002-fix-logo-dimensions branch November 4, 2024 18:15
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.

3 participants