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

feat: add size prop to avatar component and update logo component for size handling #5684

Merged
merged 1 commit into from
Mar 8, 2025

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Mar 8, 2025

Description

修复LOGO组件的logoSize不起作用的问题;
avatar组件支持size属性设置尺寸

fix: #5651

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • 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
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Avatars can now be rendered in customizable sizes, enabling precise control over their dimensions.
    • Logos have been enhanced to support dynamic sizing, offering greater flexibility in display.

Copy link

changeset-bot bot commented Mar 8, 2025

⚠️ No Changeset found

Latest commit: da0f6d8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Mar 8, 2025

Walkthrough

This update enhances two UI components by introducing configurable sizing. The avatar component now accepts an optional size prop of type number, which dynamically adjusts its height and width through a computed rootStyle. Similarly, the logo component removes a fixed width class and adds a new :size binding using the logoSize prop. These changes increase the flexibility of the components by allowing their dimensions to be customized dynamically based on the provided properties.

Changes

File(s) Change Summary
packages/@core/ui-kit/.../avatar/avatar.vue
packages/@core/ui-kit/.../logo/logo.vue
Avatar: Added an optional size prop and a computed rootStyle to dynamically set equal height and width.
Logo: Removed fixed width class (w-8) and added a dynamic :size binding via the new logoSize prop.

Suggested reviewers

  • anncwb
  • vince292007

Poem

I’m a rabbit with a coding beat,
Hopping through changes oh-so-sweet,
New props for avatars and logos display,
Dynamic sizing leads the way,
In the world of code, I leap and sway,
Bound by style, I’ll always play!
🐇💻✨


📜 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 89d963c and da0f6d8.

📒 Files selected for processing (2)
  • packages/@core/ui-kit/shadcn-ui/src/components/avatar/avatar.vue (2 hunks)
  • packages/@core/ui-kit/shadcn-ui/src/components/logo/logo.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: Check (ubuntu-latest)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Lint (windows-latest)
🔇 Additional comments (4)
packages/@core/ui-kit/shadcn-ui/src/components/avatar/avatar.vue (3)

19-19: Good addition of the size property!

Adding this optional size property enhances the component's flexibility by allowing users to dynamically set custom dimensions.


37-44: Well-implemented computed style property.

The computed property is well structured with:

  • Proper validation to check if size is defined and greater than zero
  • Equal height and width values to maintain the avatar's aspect ratio
  • Clean fallback to an empty object when no size is provided

This implementation provides good defensive programming while maintaining component flexibility.


48-52:

❓ Verification inconclusive

Good container structure and style binding.

The containing div with style binding is well implemented. Consider adding a test to verify the style binding works as expected with various size values.


🏁 Script executed:

#!/bin/bash
# Check for any existing tests for the avatar component
fd -t f "avatar.*test|test.*avatar|avatar.*spec|spec.*avatar" --exec echo "Found test file: {}"

Length of output: 97


Please ensure that style binding is adequately covered by tests.
The container structure and style binding implementation in the avatar component looks solid. However, our automated search for existing tests (using the provided script) didn't return any results. This might indicate that there aren’t dedicated tests for verifying the style binding with different size values.

  • If tests exist in an alternative location or under a different naming convention, please verify manually that these cases are indeed covered.
  • Otherwise, please consider adding tests that check the component’s style binding across various size configurations.
packages/@core/ui-kit/shadcn-ui/src/components/logo/logo.vue (1)

55-56: Good implementation of size property binding.

This change correctly:

  1. Removes the fixed width class that would conflict with dynamic sizing
  2. Binds the logoSize property to the avatar's size property
  3. Maintains other important styling classes like "relative rounded-none bg-transparent"

This successfully addresses the issue mentioned in the PR objectives where the logoSize property wasn't functioning correctly.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@mynetfan mynetfan merged commit e2a577d into vbenjs:main Mar 8, 2025
14 checks passed
@mynetfan mynetfan deleted the fix/logo-size branch March 8, 2025 03:37
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.

Bug: logoSize设置未生效
1 participant