// $Id: API.txt,v 1.1.2.1 2010/08/17 21:38:03 mfer Exp $

The automodal module allows other modules to add easily add modalFrame
configurations for their modules. This includes a function to add the settings
and a hook that allows the settings added by other calls to be altered. This is
a fairly straight forward process.

To add modalFrame to a url use automodal_add(). For example:

automodal_add('.my_selector', array('width' => 200));

This will cause anything in the page with that selector to open a modalFrame
with a width of 200px. The content will be that of the href attribute on the link.

For complete details on the available settings as the second argument see
the automodal_add() functions documentation in automodal.module.

Additionally, there is a hook_automodal_alter() function that is called each time
automodal_add() adds a selector to the page. A simple example of using it looks
like:

function example_automodal_alter(&$settings, $selector) {
  if ($selector == '.automodal') {
    $settings['width'] = 900;
  }
}