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

Website: Animated logo #974

Merged
merged 5 commits into from
Dec 10, 2024
Merged

Website: Animated logo #974

merged 5 commits into from
Dec 10, 2024

Conversation

dnhn
Copy link
Member

@dnhn dnhn commented Dec 6, 2024

Resolve #743

Implemented the animated logo. The player is configured to run once at the beginning but includes a loop option if you prefer.

Summary by CodeRabbit

  • New Features

    • Introduced an animated logo component (SIAnimatedLogo) that enhances the visual appeal of the website's navigation.
    • Added a new animation file for the logo, providing a dynamic visual experience.
  • Bug Fixes

    • Replaced the static logo with the animated version in both mobile and desktop navigation components, ensuring a consistent branding experience.
  • Chores

    • Added a new dependency for the animated logo functionality (@lottiefiles/react-lottie-player).

Copy link

vercel bot commented Dec 6, 2024

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

Name Status Preview Comments Updated (UTC)
public ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2024 4:54am

Copy link

vercel bot commented Dec 6, 2024

@dnhn is attempting to deploy a commit to the Social Income Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Dec 6, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request introduce a new animated logo feature to the website. A new dependency, @lottiefiles/react-lottie-player, is added to handle Lottie animations. A new React component, SIAnimatedLogo, is created to utilize this library and display an animated logo defined in a new JSON file, si-logo-animation.json. The existing logo in the navigation components is replaced with this animated logo, while maintaining the overall functionality of the navigation.

Changes

File Change Summary
website/package.json Added dependency @lottiefiles/react-lottie-player with version ^3.5.4.
website/src/components/logos/si-animated-logo.tsx Introduced new component SIAnimatedLogo that uses the Lottie player to display an animated logo.
website/src/components/logos/si-logo-animation.json Added new animation JSON file defining the logo animation.
website/src/components/navbar/navbar-client.tsx Replaced SILogo with SIAnimatedLogo in both MobileNavigation and DesktopNavigation components.

Assessment against linked issues

Objective Addressed Explanation
Implement animated logo (Issue #743)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5d158aa and 1cfed3e.

📒 Files selected for processing (1)
  • website/src/components/navbar/navbar-client.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/src/components/navbar/navbar-client.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 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)
website/src/components/logos/si-animated-logo.tsx (1)

7-9: Consider lazy loading the animation file.

For better initial page load performance, consider lazy loading the animation JSON file.

-import file from './si-logo-animation.json';
+const file = () => import('./si-logo-animation.json').then(module => module.default);

 export function SIAnimatedLogo({ className, ...props }: HTMLAttributes<HTMLDivElement>) {
-	return <Player src={file} autoplay keepLastFrame className={twMerge('[&>svg]:!w-auto', className)} {...props} />;
+	return <Player src={typeof file === 'function' ? file : undefined} autoplay keepLastFrame className={twMerge('[&>svg]:!w-auto', className)} {...props} />;
 }
website/src/components/logos/si-logo-animation.json (1)

1-1: Consider optimizing the animation configuration.

The current animation settings might impact performance:

  1. Frame rate of 60fps might be excessive for a logo animation
  2. Large dimensions (2300x248) could be reduced

Consider:

  • Reducing frame rate to 30fps
  • Optimizing dimensions if the logo is displayed smaller
  • Using a tool like lottie-optimizer to reduce file size
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 43c070f and 425e18c.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • website/package.json (1 hunks)
  • website/src/components/logos/si-animated-logo.tsx (1 hunks)
  • website/src/components/logos/si-logo-animation.json (1 hunks)
  • website/src/components/navbar/navbar-client.tsx (3 hunks)
🔇 Additional comments (3)
website/package.json (1)

23-23: Verify the Lottie player dependency version.

Let's check for any security advisories or newer versions of @lottiefiles/react-lottie-player.

✅ Verification successful

The Lottie player dependency is using the latest version with no known vulnerabilities

The package @lottiefiles/[email protected] is the most recent version available and has no security advisories reported.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check PyPI for latest versions and security advisories
curl -s https://registry.npmjs.org/@lottiefiles/react-lottie-player | jq '.versions | keys[]' | sort -V | tail -n 5

# Check for known vulnerabilities
npm audit --json @lottiefiles/react-lottie-player@^3.5.4 2>/dev/null | jq '.advisories'

Length of output: 254

website/src/components/navbar/navbar-client.tsx (2)

6-6: LGTM!

Import statement is correctly placed with other logo-related imports.


270-272: LGTM!

The implementation correctly handles responsive behavior:

  • Shows animated logo on larger screens
  • Falls back to icon on smaller screens

@ssandino
Copy link
Member

ssandino commented Dec 6, 2024

Looking good @dnhn! Testing on different screens:

  • Large: animation of logo works well ✅
  • Medium: not applicable (as we show only icon) ✅
  • Small: animation is not playing (see video from iPhone 14 test)
ScreenRecording_12-06-2024.23-59-23_1.mp4

@ssandino ssandino added the website Issues concerning Website label Dec 6, 2024
@dnhn
Copy link
Member Author

dnhn commented Dec 7, 2024

Added to mobile!

Looking good @dnhn! Testing on different screens:

@ssandino
Copy link
Member

ssandino commented Dec 7, 2024

Looks now good on mobile too

Copy link
Contributor

@mkue mkue left a comment

Choose a reason for hiding this comment

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

Nice! This works great 🙌🏼 Thank you for your contribution :)

@mkue mkue merged commit c68376d into socialincome-san:main Dec 10, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website Issues concerning Website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Website Feature]: Implement animated logo
3 participants