From b35a05cce64754146015e69848ee941b72af9000 Mon Sep 17 00:00:00 2001 From: Brian Talbot Date: Fri, 1 Apr 2016 09:45:15 -0400 Subject: [PATCH] adding accessibility informational page * adding to main Font Awesome navigation * adding background, use cases + how-to's, and more information sections --- src/_includes/accessibility/background.html | 15 ++++ src/_includes/accessibility/other.html | 16 ++++ .../using-with-accessibility.html | 78 +++++++++++++++++++ src/_includes/navbar.html | 1 + src/accessibility.html | 28 +++++++ 5 files changed, 138 insertions(+) create mode 100644 src/_includes/accessibility/background.html create mode 100644 src/_includes/accessibility/other.html create mode 100644 src/_includes/accessibility/using-with-accessibility.html create mode 100644 src/accessibility.html diff --git a/src/_includes/accessibility/background.html b/src/_includes/accessibility/background.html new file mode 100644 index 000000000..bdf7be836 --- /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. +

+ + +
diff --git a/src/_includes/accessibility/other.html b/src/_includes/accessibility/other.html new file mode 100644 index 000000000..e6261d8f5 --- /dev/null +++ b/src/_includes/accessibility/other.html @@ -0,0 +1,16 @@ +
+ +

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

+
diff --git a/src/_includes/accessibility/using-with-accessibility.html b/src/_includes/accessibility/using-with-accessibility.html new file mode 100644 index 000000000..47d6453b1 --- /dev/null +++ b/src/_includes/accessibility/using-with-accessibility.html @@ -0,0 +1,78 @@ +
+ +

+ When using icons in your UI, there are ways to help assistive technology either ignore or better understand Font Awesome. +

+ +

Icons used for pure decoration or visual styling

+

+ 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" attribute to your Font Awesome markup. +

+ +
+{% highlight html %} + +{% endhighlight %} +an icon being used as pure decoration +
+ +
+{% highlight html %} +

+ + Pied Piper, A Middle-Out Compression Solution Making Data Storage Problems Smaller +

+{% endhighlight %} +an icon being used as a logo +
+ +
+{% highlight html %} + View this project's code on Github +{% endhighlight %} +an icon being used in front of link text +
+ +

Icons that with semantic or interactive purpose

+

+ 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 – for instance, include additional content that's visually hidden to users but semantically avaiable to screen readers. This goes for content you're abbreviating via icons as well as interactive controls (buttons, form elements, toggles, etc.). +

+ +
+ +
+ +
+{% highlight html %} + + +View 3 items in your shopping cart + +{% endhighlight %} +an icon being used to communicate shopping cart state +
+ +
+{% highlight html %} + + +Skip to main navigation + +{% endhighlight %} +an icon being used as a link to a navigation menu +
+
+ +
+ +
diff --git a/src/_includes/navbar.html b/src/_includes/navbar.html index cc8c95690..4e81f3f22 100644 --- a/src/_includes/navbar.html +++ b/src/_includes/navbar.html @@ -96,6 +96,7 @@
  • Custom CSS
  • + Accessibility Community License diff --git a/src/accessibility.html b/src/accessibility.html new file mode 100644 index 000000000..8f3a0f96d --- /dev/null +++ b/src/accessibility.html @@ -0,0 +1,28 @@ +--- +layout: base +title: Font Awesome & Accessibility +navbar_active: accessibility +relative_path: ../ +--- +{% capture jumbotron_h1 %}  Accessibility{% endcapture %} +{% capture jumbotron_p %}How to make your icons awesome for all of your users{% endcapture %} + +{% include jumbotron.html %} +{% include stripe-social.html %} + +
    + {% capture stripe_ad_content %} +

    + Icons are symbols that can convey a ton of information and really help people comprehend directions, signs, and interfaces. Its important that we create and use them so that they can reach the largest amount of people possible. +

    + +

    + When creating web sites and apps, that means making sure our icons play well with assistive tech when users are navigating apps and sites. +

    + {% endcapture %} + {% include stripe-ad.html %} + + {% include accessibility/background.html %} + {% include accessibility/using-with-accessibility.html %} + {% include accessibility/other.html %} +