mirror of
https://github.com/FortAwesome/Font-Awesome.git
synced 2024-12-27 14:01:30 +08:00
revamping accessibility page content and layout with CDN info
This commit is contained in:
Brian Talbot
parent
fd7ae9cae0
commit
94c59bbc1b
21
src/_includes/accessibility/accessibility-facdn.html
Normal file
21
src/_includes/accessibility/accessibility-facdn.html
Normal file
@ -0,0 +1,21 @@
|
||||
<section id="accessibility-cdn" class="accessibility-cdn">
|
||||
<div class="row">
|
||||
<div class="col-md-8">
|
||||
<h3>
|
||||
<i class="gg-col fa fa-magic text-muted fa-lg padding-right" aria-hidden="true"></i>
|
||||
Use Font Awesome CDN's auto accessibility
|
||||
</h3>
|
||||
|
||||
<p><a href="{{ page.relative_path }}get-started/#get-started-cdn">Font Awesome CDN</a> helps you automate accessibility support more easily so your icons work for the most people possible. You only need turn on a setting, <a href="https://cdn.fontawesome.com/help#qa-autoa11y">use our simple syntax</a>, and any icons you use will have all of the best practices and manual techniques below <strong>applied automatically</strong>.</p>
|
||||
</div>
|
||||
|
||||
<div class="col-md-4">
|
||||
<a href="{{ page.relative_path }}get-started/#get-started-cdn" class="btn btn-success btn-block btn-lg margin-top-lg margin-bottom">Automate Your Icons' Accessibility</a>
|
||||
|
||||
<p class="text-sm text-center margin-bottom-none">
|
||||
<a href="https://cdn.fontawesome.com/help#qa-autoa11y">Read more about our auto accessibility</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
@ -1,13 +1,14 @@
|
||||
<div id="using-with-accessibility">
|
||||
<h2 class="page-header">Using Font Awesome with Acessibility in mind</h2>
|
||||
<p>
|
||||
When using icons in your UI, there are ways to help assistive technology either ignore or better understand Font Awesome.
|
||||
</p>
|
||||
<section id="accessibility-manual" class="accessibility-manual">
|
||||
|
||||
<h3>Icons used for pure decoration or visual styling</h3>
|
||||
<p>
|
||||
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 <code>aria-hidden="true"</code> to your Font Awesome markup.
|
||||
</p>
|
||||
<h3>
|
||||
<i class="gg-col fa fa-wrench text-muted fa-lg padding-right" aria-hidden="true"></i>
|
||||
Manually make your icons accessible
|
||||
</h3>
|
||||
|
||||
<p>When using icons in your UI, there are manual techniques and ways to help assistive technology either ignore or better understand Font Awesome.</p>
|
||||
|
||||
<h4 class="margin-top-xl">Icons used for pure decoration or visual styling</h4>
|
||||
<p>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 <code>aria-hidden="true"</code> to your Font Awesome markup.</p>
|
||||
|
||||
<div class="margin-top-lg margin-bottom-lg">
|
||||
{% highlight html %}
|
||||
@ -33,12 +34,12 @@
|
||||
<small class="text-muted">an icon being used in front of link text</small>
|
||||
</div>
|
||||
|
||||
<h3>Icons with semantic or interactive purpose</h3>
|
||||
<h4 class="margin-top-xl">Icons with semantic or interactive purpose</h4>
|
||||
<p>
|
||||
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:
|
||||
</p>
|
||||
|
||||
<h4>If an icon is <strong>not</strong> an interactive element</h4>
|
||||
<h4 class="margin-top-xl text-muted">If an icon is <strong>not</strong> an interactive element</h4>
|
||||
<p>
|
||||
The simplest way to provide a text alternative is to use the <code>aria-hidden="true"</code> attribute on the icon and to include the text with an additional element, such as a <code><span></code>, with appropriate CSS to visually hide the element while keeping it accessible to assistive technologies. In addition, you can add a <code>title</code> attribute on the icon to provide a tooltip for sighted mouse users.
|
||||
</p>
|
||||
@ -76,7 +77,7 @@
|
||||
<small class="text-muted">an icon being used to denote time remaining</small>
|
||||
</div>
|
||||
|
||||
<h4>If an icon represents an interactive element</h4>
|
||||
<h4 class="margin-top-xl text-muted">If an icon represents an interactive element</h4>
|
||||
<p>
|
||||
In the case of focusable interactive elements, there are various options to include an alternative text or label to the element, without the need for any visually hidden <code><span></code> or similar. For instance, simply adding the <code>title</code> attribute to the interactive element itself will be sufficient to provide an accessible alternative name for the element, as well as providing the mouse tooltip.
|
||||
</p>
|
||||
@ -106,13 +107,14 @@
|
||||
<small class="text-muted">an icon being used as a delete button's symbol</small>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="alert alert-success">
|
||||
<ul class="fa-ul margin-bottom-none">
|
||||
<li>
|
||||
<i class="fa-li fa fa-info-circle fa-lg" aria-hidden"true"></i>
|
||||
<a href="{{ page.relative_path }}examples/#accessible">See more examples of how to add accessibility-minded icons</a> into your UI.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="alert alert-success">
|
||||
<ul class="fa-ul margin-bottom-none">
|
||||
<li>
|
||||
<i class="fa-li fa fa-info-circle fa-lg" aria-hidden"true"></i>
|
||||
<a href="{{ page.relative_path }}examples/#accessible">See more examples of how to add accessibility-minded icons</a> into your UI.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@ -1,7 +1,7 @@
|
||||
<div id="background">
|
||||
<h2 class="page-header">Icon Fonts & Accessibility</h2>
|
||||
<div id="accessibility-background">
|
||||
<h4 class="margin-top-none">About Icon Fonts & Accessibility</h4>
|
||||
<p>
|
||||
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.
|
||||
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 reading our default markup for rendering icons, assisistive technology may have the following problems.
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
|
||||
11
src/_includes/accessibility/cta-cdn-ally.html
Normal file
11
src/_includes/accessibility/cta-cdn-ally.html
Normal file
@ -0,0 +1,11 @@
|
||||
<div class="well text-center">
|
||||
<div class="text-center margin-bottom">
|
||||
<i class="gg-col fa fa-magic fa-3x text-muted padding-right" aria-hidden="true"></i>
|
||||
<i class="gg-col fa fa-plus fa-2x text-muted padding-right" aria-hidden="true"></i>
|
||||
<i class="gg-col fa fa-universal-access fa-3x text-muted" aria-hidden="true"></i>
|
||||
</div>
|
||||
<h3>Automate your icons' accessibility</h3>
|
||||
<p><a href="{{ page.relative_path }}get-started/#get-started-cdn">Font Awesome CDN</a> helps you automate accessibility support more easily so your icons work for the most people possible. You only need turn on a setting and any icons you use will have all of the best practices we recommend applied automatically.</p>
|
||||
|
||||
<a href="{{ page.relative_path }}get-started/#get-started-cdn" class="btn btn-success btn-lg">Get Automated Accessibility</a>
|
||||
</div>
|
||||
@ -1,7 +1,7 @@
|
||||
<div id="other">
|
||||
<section id="accessibility-other" class="accessibility-other">
|
||||
<h2 class="page-header">Other cases and information</h2>
|
||||
<p>
|
||||
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 vision who need a high color contrast ratio to see UI. There are some great tools and resources to learn from and work on these issues out there. Here are a few reads we recommend.
|
||||
While the scenarios and techniques here 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 vision who need a high color contrast ratio to see UI. There are some great tools and resources to learn from and work on these issues out there. Here are a few reads we recommend.
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
@ -14,4 +14,4 @@
|
||||
<p>
|
||||
We'll continue to work on these under the larger topic of accessibility, but in the meantime, <a href="{{ page.relative_path }}community/#reporting-bugs">let us know if any bugs or issues</a>.
|
||||
</p>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@ -2,27 +2,38 @@
|
||||
layout: base
|
||||
title: Font Awesome & Accessibility
|
||||
navbar_active: accessibility
|
||||
view_class: v-accessibility
|
||||
relative_path: ../
|
||||
---
|
||||
{% capture jumbotron_h1 %}<i class="fa fa-universal-access" aria-hidden="true"></i> Accessibility{% endcapture %}
|
||||
{% capture jumbotron_p %}Make your icons awesome for all of your users{% endcapture %}
|
||||
|
||||
{% include jumbotron.html %}
|
||||
{% include stripe-social.html %}
|
||||
|
||||
<div class="container">
|
||||
{% capture stripe_ad_content %}
|
||||
<p class="lead">
|
||||
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.
|
||||
</p>
|
||||
<section id="accessibility-intro" class="accessibility-intro">
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<p class="lead">
|
||||
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.
|
||||
</p>
|
||||
</div>
|
||||
<div class="col-md-6">
|
||||
{% include accessibility/background.html %}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<p class="lead">
|
||||
When creating web sites and apps, that means making sure our icons play well with assistive tech when users are navigating apps and sites.
|
||||
</p>
|
||||
{% endcapture %}
|
||||
{% include stripe-ad.html %}
|
||||
<h2 class="page-header">
|
||||
Using Font Awesome with Acessibility in mind
|
||||
</h2>
|
||||
|
||||
{% include accessibility/background.html %}
|
||||
{% include accessibility/using-with-accessibility.html %}
|
||||
{% include accessibility/accessibility-facdn.html %}
|
||||
|
||||
<div class="hr margin-top-xl">
|
||||
<span class="hr-text text-xl text-muted">or</span>
|
||||
</div>
|
||||
|
||||
{% include accessibility/accessibility-manual.html %}
|
||||
{% include accessibility/other.html %}
|
||||
</div>
|
||||
|
||||
@ -1,6 +1,14 @@
|
||||
// view-specific
|
||||
.v-get-started, .v-store {
|
||||
|
||||
// reset background
|
||||
.v-get-started,
|
||||
.v-store,
|
||||
.v-accessibility {
|
||||
background: @alert-well-bg; // resetting for depth
|
||||
}
|
||||
|
||||
// get started
|
||||
.v-get-started {
|
||||
|
||||
.get-started-cdn {
|
||||
background: @section-emphasized-bg;
|
||||
@ -24,3 +32,19 @@
|
||||
font-size: (@font-size-large*1.5);
|
||||
}
|
||||
}
|
||||
|
||||
// accessibility
|
||||
.v-accessibility {
|
||||
|
||||
.accessibility-cdn {
|
||||
background: @section-emphasized-bg;
|
||||
border-radius: @border-radius-base;
|
||||
padding: @buffer-lg;
|
||||
}
|
||||
|
||||
.hr .hr-text {
|
||||
background: @alert-well-bg;
|
||||
font-family: @font-family-serif;
|
||||
font-size: (@font-size-large*1.5);
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user