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(web): Overview Links, stop using Image component #17278

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Dec 18, 2024

Overview Links, stop using Image component

What

  • The Image component is way too big for mobile screens (see screenshot below)

Screenshots / Gifs

Before

Screenshot 2024-12-18 at 10 56 16

After

Screenshot 2024-12-18 at 10 55 22

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Simplified image rendering in the Overview Links component by using standard HTML <img> tags.
  • Bug Fixes

    • Improved conditional rendering logic for images to ensure proper display only when an image URL exists.

@RunarVestmann RunarVestmann added deprecated:automerge (Disabled) Merge this PR as soon as all checks pass deploy-feature Deploys features to dev labels Dec 18, 2024
@RunarVestmann RunarVestmann requested a review from a team as a code owner December 18, 2024 10:56
Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Walkthrough

The pull request modifies the OverviewLinksSlice component in the OverviewLinks.tsx file, specifically changing the image rendering approach. The previous implementation used the Image component from the @island.is/island-ui/contentful package, which has been replaced with a standard HTML <img> tag. The change simplifies the image rendering logic by directly using the image URL and adding a conditional check to ensure the image URL exists before rendering.

Changes

File Change Summary
apps/web/components/Organization/Slice/OverviewLinks/OverviewLinks.tsx Replaced Image component with native <img> tag, added conditional rendering check for image URL

Possibly related PRs

Suggested reviewers

  • mannipje

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.

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

🧹 Nitpick comments (1)
apps/web/components/Organization/Slice/OverviewLinks/OverviewLinks.tsx (1)

Line range hint 3-3: Remove unused import

The Image component is imported but no longer used after the changes.

-import { Image, SliceType } from '@island.is/island-ui/contentful'
+import { SliceType } from '@island.is/island-ui/contentful'
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c7ec7a and 47ffc32.

📒 Files selected for processing (1)
  • apps/web/components/Organization/Slice/OverviewLinks/OverviewLinks.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/components/Organization/Slice/OverviewLinks/OverviewLinks.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (1)
apps/web/components/Organization/Slice/OverviewLinks/OverviewLinks.tsx (1)

58-69: Verify the impact on mobile devices

Since the PR's main objective is to fix mobile rendering issues, we should verify that the new implementation resolves the original problem.

Let's check for any related mobile-specific styles or components:

✅ Verification successful

Mobile layout implementation appears correct

The code implements a responsive grid layout that properly handles mobile devices:

  • On mobile (first breakpoint), both image and content columns span full width ('8/8')
  • On larger screens, they split into appropriate ratios:
    • Image column: ['8/8', '3/8', '4/8', '3/8']
    • Content column: ['8/8', '5/8', '4/8', '5/8']

This pattern is consistent with other responsive layouts in the codebase, and the implementation follows the established grid system conventions used across the organization's components.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for mobile-specific styles or responsive patterns in related files
rg -t tsx -t css "(\[.*'8/8'.*\]|@media.*mobile|@media.*\(max-width)" apps/web/components/Organization/

Length of output: 139


Script:

#!/bin/bash
# Search for mobile-specific styles or responsive patterns in related files, fixing the file type
rg "(\[.*'8/8'.*\]|@media.*mobile|@media.*\(max-width)" apps/web/components/Organization/

# Also search for GridColumn usage to understand the responsive layout
rg -A 3 "GridColumn" apps/web/components/Organization/Slice/OverviewLinks/

Length of output: 3577

Copy link

codecov bot commented Dec 18, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 35.68%. Comparing base (7bc2a59) to head (7bb1541).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...Organization/Slice/OverviewLinks/OverviewLinks.tsx 0.00% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17278      +/-   ##
==========================================
- Coverage   35.69%   35.68%   -0.02%     
==========================================
  Files        6922     6952      +30     
  Lines      148522   148646     +124     
  Branches    42417    42447      +30     
==========================================
+ Hits        53008    53037      +29     
- Misses      95514    95609      +95     
Flag Coverage Δ
api 3.33% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.41% <ø> (ø)
application-system-api 38.75% <ø> (+0.01%) ⬆️
application-template-api-modules 27.70% <ø> (+0.02%) ⬆️
cms 0.39% <ø> (ø)
cms-translations 38.74% <ø> (ø)
contentful-apps 4.71% <ø> (ø)
judicial-system-api 20.21% <ø> (ø)
judicial-system-backend 55.90% <ø> (-0.02%) ⬇️
services-user-notification 46.53% <ø> (ø)
web 2.40% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...Organization/Slice/OverviewLinks/OverviewLinks.tsx 0.00% <0.00%> (ø)

... and 55 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7bc2a59...7bb1541. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

All test runs 9c7032e 🔗

11 Total Test Services: 0 Failed, 10 Passed
➡️ Test Sessions change in coverage: 29 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.51s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 10.34s 1 no change Link
api-domains-communications 0 0 0 5 0 30.67s 1 no change Link
api-domains-license-service 0 0 0 0 0 477.98ms 1 no change Link
application-system-api 0 0 0 46 0 2m 20.99s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 34.84s 1 no change Link
cms-translations 0 0 0 3 0 29.14s 1 no change Link
judicial-system-api 0 0 0 61 0 5.3s 1 no change Link
judicial-system-backend 0 0 0 21129 0 23m 8.98s 1 no change Link
services-user-notification 0 0 0 51 0 1m 21.59s 1 no change Link

Copy link
Contributor

Affected services are: web,
Feature deployment of your services will begin shortly. Your feature will be accessible here:
https://fixweb-overview-links-image-url-beta.dev01.devland.is/

Deployed services: web.
Excluded services: ``

@kodiakhq kodiakhq bot merged commit 62ccd49 into main Dec 19, 2024
92 checks passed
@kodiakhq kodiakhq bot deleted the fix/web-overview-links-image-url branch December 19, 2024 11:34
@RunarVestmann RunarVestmann removed the deploy-feature Deploys features to dev label Dec 19, 2024
RunarVestmann added a commit that referenced this pull request Dec 19, 2024
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
kodiakhq bot added a commit that referenced this pull request Dec 19, 2024
…#17296)

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants