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

fix: move icon to be next to label if present in StudioDisplayTile #14451

Merged
merged 3 commits into from
Jan 21, 2025

Conversation

standeren
Copy link
Contributor

@standeren standeren commented Jan 17, 2025

Description

move icon to be next to label if precent for StudioDisplayTile.

This is how it looks for all cases:

Prefix icon and lock
Skjermbilde 2025-01-17 kl  16 00 28

only prefix icon
Skjermbilde 2025-01-17 kl  16 00 41

Only lock icon
Skjermbilde 2025-01-17 kl  16 01 09

No icons
Skjermbilde 2025-01-17 kl  16 01 27

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)

Summary by CodeRabbit

  • UI/UX Improvements
    • Updated the display tile component's layout.
    • Refined icon and label positioning within the component.
    • Simplified class name assignment for display tiles.
    • Transitioned label layout to a flexbox model for better alignment and spacing.

@standeren standeren added ux UX help needed skip-releasenotes Issues that do not make sense to list in our release notes frontend team/studio-domain1 skip-documentation Issues where updating documentation is not relevant labels Jan 17, 2025
Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

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

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.

frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.module.css

Oops! Something went wrong! :(

ESLint: 8.57.1

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

(The package "eslint-plugin-storybook" was not found when loaded as a Node module from the directory "/frontend/libs/studio-components".)

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

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

The plugin "eslint-plugin-storybook" was referenced from the config file in "frontend/libs/studio-components/.eslintrc.js".

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

📝 Walkthrough

Walkthrough

The pull request modifies the StudioDisplayTile component by removing the .prefixIcon CSS class and updating the .label class to use a flexbox layout. The changes involve restructuring how icons are rendered within the component, moving the icon inside the Label component and simplifying the class name assignment. These modifications alter the visual and structural approach to displaying icons and labels in the component.

Changes

File Change Summary
frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.module.css - Removed .prefixIcon class
- Updated .label class to use flexbox with display: flex, align-items: center, and gap: var(--fds-spacing-1)
frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.tsx - Removed hasPrefixIcon variable
- Simplified className construction
- Moved icon rendering inside Label component
frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.test.tsx - Removed two test cases related to the prefix icon class name assignment

Possibly related PRs

Suggested labels

area/ui-editor, quality/testing

Suggested reviewers

  • framitdavid
  • ErlingHauan

📜 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 cbc68a4 and f92e6bf.

📒 Files selected for processing (3)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.module.css (1 hunks)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.test.tsx (0 hunks)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.tsx (1 hunks)
💤 Files with no reviewable changes (1)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.test.tsx
🚧 Files skipped from review as they are similar to previous changes (2)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.tsx
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.module.css
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Typechecking and linting
  • GitHub Check: Testing
  • GitHub Check: CodeQL

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@github-actions github-actions bot added the solution/studio/designer Issues related to the Altinn Studio Designer solution. label Jan 17, 2025
@standeren standeren linked an issue Jan 17, 2025 that may be closed by this pull request
@standeren standeren changed the title fix: move icon to be next to label if precent fix: move icon to be next to label if precent in StudioDisplayTile Jan 17, 2025
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

🧹 Nitpick comments (2)
frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.module.css (1)

13-15: LGTM! Consider adding focus styles for accessibility.

The flexbox layout is a good choice for aligning the icon with the label. The use of CSS variables for spacing maintains consistency with the design system.

Consider adding focus styles to improve accessibility when navigating with keyboard:

.label {
  display: flex;
  align-items: center;
  gap: var(--fds-spacing-1);
  font-weight: 500;
+ &:focus-within {
+   outline: 2px solid var(--fds-focus-border-color);
+   outline-offset: 2px;
+ }
}
frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.tsx (1)

32-33: LGTM! Consider prop for icon spacing.

The icon placement inside Label works well with the flexbox layout.

Consider adding an optional prop to control icon spacing for cases where different gaps might be needed:

 export type StudioDisplayTileProps = {
   icon?: React.ReactNode;
   label: string;
   value: string;
   showPadlock?: boolean;
+  iconSpacing?: 'small' | 'medium' | 'large';
 } & HTMLAttributes<HTMLDivElement>;

Then use it in the Label's style:

 <Label 
   size='small' 
-  className={classes.label}
+  className={cn(classes.label, {
+    [classes.iconSpacingSmall]: iconSpacing === 'small',
+    [classes.iconSpacingMedium]: iconSpacing === 'medium',
+    [classes.iconSpacingLarge]: iconSpacing === 'large',
+  })}
 >
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5dda0fd and cbc68a4.

📒 Files selected for processing (2)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.module.css (1 hunks)
  • frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Testing
🔇 Additional comments (1)
frontend/libs/studio-components/src/components/StudioDisplayTile/StudioDisplayTile.tsx (1)

26-26: LGTM! Clean class name assignment.

The simplified className assignment improves code readability.

@standeren standeren force-pushed the fix-studio-display-tile-icon-placement branch from cbc68a4 to f92e6bf Compare January 17, 2025 15:28
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.69%. Comparing base (c07d821) to head (cf4d505).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14451      +/-   ##
==========================================
- Coverage   95.69%   95.69%   -0.01%     
==========================================
  Files        1889     1889              
  Lines       24573    24572       -1     
  Branches     2822     2821       -1     
==========================================
- Hits        23515    23514       -1     
  Misses        799      799              
  Partials      259      259              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@TomasEng TomasEng changed the title fix: move icon to be next to label if precent in StudioDisplayTile fix: move icon to be next to label if present in StudioDisplayTile Jan 20, 2025
@TomasEng TomasEng self-assigned this Jan 20, 2025
@TomasEng TomasEng removed their assignment Jan 20, 2025
@ErlingHauan ErlingHauan self-assigned this Jan 21, 2025
Copy link
Contributor

@ErlingHauan ErlingHauan left a comment

Choose a reason for hiding this comment

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

Test OK 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend skip-documentation Issues where updating documentation is not relevant skip-releasenotes Issues that do not make sense to list in our release notes solution/studio/designer Issues related to the Altinn Studio Designer solution. team/studio-domain1 ux UX help needed
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Improve design of Studio components
3 participants