feat(Avatar/AvatarGroup): add color prop#6405
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughIntroduces a Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/content/docs/2.components/avatar.md`:
- Line 103: Update the "### Color" heading in
docs/content/docs/2.components/avatar.md to include the pending-release badge by
appending :badge{label="Soon" class="align-text-top"} to the heading (i.e.,
modify the "### Color" heading line so it reads with the badge token) so the
docs indicate this feature ships in the next npm release.
In `@src/runtime/components/AvatarGroup.vue`:
- Around line 19-26: The JSDoc for "The maximum number of avatars to display."
was left above the color prop and thus attached to color; move or duplicate the
comment so that max has its own JSDoc block and color retains its `@defaultValue`
'neutral'. Concretely, create a separate JSDoc immediately above the max prop
(max?: number | string) containing "The maximum number of avatars to display."
and ensure the existing JSDoc with "@defaultValue 'neutral'" remains directly
above the color prop declaration (color?: AvatarGroup['variants']['color']) so
each prop has correct documentation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 590717a8-bc11-4df6-a831-5182350924fb
⛔ Files ignored due to path filters (12)
test/components/__snapshots__/Avatar-vue.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/Avatar.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/AvatarGroup-vue.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/AvatarGroup.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/ChatMessages-vue.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/ChatMessages.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/Empty-vue.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/Empty.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/FileUpload-vue.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/FileUpload.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/User-vue.spec.ts.snapis excluded by!**/*.snaptest/components/__snapshots__/User.spec.ts.snapis excluded by!**/*.snap
📒 Files selected for processing (8)
docs/content/docs/2.components/avatar.mdplaygrounds/nuxt/app/pages/components/avatar.vuesrc/runtime/components/Avatar.vuesrc/runtime/components/AvatarGroup.vuesrc/runtime/composables/useAvatarGroup.tssrc/theme/avatar-group.tssrc/theme/avatar.tstest/components/Avatar.spec.ts
commit: |
color props
color propscolor prop
🔗 Linked issue
❓ Type of change
📚 Description
📝 Checklist