diff --git a/src/_includes/accessibility/background.html b/src/_includes/accessibility/background.html new file mode 100644 index 000000000..adaf08c96 --- /dev/null +++ b/src/_includes/accessibility/background.html @@ -0,0 +1,15 @@ +
+ Modern versions of assistive technology, like screen readers, will read CSS generated content (how Font Awesome icons are rendered), as well as specific Unicode characters. When trying our default markup for rendering icons, assisistive technology may have the following problems. +
+ ++ While the scenarios and techniques above help avoid some serious issues and confusion, they are not exhaustive. There are many complex contexts and use cases when it comes to accessibility, such as users with low quality vision using high contrast mode to better see UI. There are some great tools and resources to learning and work on these out there. Here are a few reads we recommend. +
+ ++ We'll continue to work on these under the larger topic of accessibility, but in the meantime, let us know if any bugs or issues. +
++ When using icons in your UI, there are ways to help assistive technology either ignore or better understand Font Awesome. +
+ +
+ If you're using an icon to add some extra decoration or branding, it does not need to be announced to users as they are navigating your site or app aurally. Additionally, if you're using an icon to visually re-emphasize or add styling to content already present in your HTML, it does not need to be repeated to an assistive technology-using user. You can make sure this is not read by adding the aria-hidden="true"
to your Font Awesome markup.
+
+ If you're using an icon to convey meaning (rather than only as a decorative element), ensure that this meaning is also conveyed to assistive technologies. This goes for content you're abbreviating via icons as well as interactive controls (buttons, form elements, toggles, etc.). There are a few techniques to accomplish this: +
+ +
+ If not representing an interactive element, like a button or link, use both a title
attribute and an on the icon to provide a text alternative. This has the advantages of working with all modern screen readers, working well with the most ubiquitous speech recognition program, and helping users with cognitive disabilities by providing a mouse tooltip.
+
+ In addition to the recommendations above, use a title
attribute which makes the accessible text discoverable by mouse and those with cognitive disabilities.
+
+ + + Settings + + + + + Delete + + + + + Skip to main navigation + +
+ ++ + Refreshing... + + + Saving. Hang tight! +
+ ++
+ + + View 3 items in your shopping cart + +
+ ++ + Battery level: 50% +
++ With our thoughts on icon accessibility in mind, If an icon only adds some extra decoration or branding, it does not need to be announced to users as they are navigating your site or app aurally. Alternatively, if an icon conveys meaning in your content or interface, ensure that this meaning is also conveyed to assistive technologies through alternative displays or text. +
+ +{% highlight html %} + + + Settings + + + + + Delete + + + + + Skip to main navigation + +{% endhighlight %} + +{% highlight html %} + +Refreshing... + + +Saving. Hang tight! +{% endhighlight %} + +{% highlight html %} ++ Loading example (with fa-spinner icon) + + Loading (with fa-circle-o-notch icon) + + Loading example (with fa-refresh icon) + + Loading example (with fa-cog icon) + + Loading example (with fa-spinner icon)
fa-spinner
, fa-refresh
, and fa-cog
.
{% highlight html %}
-
-
-
-
-
+
+Loading...
+
+
+Loading...
+
+
+Loading...
+
+
+Loading...
+
+
+Loading...
{% endhighlight %}
- - Some browsers on some platforms have issues with animated icons resulting in a jittery wobbling effect. See - issue #671 + Note: + Some browsers on some platforms have issues with animated icons resulting in a jittery wobbling effect. See + issue #671 for examples and possible workarounds.
- CSS3 animations aren't supported in IE8 - IE9. + Note: CSS3 animations aren't supported in IE8 - IE9.
- fa-camera-retro + + Example: basic icon + fa-camera-retro
<span>
is more semantically correct).
{% highlight html %}
- fa-camera-retro
+ fa-camera-retro
{% endhighlight %}
- Delete + Delete - Settings + Settings
- Font Awesome
Version {{ site.fontawesome.version }}
+ Font Awesome
Version {{ site.fontawesome.version }}
fa-spin
class. Check out the
spinning icons example.
Solid icons as the base variant
Outlined version of previous modifier
Circle under previous modifier
Square under previous modifier
Directional modifier always at the end
Alternative to the original
Horizontal & vertical modifiers
Consistent when strung together
Gittip is a great way to let developers know you appreciate their work.
diff --git a/src/_includes/tests/rotated-flipped-inside-anchor.html b/src/_includes/tests/rotated-flipped-inside-anchor.html index 111f1a37a..2c48c0ef4 100644 --- a/src/_includes/tests/rotated-flipped-inside-anchor.html +++ b/src/_includes/tests/rotated-flipped-inside-anchor.html @@ -1,6 +1,6 @@ - normal- + Twitter Icon - + Facebook Icon - + @@ -23,21 +23,21 @@
- + Twitter Icon - + Facebook Icon - + @@ -46,24 +46,24 @@
- + Twitter Icon - + Facebook Icon - + GitHub Icon -
\ No newline at end of file + diff --git a/src/_includes/tests/stacked-with-text.html b/src/_includes/tests/stacked-with-text.html index 6dd9ea81b..28a7500c8 100644 --- a/src/_includes/tests/stacked-with-text.html +++ b/src/_includes/tests/stacked-with-text.html @@ -1,4 +1,4 @@ - + - +- + + + GitHub Icon Facebook Icon - Twitter Icon -
- + + + GitHub Icon Facebook Icon - Twitter Icon -
- + + + diff --git a/src/_includes/thanks-to.html b/src/_includes/thanks-to.html index aebcb3d47..e48a65f06 100644 --- a/src/_includes/thanks-to.html +++ b/src/_includes/thanks-to.html @@ -17,7 +17,7 @@ Facebook Icon - Twitter Icon -
diff --git a/src/_includes/tests/stacked.html b/src/_includes/tests/stacked.html index 83ff20599..4d0040759 100644 --- a/src/_includes/tests/stacked.html +++ b/src/_includes/tests/stacked.html @@ -1,56 +1,56 @@- Thanks to MaxCDN for providing the excellent + Thanks to MaxCDN for providing the excellent BootstrapCDN, the fastest and easiest way to get started with Font Awesome.
diff --git a/src/_includes/why.html b/src/_includes/why.html index 499829384..1574d2c6c 100644 --- a/src/_includes/why.html +++ b/src/_includes/why.html @@ -1,41 +1,42 @@