maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update HTML style guide with rule for camel casing attribute values. (#11653)

Browse source 
* Update HTML style guide with rule for camel casing attribute values.
* Add notes about using the same capitalization in HTML and CSS.
This commit is contained in:
CJ Cenizal 2017-06-08 13:01:31 -07:00 committed by GitHub
parent dc680297fd
commit ed8951a816
1 changed files with 35 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
style_guides/html_style_guide.md
View file

@ -1,6 +1,38 @@
# HTML Style Guide
## Camel case ID and other attribute values
Use camel case for the values of attributes such as IDs and data test subject selectors.
```html
<button
id="veryImportantButton"
data-test-subj="clickMeButton"
>
Click me
</button>
```
The only exception is in cases where you're dynamically creating the value, and you need to use
hyphens as delimiters:
```html
<button
ng-repeat="button in buttons"
id="{{ 'veryImportantButton-' + button.id }}"
data-test-subj="{{ 'clickMeButton-' + button.id }}"
>
{{ button.label }}
</button>
```
## Capitalization in HTML and CSS should always match
It's important that when you write CSS selectors using classes, IDs, and attributes
(keeping in mind that we should _never_ use IDs and attributes in our selectors), that the
capitalization in the CSS matches that used in the HTML. [HTML and CSS follow different case sensitivity rules](http://reference.sitepoint.com/css/casesensitivity), and we can avoid subtle gotchas by ensuring we use the
same capitalization in both of them.
## Multiple attribute values
When an element has multiple attributes, each attribute including the first should be on its own line with a single indent.
@ -9,7 +41,7 @@ This makes the attributes easier to scan and compare across similar elements.
The closing bracket should be on its own line. This allows attributes to be shuffled and edited without having to move the bracket around. It also makes it easier to scan vertically and match opening and closing brackets. This format
is inspired by the positioning of the opening and closing parentheses in [Pug/Jade](https://pugjs.org/language/attributes.html#multiline-attributes).
```
```html
<div
attribute1="value1"
attribute2="value2"
@ -21,7 +53,7 @@ is inspired by the positioning of the opening and closing parentheses in [Pug/Ja
If the element doesn't have children, add the closing tag on the same line as the opening tag's closing bracket.
```
```html
<div
attribute1="value1"
attribute2="value2"