search

canonical / design-vanilla-framework

Design components for Vanilla Framework.
https://vanillaframework.io
GNU General Public License v3.0
62 stars 11 forks source link

New badge component - specs #455

Closed cristinadresch closed 2 years ago

rayito commented 2 years ago

New component specs doc

lyubomir-popov commented 2 years ago

LGTM, thanks @rayito.

ziheliu214 commented 2 years ago

@rayito sorry! Think the documentation needs slightly more work. Left comments in the doc, please let me know if you have any questions

ziheliu214 commented 2 years ago

@clagom Just checking, since this documentation is only about badges, will we have a new documentation on chips in the pipeline?

rayito commented 2 years ago

@rayito sorry! Think the documentation needs slightly more work. Left comments in the doc, please let me know if you have any questions

I agree with the comments, I didn't know the anatomy section was going to grow until I felt it needed explanations, so I guess it's better to describe the variants; although I don't think there are 3 variants.

The badge with less than 999 is not a design variant, it's just how it behaves according to the content. I think there are 2 variants as I commented in the doc: the one that shows large numbers as 999+ and the one that shows large numbers with a rounding plus a decimal unit prefix.

rayito commented 2 years ago

I have rewritten the doc considering @ziheliu214 's comments, please have a look.

Vanilla #455 - New badge component

cristinadresch commented 2 years ago

@elioqoshi can you have a look please?

elioqoshi commented 2 years ago

@rayito This generally looks good to me! I just have a small concern with rounding numbers up. So going from 1790 to 1800 for example. Would there be any instance where this would be problematic? I mean there might be cases where one should not overestimate a specific number, especially when it might be resource related (for example: if my allowance is 1800 machines and I have 1790, I still am able to have 10 more machines. If it shows like 1.8k currently, I might think I need a bigger allowance, no? Or am I reading too much into it?

Also, if this will go straight into discourse, we might avoid sentences like this in the documentation:

After a workshop to decide the future of the Label component, we made the following decisions:

elioqoshi commented 2 years ago

@rayito Let us know when you update the specs so we can +1 :)

rayito commented 2 years ago

@elioqoshi I added a paragraph in the When not to use section, please let me know if you would write it differently.

elioqoshi commented 2 years ago

LGTM!