Tim Roes 99f1c65c4b Initial version of accessibility guide (#13390 )

* Initial version of a11y guide

* Move a11y content from HTML guide to a11y guide

* Add PR feedback

* Add PRs feedback

* Add more roles

* Refactor labeling elements section

* Rename "labeling elements" -> "naming elements"

* Use span instead of i for icon examples

* Correct typo

2017-08-14 07:42:06 +02:00

2.3 KiB

Raw Blame History

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.

<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:

<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, 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. 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.

<div
  attribute1="value1"
  attribute2="value2"
  attribute3="value3"
>
  Hello
</div>

If the element doesn't have children, add the closing tag on the same line as the opening tag's closing bracket.

<div
  attribute1="value1"
  attribute2="value2"
  attribute3="value3"
></div>

Nested elements belong on multiple lines

Putting nested elements on multiple lines makes it easy to scan and identify tags, attributes, and text nodes, and to distinguish elements from one another. This is especially useful if there are multiple similar elements which appear sequentially in the markup.

Do

<div>
  <span>
    hi
  </span>
</div>

Don't

<div><span>hi</span></div>

2.3 KiB Raw Blame History