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

Polish: VaBadge #3625

Open
8 tasks
Tracked by #3705
asvae opened this issue Jul 20, 2023 · 0 comments
Open
8 tasks
Tracked by #3705

Polish: VaBadge #3625

asvae opened this issue Jul 20, 2023 · 0 comments
Labels
d3: medium No cheats. Monsters a bit faster. docs packages/docs v2: nice to have This will make Vuestic feel better

Comments

@asvae
Copy link
Member

asvae commented Jul 20, 2023

We did badge improvements (#3246), but there are a couple of things not covered by issue and PRs:

Component

  • We need a floating prop (see Quasar). Right now - when you use slot - it's floating, and when you don't - it's not. That looks arbitrary to me.
  • Demos are not in great shape (see Stories rework: VaBadge #3647).

Docs

  • offset prop is extremely poorly documented, we need to document all usage cases (single number, array, strings, rems/percents etc)
  • It's not possible to set different border color as it's getting overriden by :styles. We either want to dispose of borders or most probably make them operational.
  • Default example makes no sense for docs (it makes sense for demos though). I suggest removing it for now, and later on - we can have either rich example or playground instead.
  • Right now in examples to make badge work with icon and avatar components - we use offset. That's not great - these components should work properly with each other out of the box. It could be achieved by either some styling tweak when particular component is detected or by changing default behaviour of badge.
  • placement prop description (in table) should have full information about the prop usage. Example could have only high level description.
  • preset prop description should have link to preset usage page (also apply to other pages - prop should reuse the same values)
@asvae asvae added docs packages/docs v2: nice to have This will make Vuestic feel better d2: easy Recomended mode for new, but mature players d3: medium No cheats. Monsters a bit faster. and removed d2: easy Recomended mode for new, but mature players labels Jul 20, 2023
This was referenced Jul 20, 2023
@asvae asvae changed the title Badge docs improvements VaBadge improvements Jul 31, 2023
This was referenced Aug 15, 2023
@asvae asvae changed the title VaBadge improvements Polish: VaBadge Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d3: medium No cheats. Monsters a bit faster. docs packages/docs v2: nice to have This will make Vuestic feel better
Projects
None yet
Development

No branches or pull requests

1 participant