chore(docs): core docs about style components (draft) #27
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
bashmish
reviewed
May 7, 2019
|
|
||
| ## Style components | ||
| A style component consists of a set of css classes mapping to a certain html structure. | ||
| Read [more about style components](./styleComponents.md) here. |
There was a problem hiding this comment.
Weird. Should be here: https://github.com/ing-bank/lion/blob/docs/shadowBem/packages/core/docs/styleComponents.md
bashmish
reviewed
May 7, 2019
| - **Performance** we aim for applications having a limited number of shadow roots and we consider | ||
| shadow root creation a performance concern. Style components reduce the need for shadow roots. | ||
| <!-- TODO: we definitely suffered here in the Polymer era. We might want to create some new perf | ||
| tests for our lit-element based apps to verify this claim again. --> |
There was a problem hiding this comment.
maybe make this TODO visible in the Markdown for everyone, not only in the source code?
There was a problem hiding this comment.
Good idea. Will pick up later
thepassle
reviewed
May 7, 2019
daKmoR
force-pushed
the
docs/shadowBem
branch
2 times, most recently
from
a39c637
to
4ea5d94
Compare
daKmoR
force-pushed
the
docs/shadowBem
branch
from
4ea5d94
to
61e2f0b
Compare
gerjanvangeest
approved these changes
Sep 17, 2019
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.
Draft for documenting shadow BEM modifiers: they should be
.my-block[modifier]instead of.my-block--modifier. See don't self-apply classes.Please note that the scope of this pull request is way broader than only modifiers: the documentation also contains the context (why we use BEM and how to apply it in shadow dom).
Please have a quick look at this draft.
If we agree on the approach (about modifiers), we should also make issues to align all of our CSS with it.
Also, it might lead to some discussions about how we want to map style modules to webcomponents having shadow dom.
I will reread this myself and try to wrap up in a few days