Add prefixes to all component class names to prevent collisions #90
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
7d6bfe7 to
fa0841f
Compare
cd20731 to
06fdd3e
Compare
Codecov Report
@@ Coverage Diff @@
## main #90 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 8 8
Lines 123 123
Branches 39 39
=========================================
Hits 123 123
Continue to review full report at Codecov.
|
fa0841f to
6a35284
Compare
Currently, the SASS entrypoint for this package generates all styles for all shared components. While we may wish to adapt that piece of the puzzle at some point to give more granular control, some protection is needed in the short term at the very least to protect against CSS conflicts for generically-named components like `Panel`, `Modal`, `Dialog`, etc., for applications that use this package but might not yet actually use those individual components (i.e. have implementations of their own at present). Utility and pattern classes (which are not currently part of the public API but will and may be, respectively) are already prefixed with `.hyp-`. Adhering to the same general naming principle, these changes add a `.Hyp-` prefix to all component classes, resulting in, e.g. `.Hyp-Panel`. Use of these classes is currently an internal concern only, so these changes should have no effect for consuming applications. Customization of common component styling, such as it has been done thus far, uses mixins and doesn't directly reference class names. This change should also make it easier to spot whether a component is common or local to the application.
06fdd3e to
aac81bf
Compare
robertknight
approved these changes
Jun 8, 2021
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.
Problem:
Panel,Dialog,Modal.This PR takes an approach of prefixing all component class names (utility and other classes are already prefixed). Details are in the commit message.
We may choose another tactic for component class-naming, I don't care much, but we need to address this in some way before we cut another release of this package.
Note that this PR is currently dependent on #88 — this is more of a convenience to save time going back and re-doing classnames for the modal components—but I can eliminate that dependency if it becomes troublesome.
[1] Changing this is certainly a viable plan, in the longer term