-
Notifications
You must be signed in to change notification settings - Fork 406
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
Feature/uikit refactor #840
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this might still be a WIP, as changes do not always get reflected. either a bug here or in live-server?
BREAKING CHANGE: change `version()` to return a string representation of the version, removing `v()`
Just stopping in to say hello, as this looks fun and interesting! |
This was referenced Apr 27, 2018
8 tasks
antonia-rose
pushed a commit
to quelltexterin/nemo-uikit-workshop
that referenced
this pull request
Apr 12, 2023
…actor Feature/uikit refactor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #811
Summary of changes:
UIKits are a new term in the Pattern Lab Ecosystem, attempting to evolve beyond the current
Styleguidekit
pattern which separated front-end templates from front-end assets like stylesheets and code. The existingstyleguidekit-assets-default
andstyleguidekit-mustache-default
have merged intouikit-workshop
(more on that name in a bit). The hope is that by co-locating all front-end files in a single repository, users will be more capable of altering existing UIKits, making their own, even building multiple UIs from a single source of truth.You heard that right - Pattern Lab 3.X will support multiple UI outputs from a single set of source patterns - implementing what @bradfrost coined the workshop and the storefront. True to form, the default Pattern Lab experience is therefore the workshop.
patternlab-config.json
has a new key:uikits
accepts and array of UIKit objects, shipping with the one above.name
: the name of the UIKitoutputDir
where to output this UIKit relative to the current root. by leaving this empty we retain the existing behavior, outputting to<project_rooter>/public
. If you had multiple UIKits, however, you would provided different values, such as:check the output:
enabled
: quickly turn on or off the building of this UIKitexcludedPatternStates
: tell Pattern Lab not to include patterns with these states in this UIKit's outputexcludedPatternTags
: tell Pattern Lab not to include patterns with these tags in this UIKit's outputOther notes that coincide with this work:
paths.source
object paths withinpatternlab-config.json
are now relative to the current UIKit. See the structure of uikit-workshop for more infopaths.public
object paths withinpatternlab-config.json
are now relative to the current UIKit'soutputDir
. Absolute paths will no longer work. Someone could test putting an absolute path in a UIKitoutputDir
property and see what happens I suppose.dependencyGraph.json
has moved to the project root rather thanpublic/
as we should only retain oneTo aide in users building their own UIKits, I've also created uikit-bare outside this monorepo, as a thing to fork and change to your needs. The uikit-bare wiki attempts to document the API Pattern Lab expects from a UIKit and what data it provides a UIKit during build.
Known Issues
Feedback Needed
This is a work in progress, so please provide feedback along the way.