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

Create AvatarGroup Component #5910

Closed
bmuenzenmeyer opened this issue Sep 29, 2023 · 4 comments · Fixed by #5916
Closed

Create AvatarGroup Component #5910

bmuenzenmeyer opened this issue Sep 29, 2023 · 4 comments · Fixed by #5916
Labels
website redesign Issue/PR part of the Node.js Website Redesign

Comments

@bmuenzenmeyer
Copy link
Collaborator

Create an AvatarGroup component using the new figma design (direct link).

This component is a group of multiple Avatars, with optional display of overflow.

Read more about the Node.js Website redesign


Before You Start...


Details

image

Not sure where to start breaking down the figma? Read this short guide

  • Create a new directory called AvatarGroup within the Common directory that contains all the new code.
  • Use the new tailwind color and typography system to assign properties. For example, the background of the overflow Avatar uses Neutral/100 in light mode per the figma.
  • Add a new dependency,@radix-ui/avatar, for the basic Avatar functionality. Follow the the dependency guide
  • After limit Avatars are provided, an overflow Avatar displaying +N should render, where N is the length of the avatar collection minus limit. Make sure the math is correct before, at, and past the limit.
  • Add a storybook story file components/Common/AvatarGroup/index.stories.tsx which exercises each of the component's states.

Suggested props include:

  • limit (integer, default 10): dictates total Avatars to render
  • avatars (object[]): that follows this general shape:
[
  {
    "imageUrl": "https://avatars.githubusercontent.com/u/298435?v=4",
    "href": "https://github.com/bmuenzenmeyer"
  },
  ...
]

There are 6 states to capture within styles and stories:

  • Light, under limit
  • Light, over limit
  • Light, at limit
  • Dark, under limit
  • Dark, over limit
  • Dark, at limit
@bmuenzenmeyer bmuenzenmeyer added the website redesign Issue/PR part of the Node.js Website Redesign label Sep 29, 2023
@bmuenzenmeyer bmuenzenmeyer moved this to 🔖 Ready in Website Redesign Sep 29, 2023
@AugustinMauroy
Copy link
Member

Can I work on this ?

@bmuenzenmeyer
Copy link
Collaborator Author

you bet!

@ovflowd ovflowd moved this from 🔖 Ready to 🏗 In progress in Website Redesign Sep 29, 2023
@AugustinMauroy AugustinMauroy linked a pull request Sep 29, 2023 that will close this issue
5 tasks
@ovflowd ovflowd moved this from 🏗 In progress to 👀 In review in Website Redesign Oct 1, 2023
@shishiro26
Copy link

@ovflowd if this issue still open I would like to work on this. can u please assign this to me

@ovflowd
Copy link
Member

ovflowd commented Oct 9, 2023

@ovflowd if this issue still open I would like to work on this. can u please assign this to me

If you look with attention, you'll see this issue state is "In Review" and there's already an open PR.

@bmuenzenmeyer bmuenzenmeyer moved this from 👀 In review to ✅ Done in Website Redesign Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website redesign Issue/PR part of the Node.js Website Redesign
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants