====== Ajax Aid ======

{{projects:ajaxaid_small.jpg|}}

On Internet Explorer running under Windows, AjaxAid will inform JavaScript whether the user has a screen reader that is actively communicating with the browser. It achieves this by using a hidden (1 pixel x 1 pixel) Flash application.

AjaxAid was previously called FlashAid. (We are currently moving the project over.)

===== Demo =====

See a [[http://aralbalkan.com/flashaid|live demonstration of AjaxAid]] here. 

Remember it only works on Internet Explorer. Have your screen reader running before hitting the demo page.

===== Download =====

**New** 2007/02/27: Version 1.0 Released. You can download it here: 

[[http://svn1.cvsdude.com/osflash/flashaid/release/flashaid_v1.0.zip|FlashAid version 1.0]]


===== Mailing list =====

[[http://osflash.org/mailman/listinfo/flashaid_osflash.org|FlashAid Mailing List]]: Subscribe and manage your subscription
 [[http://osflash.org/pipermail/flashaid_osflash.org/|Archives]]

The mailing list will be switched to the AjaxAid name in the coming days. 

===== Usage instructions =====

**To-do:** Update to AjaxAid.

  - Include the js/flashAid.js script
  - Include the js/swfobject.js script (for embedding the Flash file) 
  - Create a <div> with id="flashAid". If you want alternative content to display if Flash cannot be loaded, place it into this div.
  - Inside your div, call the flashAid() method and pass in the name (string) of a method that will be called for success and one for failure. The method signature of the flashAid() method is:

  flashAid ( successHandler, failureHandler, displayVersionMessage )

Where displayVersionMessageBool is a boolean that determines whether or not a message will be displayed in the flashAid div if the user has the wrong version of the Flash Player. (FlashAid requires Flash Player 8 and above.)

===== Code sample =====

  <script type="text/javascript">
    // <![CDATA[
        flashAid("successHandler", "failureHandler", true);
    // ]]>
  </script>

===== Source Code =====

The source code for AjaxAid is in the OSFlash Subversion repository at [[http://svn1.cvsdude.com/osflash/flashaid]].

===== Credits =====

Based on an idea by Jeremy Keith, as discussed by Andy, Simon and the rest of the gang at a lovely beach bbq in Brighton. Written by Aral Balkan with accessibility research and testing by Niqui Merret.

===== License =====

Copyright (c) 2006-2007 Aral Balkan. Released under the open source [[http://www.opensource.org/licenses/mit-license.php|MIT license]].