ltanme/accdc-dojo

Quick reference guide for the Dojo AccDC API.

AccDC API - 3.1 for Dojo (03/16/2014)

AccDC is a scalable, cross-browser and cross-platform compatible Dynamic Content Management System that automates the rendering of dynamic content to ensure accessibility for screen reader and keyboard only users.

Supported by the Royal Society of Arts, AccDC was awarded the "Above and Beyond Accessibility Award" from the United States Department of Labor, and was presented at the Developing with Accessibility Event, hosted by the Federal Communications Commission in Washington DC in 2012.

This version of AccDC interfaces with Dojo as an AMD module. All of the AccDC accessible component modules plug into this interface.

How it works

AccDC generates independent JavaScript objects, called AccDC Objects, that include customizable properties and methods which are used to control the functionality, content, and behavior of each AccDC Object at runtime.

This makes it possible to render any type of user interface component, including wizards, carousels, dialogs, toolbars, tooltips, popups, lightboxes, menus, banners, tab controls, drag and drop controls, toggles, sliders, calendar pickers, or any other type of fully functional accessible user interface component.

AccDC includes integrated ARIA support to enhance intuitive page structuring for screen reader users, as well as a recursive Announce method that can be used to send textual messages to be dynamically announced for screen reader users. Additional ARIA attributes may be dynamically added to enhance advanced controls using AccDC's in-built Flow Control methods.

AccDC renders HTML/XHTML valid markup, HTML5, DOM nodes, JavaScript output, XML node content, JSON object data, and content from remote API callbacks.

AccDC automates accessibility by managing the processes associated with dynamic content rendering, so that the majority of common accessibility issues are automatically addressed when DOM manipulation occurs.

For specific coding guidance, visit: http://whatsock.com/tsg

Distributed under the terms of the Open Source Initiative OSI - MIT License.

Developed and maintained by: Bryan Garaventa

Project home:

http://whatsock.com/dojo/

Related projects:

The Accessibility Tree - A Training Guide for Advanced Web Development: https://github.com/accdc/training

The ARIA Role Conformance Matrices: https://github.com/accdc/aria-matrices

AccDC API Standalone: https://github.com/accdc/accdc For jQuery: https://github.com/accdc/accdc-jquery For Dojo: https://github.com/accdc/accdc-dojo For MooTools: https://github.com/accdc/accdc-mootools

AccDC Bootstrap Standalone: https://github.com/accdc/bootstrap For jQuery: https://github.com/accdc/bootstrap-jquery For Dojo: https://github.com/accdc/bootstrap-dojo For MooTools: https://github.com/accdc/bootstrap-mootools

AccDC Technical Style Guide and Coding Arena For AccDC Standalone and jQuery: https://github.com/accdc/tsg For Dojo: https://github.com/accdc/tsg-dojo For MooTools: https://github.com/accdc/tsg-mootools

Understanding AccDC: A Quick Start Guide

It helps to understand precisely what AccDC is and how it works at the most basic level.

The AccDC API is designed to process and normalize code across the three most widely used JavaScript libraries and frameworks, jQuery, Dojo, and MooTools.

To be specific, the AccDC API is an extension for jQuery, Dojo, and MooTools.

The AccDC API module interfaces with each of these libraries and frameworks in order to utilize all of the available rendering, AJAX, event handling, and associated processes, and extends them, so that any relevant command that is processed using the $A namespace, is automatically powered by the core processes within jQuery, Dojo, or MooTools.

An example showing the value of this, is described in the LinkedIn article at http://lnkd.in/b9VGQxf

This means that, any widget that uses the following AccDC API methods, will automatically normalize equally across jQuery, Dojo, and MooTools, without requiring any coding changes to work correctly.

• $A.getEl // Get the element with the specified ID

• $A.createEl // Create a new element node, plus optional attributes, styling, and content

• $A.getAttr // Get the value of a specified attribute

• $A.setAttr // Set the value of one or more attributes

• $A.remAttr // Remove one or more attributes

• $A.getText // Get the textual content of a container element (Coding documentation: WhatSock.com > Core API > Misc)

• $A.css // Get or Set the styling properties of one or more elements

• $A.hasClass // Check if an element includes one or more class names

• $A.addClass // Add one or more class names to an element

• $A.remClass // Remove one or more class names from an element (Coding documentation: WhatSock.com > Core API > CSS)

• $A.bind // Add event handlers for one or more elements

• $A.unbind // Remove event handlers for one or more elements

• $A.trigger // Fire the specified event on an element (Coding documentation: WhatSock.com > Core API > Events)

• $A.load // Pull markup code from an external resource and load into a container element

• $A.get // Pull code from an external resource and process it

• $A.getJSON // Pull JSON code from an external resource and process it

• $A.getScript // Execute an external JavaScript file

• $A.post // Submit data to a server side script using a POST request

• $A.ajax // Manually configure custom AJAX GET or POST requests (Coding documentation: WhatSock.com > Core API > AJAX)

• $A.announce // Announce a string or the content of a container element to screen reader users (Coding documentation: WhatSock.com > Core API > Accessibility)

There are many more AccDC API commands and customizable rendering functionalities documented on the Core API tab at WhatSock.com, but these cover all of the most commonly used public methods.

In order to test and verify this functionality, there are three dedicated TSG GitHub projects, all of which use the same component code for each widget type shared between them, which tie into the AccDC API for automatic normalization.

• Powered by jQuery: https://github.com/accdc/tsg
• Powered by Dojo: https://github.com/accdc/tsg-dojo
• Powered by MooTools: https://github.com/accdc/tsg-mootools

In order to ensure the highest level of accessibility possible for all user types, including non-sighted screen reader users, mobility impaired keyboard only users, voice navigation software users, and low vision screen magnification software users, all of the scalable widgets provided within the TSG archives are programmed specifically to be as accessible as possible using all current standards, with specific adherence to the principles and guidelines documented at:

http://whatsock.com/training

Also available for download at: https://github.com/accdc/training

For community support, please address any questions to the Accessibility Innovators LinkedIn group, at: https://www.linkedin.com/groups/Accessibility-Innovators-4512178

Future updates and announcements will be posted on Twitter, at https://twitter.com/bryanegaraventa