web-components
web-components copied to clipboard
vaadin
Consider moving remaining packages with `vaadin-` prefix
Motivation
This is a follow-up from #1992 as per https://github.com/vaadin/web-components/issues/1992#issuecomment-943194123
The following packages have not been moved in Vaadin 22:
@vaadin/vaadin-lumo-styles@vaadin/vaadin-material-styles@vaadin/vaadin-overlay@vaadin/vaadin-list-mixin@vaadin/vaadin-themable-mixin
Proposed solution
We need to agree on the new package names and implement this change in V23 while also deprecating old packages.
This way we can consider removing old aliases in Vaadin 24 for all the vaadin- prefixed packages.
Regarding Lumo and Material, I suggest the following renamed packages:
@vaadin/lumo@vaadin/material
I believe those names are well-established and known among users, and it would be a small quality-of-life improvement for any developers importing packages manually, for example import { typography } from '@vaadin/lumo';
From @lkraav (https://github.com/vaadin/web-components/issues/1992#issuecomment-943176753):
Hm, those names really don't describe what these packages are about?
Is something like @vaadin/lumo-theme better in that sense?
I would say no. Those packages aren't really "themes" either. They provide "design tokens", utility classes, and shared component theme mixins. Also, I don't think the package name needs to describe what it is about, although it would be an additional benefit.
From @web-padawan (https://github.com/vaadin/web-components/issues/1992#issuecomment-943194123)
In the light of potential product changes (like promoting Lumo Design System as a standalone product which is being discussed) we probably should consider something like @vaadin/lumo-core or what Leho suggests.
Hmm, right. In that light I would assume it would be more like @lumo/foundation, or maybe even split up as @lumo/color, @lumo/typography. Because shouldn't the components then also be @lumo/button etc.?
Both @lumo/foundation and @lumo/design-tokens make sense. But I guess the latter could be reserved for JSON files like those that can be generated by Figma Design Tokens according to W3C Design Tokens Format draft.
Because shouldn't the components then also be @lumo/button etc.?
Let's discuss it when we have more clear plans, e.g. whether we need other GitHub organization for Lumo etc.
Updated the original issue description as @vaadin/vaadin-overlay has been moved to @vaadin/overlay.
We might want to get rid of @vaadin/vaadin-list-mixin as well - maybe merge it to @vaadin/list-box.
Updated the issue description as @vaadin/vaadin-list-mixin is now removed and merged to @vaadin/component-base.