-
Notifications
You must be signed in to change notification settings - Fork 2k
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
UI: Fill out the styleguide #4468
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had a quick look in the app, looks nice!
Couple of observations:
faker
might be nice here?- At first glance at least, seems like an awful lot of code to write. Is there anyway this could be done without having to write so much extra code?
TIL ember-cli-funnel
, would have been handy for me a few weeks back 😄
Could be. I opted for tailored data to make the examples more realistic.
Although there is a lot of code, there isn't a lot of boilerplate. There might possibly be ways to generate a styleguide from components, but it would be especially difficult to do without having typed parameters. Even if this code was entirely typed so appropriate values could be procedurally passed to components, I worry that it would have a lot of signal to noise. My gut says that even though this is a lot of code when presented with it all at once like this, it isn't unreasonable. Bear in mind that this is documentation for design and programming work that has already been done in a bespoke fashion. I'm open to suggestions on how to improve this, and I think this (or something like it) is critical to the success of a design system. |
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
The styleguide (only present in dev builds) is essentially a dictionary of every style, pattern, and component in the UI.
It has been around since day one, but it has never fully represented the full breadth of the app code...
...until now 🎉 🎉
Pages added
Having all of this styleguide code adds a non-trivial amount of weight to the compiled assets. Weight that can't even be utilized in production builds.
This PR now also filters styleguide-specific components out of production builds.
Here are some build stats:
Master branch
This branch, no filtering
This branch, with filtering
The numbers in raw are kinda hard to look at, so here are the actual deltas:
Size reduction from filtering out styleguide code:
Screenshot
It doesn't make sense to capture everything in a screenshot, but here's a preview: