Last active
February 9, 2022 09:47
-
-
Save wrumsby/8908260 to your computer and use it in GitHub Desktop.
CSS naming convention.
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
| /* Base styles */ | |
| body {} | |
| p {} | |
| /* .layout-{name} */ | |
| .layout-sidebar {} | |
| /* .{moduleName} */ | |
| .modal {} | |
| /* .{moduleName}--{subComponent} */ | |
| .modal--header {} | |
| /* .{moduleName} */ | |
| .button {} | |
| /* .{moduleName}-is-{stateName} */ | |
| .button-is-disabled {} | |
| /* .{moduleName}-{subModule} */ | |
| .button-default {} | |
| /* .{moduleName}-{subModule} */ | |
| .button-primary {} |
A subcomponent would be something like:
<div class="modal">
<!-- .modal--header is a subcomponent -->
<div class="modal--header">Modal</div>
<div class="modal--body">
...
</div>
<div class="modal--footer">
<!-- .btn-primary is a submodule -->
<a href="#" class="btn btn-primary">Save</a>
<a href="#" class="btn btn-cancel">Cancel</a>
</div>
</div>
More Transparent UI Code with Namespaces has some interesting ideas on adding namespace prefixes too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In this variation, a submodule is a variation on a module. So
.buttonwould be a module with.button-primarybeing the submodule. I prefer the term "modifier". "Submodule" is a curious term to use as it implies a descendent relationship.