# vim: sw=3 ts=3 ft=org

#+TITLE: Toggle Action Element
#+STYLE: <LINK href='../stylesheet.css' rel='stylesheet' type='text/css' />
#+AUTHOR: Rusty Klophaus (@rustyio)
#+OPTIONS:   H:2 num:1 toc:1 \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+EMAIL: 
#+TEXT: [[file:../index.org][Getting Started]] | [[file:../api.org][API]] | [[file:../elements.org][Elements]] | [[file:../actions.org][*Actions*]] | [[file:../validators.org][Validators]] | [[file:../handlers.org][Handlers]] | [[file:../config.org][Configuration Options]] | [[file:../about.org][About]]

* Toggle Action - #toggle {}

  Call JQuery UI's [[http://docs.jquery.com/UI/Effects/toggle][toggle(effect, options, speed)]] on the target element.


** Usage

#+BEGIN_SRC erlang
   wf:wire(myDiv, #toggle { effect=slide, speed=1000 })
#+END_SRC

** Attributes

   + effect - (/atom/) :: Name of an effect. See <a href='http://docs.jquery.com/UI/Effects'>JQuery reference</a>.

   + options - (/key/value pair/) :: Key/value pair of options for the specified effect.

   + speed - (/integer/) :: Speed of the effect, in milliseconds.

** See Also

   + [[./base.html][base element]]

   + [[./animate.html][animate element]]

   + [[./effect.html][effect element]]

 
