-
Notifications
You must be signed in to change notification settings - Fork 3
[ CodeStyle ] Add class conventions #22
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
Open
jamesnw
wants to merge
2
commits into
openui:main
Choose a base branch
from
jamesnw:docs-class-naming
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68,7 +68,32 @@ the primary implementations. | |
|
|
||
| ### CSS conventions | ||
|
|
||
| *TODO: Add class naming rules* | ||
| #### BEM syntax | ||
|
|
||
| OUI follows a [BEM](http://getbem.com/introduction/)-like syntax, extending it | ||
| further to follow more of | ||
| [BEMIT](http://csswizardry.com/2015/08/bemit-taking-the-bem-naming-convention-a-step-further/)-like | ||
| conventions. | ||
|
|
||
| BEM stands for "Block Element Modifier". Here's a breakdown of what that means: | ||
|
|
||
| - **Block** is the primary component block (e.g. .oui-c-button) | ||
| - **Element** is a child of the primary block (e.g. .oui-c-button__text) | ||
| - **Modifier** is a variation of a component style (e.g. .oui-c-button--secondary) | ||
|
|
||
| OUI extends BEM's conventions to create even more explicit, encapsulated class | ||
| names. | ||
|
|
||
| ### Class prefixes | ||
|
|
||
| In addition to the [global `oui-` namespace](#namespace), OUI uses class prefixes to provide | ||
| additional clarity to the job a given class plays. OUI uses the following class | ||
|
||
| prefix conventions: | ||
|
|
||
| - **c** - for UI components, such as `.oui-c-button` | ||
| - **l** - for layout-specific component styles, such as `.oui-l-container` | ||
| - **u** - for utilities, such as `.oui-u-margin-bottom-none` | ||
| - **is** - and has- for specific states, such as `.oui-is-active` | ||
|
|
||
| *TODO: Add property usage rules, for instance preference for logical properties* | ||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.