Skip to content

Updated background preview image TASK-7883#622

Merged
kushagrasarathe merged 5 commits intodevelopfrom
feature/change-bg-preview
Jan 20, 2025
Merged

Updated background preview image TASK-7883#622
kushagrasarathe merged 5 commits intodevelopfrom
feature/change-bg-preview

Conversation

@beetrootw
Copy link
Copy Markdown

@beetrootw beetrootw commented Jan 12, 2025

Updated the bg preview image

Summary by CodeRabbit

  • New Features
    • Added a new social preview background image to the application.
    • Introduced a new export for the social preview background image to enhance accessibility.
  • Refactor
    • Updated the logic for constructing the background image URL in the link preview component for improved flexibility based on the environment.

@vercel
Copy link
Copy Markdown

vercel bot commented Jan 12, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
peanut-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 9:34am

@notion-workspace
Copy link
Copy Markdown

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 12, 2025

Walkthrough

This pull request introduces a new export SOCIAL_PREVIEW_BG from the social previews assets and updates the LinkPreview component to modify the logic for constructing the background image URL. The change allows the URL to be determined based on the presence of the NEXT_PUBLIC_VERCEL_URL environment variable, enhancing flexibility in image sourcing.

Changes

File Change Summary
src/assets/social-previews/index.ts Added export of SOCIAL_PREVIEW_BG from social-preview.png
src/components/Global/ImageGeneration/LinkPreview.tsx Updated logic for background image URL construction based on NEXT_PUBLIC_VERCEL_URL or fallback to NEXT_PUBLIC_BASE_URL

Suggested reviewers

  • Hugo0

Poem

🐰 A rabbit's tale of preview delight,
Static imports now shine so bright!
From env vars to a simple source,
Our background image finds its course.
Hop, hop, hooray for cleaner code! 🖼️


📜 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 3fb67b8 and d32d633.

⛔ Files ignored due to path filters (1)
  • public/social-preview-bg.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • src/components/Global/ImageGeneration/LinkPreview.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Global/ImageGeneration/LinkPreview.tsx

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.

Copy link
Copy Markdown
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 (1)
src/components/Global/ImageGeneration/LinkPreview.tsx (1)

Line range hint 53-61: Consider optimizing image loading and accessibility.

While the implementation is correct, consider these improvements:

  1. Use Next.js Image component for automatic optimization
  2. Add a more descriptive alt text for better accessibility

Example implementation:

-            <img
-                src={SOCIAL_PREVIEW_BG.src}
-                alt="Background"
-                style={{
-                    position: 'absolute',
-                    top: 0,
-                    left: 0,
-                    width: '100%',
-                    height: '100%',
-                    objectFit: 'cover',
-                }}
-            />
+            <Image
+                src={SOCIAL_PREVIEW_BG.src}
+                alt="Peanut Protocol link preview background"
+                fill
+                priority
+                style={{ objectFit: 'cover' }}
+            />
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f4c9f0 and a486ad5.

⛔ Files ignored due to path filters (3)
  • public/metadata-img.png is excluded by !**/*.png
  • public/preview-bg.png is excluded by !**/*.png
  • src/assets/social-previews/social-preview.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • src/assets/social-previews/index.ts (1 hunks)
  • src/components/Global/ImageGeneration/LinkPreview.tsx (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/assets/social-previews/index.ts
🔇 Additional comments (2)
src/components/Global/ImageGeneration/LinkPreview.tsx (2)

1-1: Good improvement using static import!

Moving from dynamic URL construction to static import improves reliability and build-time optimization.


1-1: Verify the background image integration.

Let's ensure the new background image is properly integrated:

✅ Verification successful

Background image integration is properly configured

The image file exists at the correct location and is being used appropriately in the LinkPreview component.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the background image exists and find other potential usages
echo "Checking if background image exists..."
fd -e png -e jpg -e jpeg -e gif -e webp . src/assets/social-previews

echo "Finding other usages of SOCIAL_PREVIEW_BG..."
rg "SOCIAL_PREVIEW_BG" --type ts --type tsx

Length of output: 374


Script:

#!/bin/bash
# Check the content of the social-previews file and find usages
echo "Checking the social-previews export..."
cat src/assets/social-previews/index.ts

echo -e "\nFinding usages of SOCIAL_PREVIEW_BG..."
rg "SOCIAL_PREVIEW_BG" -t typescript -t typescriptreact

Length of output: 380


Script:

#!/bin/bash
# Find usages with simple file extensions
echo "Finding usages of SOCIAL_PREVIEW_BG..."
rg "SOCIAL_PREVIEW_BG" -g "*.ts" -g "*.tsx"

Length of output: 447

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