feat(screens): initialise package #4
Conversation
saulhardman
force-pushed
the
1-screens
branch
from
bafec4f to
2e961b4
Compare
- @limbo-works/screens@0.0.1-alpha.0
|
|
||
| const { breakpoints, screens } = configure([ | ||
| { value: 375, max: true }, | ||
| { value: 768, max: true }, |
There was a problem hiding this comment.
Could we name this more explicitly? max could be confused(by me) to be something else.
"includeMaxWidth" or maybe "includeMaxScreen" since breakpoints always has both (minor)
| breakpoints: { | ||
| ...breakpoints, | ||
|
|
||
| [`${px}`]: { px, em, min, max }, |
There was a problem hiding this comment.
breakpoints always include max. I think this is fine, as it'll be used with js and we might need this without a css breakpoint. (very minor)
|
|
||
| const { default: configure } = require('@limbo-works/screens'); | ||
|
|
||
| const { breakpoints, screens } = configure([ |
There was a problem hiding this comment.
breakpoints and screens can be a bit confusing for people not familiar with tailwind screens. This can be alright as long as the docs show an example. (minor)
There was a problem hiding this comment.
Wrote a comment on #1, but much to the same point - maybe naming of properties should be more explicit, like twScreens or something similar as suggested on the issue?
Don't know if breakpoints should be renamed to breakpointData or rawBreakpointData or something like that as well, or if breakpoints covers it well enough (very minor). But the tailwind specification would at the very least be nice.
But yeah, a lot can be explained through documentation as well. Though it will at to code readability, which is nice.
|
|
||
| ## Installation | ||
|
|
||
| Before installing the package, it's necessary to configure NPM with a GitHub |
There was a problem hiding this comment.
Question: Will our freelancers be able to do this?
There was a problem hiding this comment.
I've added my notes additive to @tfjordside's - but I also approve as is, though it could be worth updating based on the feedback.
Example usage: https://github.com/limbo-works/Empirical-Website-Shop-Umbraco-8/pull/367
1 place to configure both
screensandbreakpoints(screens are for TailwindCSS and breakpoints are for use throughout the JavaScript codebase).Closes #1